Skip to content

Commit

Permalink
Shorten the long env help (#1791)
Browse files Browse the repository at this point in the history
  • Loading branch information
leighmcculloch authored Dec 13, 2024
1 parent 8aefbf5 commit faf0d01
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
8 changes: 6 additions & 2 deletions FULL_HELP_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Anything after the `--` double dash (the "slop") is parsed as arguments to the c

* `contract` — Tools for smart contract developers
* `events` — Watch the network for contract events
* `env` — Prints the current environment variables or defaults to the stdout, in a format that can be used as .env file. Environment variables have precedency over defaults
* `env` — Prints the environment variables
* `keys` — Create and manage identities including keys and addresses
* `network` — Configure connection to networks
* `container` — Start local networks in containers
Expand Down Expand Up @@ -915,7 +915,11 @@ Watch the network for contract events

## `stellar env`

Prints the current environment variables or defaults to the stdout, in a format that can be used as .env file. Environment variables have precedency over defaults
Prints the environment variables

Prints to stdout in a format that can be used as .env file. Environment variables have precedence over defaults.

If there are no environment variables in use, prints the defaults.

**Usage:** `stellar env [OPTIONS]`

Expand Down
9 changes: 6 additions & 3 deletions cmd/soroban-cli/src/commands/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -143,9 +143,12 @@ pub enum Cmd {
/// Watch the network for contract events
Events(events::Cmd),

/// Prints the current environment variables or defaults to the stdout, in
/// a format that can be used as .env file. Environment variables have
/// precedency over defaults.
/// Prints the environment variables
///
/// Prints to stdout in a format that can be used as .env file. Environment
/// variables have precedence over defaults.
///
/// If there are no environment variables in use, prints the defaults.
Env(env::Cmd),

/// Create and manage identities including keys and addresses
Expand Down

0 comments on commit faf0d01

Please sign in to comment.