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

Shorten the long env help #1791

Merged
merged 3 commits into from
Dec 13, 2024
Merged

Shorten the long env help #1791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
68e17b4
Shorten the long env help
leighmcculloch Dec 13, 2024
d07c825
update help
leighmcculloch Dec 13, 2024
cb41784
more tweaks
leighmcculloch Dec 13, 2024
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
8 changes: 6 additions & 2 deletions FULL_HELP_DOCS.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading