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

services/horizon/flags: refined cli help content #5022

Closed
sreuland opened this issue Aug 21, 2023 · 1 comment · Fixed by #5077
Closed

services/horizon/flags: refined cli help content #5022

sreuland opened this issue Aug 21, 2023 · 1 comment · Fixed by #5077

Comments

@sreuland
Copy link
Contributor

What problem does your feature solve?

current help output printed to console from stellar-horizon -h and sub-commands likestellar-horizon <sub-command> -h prints all Global Flags in any case, many of which are not relevant within specific sub-commands.

the Global Flags section can be noisy, making difficult to understand what parameters are relevant for each specific sub-command like serve, db, ingest, record-metrics

What would you like to see?

reduced cli help output, less copy, but what is printed is more concise to context.

  • stellar-horizon -h doesn't print Global Flags, just the sub-commands available and new 'best practices' blurb to recommend using environment variables overall.

  • stellar-horizon <sub-command> ... -h, doesn't print Global Flags, just the flags relevant for the <sub-command>'s given, i.e. the help output for stellar-horizon db init vs stellar-horizon db reingest

What alternatives are there?

@sreuland
Copy link
Contributor Author

related to: #4915

@sreuland sreuland self-assigned this Sep 21, 2023
sreuland added a commit to sreuland/go that referenced this issue Oct 6, 2023
sreuland added a commit to sreuland/go that referenced this issue Oct 6, 2023
sreuland added a commit to sreuland/go that referenced this issue Oct 10, 2023
sreuland added a commit to sreuland/go that referenced this issue Oct 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant