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

Organize Flags #1838

Closed
2 of 4 tasks
rigelrozanski opened this issue Jul 26, 2018 · 3 comments
Closed
2 of 4 tasks

Organize Flags #1838

rigelrozanski opened this issue Jul 26, 2018 · 3 comments

Comments

@rigelrozanski
Copy link
Contributor

Summary

There are a lot of flags and it's confusing reading them all at once, organization could help user comprehension

Problem Definition

Why do we need this feature?

  • because in some places are CLI has A LOT of flags
Usage:
  gaiacli stake create-validator [flags]

Flags:
      --account-number int         AccountNumber number to sign the tx
      --address-delegator string   hex address of the delegator
      --amount string              Amount of coins to bond (default "1steak")
      --async                      broadcast transactions asynchronously
      --chain-id string            Chain ID of tendermint node
      --details string             optional details
      --fee string                 Fee to pay along with transaction
      --from string                Name of private key with which to sign
      --gas int                    gas limit to set per-transaction (default 200000)
  -h, --help                       help for create-validator
      --identity string            optional identity signature (ex. UPort or Keybase)
      --json                       return output in json format
      --ledger                     Use a connected Ledger device
      --memo string                Memo to send along with transaction
      --moniker string             validator name
      --name string                DEPRECATED - Name of private key with which to sign
      --node string                <host>:<port> to tendermint rpc interface for this chain (default "tcp://localhost:26657")
      --print-response             return tx response (only works with async = false)
      --pubkey string              Go-Amino encoded hex PubKey of the validator. For Ed25519 the go-amino prepend hex is 1624de6220
      --sequence int               Sequence number to sign the tx
      --website string             optional website

^ for instance here I'd like to see validator Description flags grouped together, as well as tendermint related grouped together etc.

What problems may be addressed by introducing this feature?

  • being able to understand the CLI
    What benefits does the SDK stand to gain by including this feature?
  • better UX
    Are there any disadvantages of including this feature?
  • lil extra code

Proposal

Pretty sure cobra allows for this - just need to look into it


For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@zramsay
Copy link
Contributor

zramsay commented Aug 27, 2018

related to #885 and see and closed issues below for flags that need some ❤️

@jackzampolin
Copy link
Member

cc @mslipper

@jackzampolin
Copy link
Member

I think this has been addressed by a number of PRs at this point. going to close this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants