diff --git a/docs/docs/users/reference/cli.md b/docs/docs/users/reference/cli.md index 8a16369c3c00..cab59acd42bc 100644 --- a/docs/docs/users/reference/cli.md +++ b/docs/docs/users/reference/cli.md @@ -767,8 +767,10 @@ Print healthcheck info Usage: forest-cli healthcheck Commands: - ready Display ready status - help Print this message or the help of the given subcommand(s) + ready Display readiness status + live Display liveness status + healthy Display health status + help Print this message or the help of the given subcommand(s) Options: -h, --help Print help diff --git a/src/cli/subcommands/healthcheck_cmd.rs b/src/cli/subcommands/healthcheck_cmd.rs index 0404cf102d3c..4bfaffb02f5a 100644 --- a/src/cli/subcommands/healthcheck_cmd.rs +++ b/src/cli/subcommands/healthcheck_cmd.rs @@ -14,7 +14,7 @@ use ticker::Ticker; #[derive(Debug, Subcommand)] pub enum HealthcheckCommand { - /// Display ready status + /// Display readiness status Ready { /// Don't exit until node is ready #[arg(long)] @@ -23,7 +23,7 @@ pub enum HealthcheckCommand { #[arg(long, default_value_t=DEFAULT_HEALTHCHECK_PORT)] healthcheck_port: u16, }, - /// Display live status + /// Display liveness status Live { /// Don't exit until node is ready #[arg(long)] @@ -32,7 +32,7 @@ pub enum HealthcheckCommand { #[arg(long, default_value_t=DEFAULT_HEALTHCHECK_PORT)] healthcheck_port: u16, }, - /// Display live status + /// Display health status Healthy { /// Don't exit until node is ready #[arg(long)]