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

[NEW] Group top level commands by registry #140

Merged
merged 1 commit into from
Sep 2, 2024
Merged

Conversation

bhou
Copy link
Contributor

@bhou bhou commented Aug 29, 2024

This will improve the situation mentioned in #138

Tested the original idea of grouping top level commands by package, turns out the output message are grouped into too many fragments, which reduces the readability.

This PR only group the top-level commands by registry and it can be toggled by a new configuration item group_help_by_registry with default value true

Here is an example help:

Criteo Dev Toolkit - A command launcher 🚀 made with <3

Happy Coding!

Example:
  cdt --help

Usage:
  cdt [flags]
  cdt [command]

Commands from 'dropin' registry
  migration                                   Collection of tools for migration
  moab-report                                 Generate MOAB reports

Commands from 'default' registry
  code                                        help for the command code
  devenv                                      Manage development environment
  doc                                         generate documentation from sources
  hotfix                                      Create, review, and build hotfix from your terminal
  moab                                        Generic MOAB commands
  mozart                                      Help for the command mozart

Additional Commands:
  completion                                  Generate completion script
  config                                      Manage configurations
  help                                        Help about any command
  login                                       Login to use services
  package                                     Manage command launcher packages
  remote                                      Manage command launcher remotes
  rename                                      Rename installed command
  update                                      Update cdt, or its commands
  version                                     Print the version number of CDT command

Flags:
  -h, --help   help for cdt

Use "cdt [command] --help" for more information about a command.

@bhou bhou requested a review from zeralight August 29, 2024 10:26
@bhou bhou merged commit 09a4fb2 into main Sep 2, 2024
16 checks passed
@hdost hdost deleted the group-help-by-registry branch September 22, 2024 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants