Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Investigate grouping options together in CLI help text #20706

Open
danxmoran opened this issue Feb 5, 2021 · 0 comments
Open

Investigate grouping options together in CLI help text #20706

danxmoran opened this issue Feb 5, 2021 · 0 comments
Labels
area/cli area/documentation area/2.x OSS 2.0 related issues and PRs

Comments

@danxmoran
Copy link
Contributor

Many of our CLI commands (especially influxd run and influxd upgrade) take a large number of options. Options were often added organically over time, without a consistent naming scheme, so it can end up being difficult for users to know which options are related to one another and how they relate.

A common technique I've seen in other CLI programs is to group options into categories within the help-text. For example, in influxd upgrade we could have groups for "Inputs" and "Outputs". cobra doesn't have built-in support for that functionality, but from spf13/cobra#1327 it sounds like there are enough customization hooks for us to roll our own solution.

@danxmoran danxmoran added area/documentation area/cli area/2.x OSS 2.0 related issues and PRs labels Feb 5, 2021
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
area/cli area/documentation area/2.x OSS 2.0 related issues and PRs
Projects
None yet
Development

No branches or pull requests

1 participant