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.

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

Improve celestia-appd init --help docs #1393

Open
rootulp opened this issue Feb 16, 2023 · 0 comments
Open

Improve celestia-appd init --help docs #1393

rootulp opened this issue Feb 16, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@rootulp
Copy link
Collaborator

rootulp commented Feb 16, 2023

$ celestia-appd init --help
Initialize validators's and node's configuration files.

Usage:
  celestia-appd init [moniker] [flags]

Flags:
      --chain-id string             genesis file chain-id, if left blank will be randomly created
  -h, --help                        help for init
      --home string                 node's home directory (default "/Users/rootulp/.celestia-app")
  -o, --overwrite                   overwrite the genesis.json file
      --recover                     provide seed phrase to recover existing key instead of creating
      --staking-bond-denom string   genesis file staking bond denomination, if left blank default value is 'stake'

Global Flags:
      --log_format string   The logging format (json|plain) (default "plain")
      --log_level string    The logging level (trace|debug|info|warn|error|fatal|panic) (default "info")
      --trace               print out full stack trace on errors

Ideas for how to improve:

  1. Explain [moniker]
  2. Potentially include an example usage with moniker and --chain-id populated (especially for testnets)
  3. Does this command actually generate separate files for validators and nodes? Can it instead say something like: "Initialize the configuration files for a Celestia consensus node"
@rootulp rootulp added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant