search

eth-educators / ethstaker-deposit-cli

Secure key generation for deposits
https://eth-educators.github.io/ethstaker-deposit-cli/
Creative Commons Zero v1.0 Universal
3 stars 5 forks source link

Reorder commands in the help documentation #58

Closed remyroy closed 2 months ago

remyroy commented 4 months ago

Current help shows:

Usage: __main__.py [OPTIONS] COMMAND [ARGS]...

Options:
  --language TEXT        The language you wish to use the CLI in.
  --non_interactive      Disables interactive prompts. Warning: With this
                         flag, there will be no confirmation step(s) to verify
                         the input value(s). This will also ignore the
                         connectivity check. Please use it carefully.

  --ignore_connectivity  Disables internet connectivity check. Warning: It is
                         strongly recommended not to use this tool with
                         internet access. Ignoring this check can further the
                         risk of theft and compromise of your generated key
                         material.

  --help                 Show this message and exit.

Commands:
  existing-mnemonic               Generate (or recover) keys from an...
  exit-transaction-keystore       Generate an exit transaction that can be...
  exit-transaction-mnemonic       Generate an exit transaction that can be...
  generate-bls-to-execution-change
                                  Generating the...
  new-mnemonic                    Generate a new mnemonic and keys

new-mnemonic should show first since it's likely the most popular or first use case from a user.