Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[automated] Update Forest CLI docs #5252

Merged
merged 2 commits into from
Feb 7, 2025
Merged

[automated] Update Forest CLI docs #5252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2dad97a
Update Forest CLI docs
github-merge-queue[bot] Feb 7, 2025
9c7abc8
fix wording
hanabi1224 Feb 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/docs/users/reference/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -767,8 +767,10 @@ Print healthcheck info
Usage: forest-cli healthcheck <COMMAND>

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
Expand Down
6 changes: 3 additions & 3 deletions src/cli/subcommands/healthcheck_cmd.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)]
Expand All @@ -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)]
Expand All @@ -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)]
Expand Down
Loading