Help tweaks

[leighmcculloch]

What

A few small changes to the main help. Reworded the lead in sentence making it a stronger statement that stands alone. Updated the list of core features. Reorganized the subcommands to place primary domain functionality at the top and more utilities and advanced capabilities lower. Removed the TESTING_OPTIONS flag group because the help is for users, not for CLI developers.

Before

$ stellar -h
With the Stellar CLI you can:

- build, deploy and interact with contracts
- set identities to sign with
- configure networks
- generate keys
- more!

For additional information see:

- Stellar Docs: https://developers.stellar.org
- Smart Contract Docs: https://developers.stellar.org/docs/build/smart-contracts/overview
- CLI Docs: https://developers.stellar.org/docs/tools/stellar-cli

Usage: stellar [OPTIONS] <COMMAND>

Commands:
  completion  Print shell completion code for the specified shell
  contract    Tools for smart contract developers
  events      Watch the network for contract events
  keys        Create and manage identities including keys and addresses
  xdr         Decode and encode XDR
  network     Start and configure networks
  version     Print version information
  tx          Sign, Simulate, and Send transactions
  cache       Cache for transactions and contract specs

Options:
      --global                     Use global config
  -f, --filter-logs <FILTER_LOGS>  Filter logs output. To turn on `stellar_cli::log::footprint=debug` or off `=off`. Can also use env var `RUST_LOG`
  -q, --quiet                      Do not write logs to stderr including `INFO`
  -v, --verbose                    Log DEBUG events
      --very-verbose               Log DEBUG and TRACE events [aliases: vv]
      --list                       List installed plugins. E.g. `stellar-hello`
      --no-cache                   Do not cache your simulations and transactions [env: STELLAR_NO_CACHE=]
  -h, --help                       Print help (see more with '--help')
  -V, --version                    Print version

TESTING_OPTIONS:
      --config-dir <CONFIG_DIR>  Location of config directory, default is "."

After

$ stellar -h
Work seamlessly with Stellar accounts, contracts, and assets from the command line.

- Generate and manage keys and accounts
- Build, deploy, and interact with contracts
- Deploy asset contracts
- Stream events
- Start local testnets
- Decode, encode XDR
- More!

For additional information see:

- Stellar Docs: https://developers.stellar.org
- Smart Contract Docs: https://developers.stellar.org/docs/build/smart-contracts/overview
- CLI Docs: https://developers.stellar.org/docs/tools/stellar-cli

Usage: stellar [OPTIONS] <COMMAND>

Commands:
  contract    Tools for smart contract developers
  events      Watch the network for contract events
  keys        Create and manage identities including keys and addresses
  network     Start and configure networks
  tx          Sign, Simulate, and Send transactions
  xdr         Decode and encode XDR
  completion  Print shell completion code for the specified shell
  cache       Cache for transactions and contract specs
  version     Print version information

Options:
      --global                     Use global config
      --config-dir <CONFIG_DIR>    Location of config directory, default is "."
  -f, --filter-logs <FILTER_LOGS>  Filter logs output. To turn on `stellar_cli::log::footprint=debug` or off `=off`. Can also use env var `RUST_LOG`
  -q, --quiet                      Do not write logs to stderr including `INFO`
  -v, --verbose                    Log DEBUG events
      --very-verbose               Log DEBUG and TRACE events [aliases: vv]
      --list                       List installed plugins. E.g. `stellar-hello`
      --no-cache                   Do not cache your simulations and transactions [env: STELLAR_NO_CACHE=]
  -h, --help                       Print help (see more with '--help')
  -V, --version                    Print version

Diff

@@ -1,10 +1,12 @@
-With the Stellar CLI you can:
+Work seamlessly with Stellar accounts, contracts, and assets from the command line.
 
-- build, deploy and interact with contracts
-- set identities to sign with
-- configure networks
-- generate keys
-- more!
+- Generate and manage keys and accounts
+- Build, deploy, and interact with contracts
+- Deploy asset contracts
+- Stream events
+- Start local testnets
+- Decode, encode XDR
+- More!
 
 For additional information see:
 
@@ -15,18 +17,19 @@ For additional information see:
 Usage: stellar [OPTIONS] <COMMAND>
 
 Commands:
-  completion  Print shell completion code for the specified shell
   contract    Tools for smart contract developers
   events      Watch the network for contract events
   keys        Create and manage identities including keys and addresses
-  xdr         Decode and encode XDR
   network     Start and configure networks
-  version     Print version information
   tx          Sign, Simulate, and Send transactions
+  xdr         Decode and encode XDR
+  completion  Print shell completion code for the specified shell
   cache       Cache for transactions and contract specs
+  version     Print version information
 
 Options:
       --global                     Use global config
+      --config-dir <CONFIG_DIR>    Location of config directory, default is "."
   -f, --filter-logs <FILTER_LOGS>  Filter logs output. To turn on `stellar_cli::log::footprint=debug` or off `=off`. Can also use env var `RUST_LOG`
   -q, --quiet                      Do not write logs to stderr including `INFO`
   -v, --verbose                    Log DEBUG events
@@ -35,6 +38,3 @@ Options:
       --no-cache                   Do not cache your simulations and transactions [env: STELLAR_NO_CACHE=]
   -h, --help                       Print help (see more with '--help')
   -V, --version                    Print version
-
-TESTING_OPTIONS:
-      --config-dir <CONFIG_DIR>  Location of config directory, default is "."

Why

To communicate the purpose of the CLI clearer in the help, and to make the "above the fold" things the main features of the CLI.