hipcheck
hipcheck copied to clipboard
Make Hipcheck `-h` output split listed commands into groups
Right now, the help text for Hipcheck just lists all commands together alphabetically, which isn't wrong but could be clearer.
Current
Automatically assess and score software repositories for supply chain risk
Usage: hc [OPTIONS] [COMMAND]
Commands:
check Analyze a package, source repository, SBOM, or pull request
schema Print the JSON schema for output of a specific `check` command
setup Initialize Hipcheck config file and script file locations
ready Check if Hipcheck is ready to run
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help (see more with '--help')
-V, --version Print version
Output Flags:
-v, --verbosity <VERBOSITY> How verbose to be [possible values: quiet, normal]
-k, --color <COLOR> When to use color [possible values: always, never, auto]
-f, --format <FORMAT> What format to use [possible values: json, human]
Path Flags:
-c, --config <CONFIG> Path to the configuration folder
-d, --data <DATA> Path to the data folder
-C, --cache <CACHE> Path to the cache folder
Imagined
Automatically assess and score software repositories for supply chain risk
Usage: hc [OPTIONS] [COMMAND]
Main Command:
check Analyze a package, source repository, SBOM, or pull request
Support Commands:
schema Print the JSON schema for output of a specific `check` command
setup Initialize Hipcheck config file and script file locations
ready Check if Hipcheck is ready to run
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help (see more with '--help')
-V, --version Print version
Output Flags:
-v, --verbosity <VERBOSITY> How verbose to be [possible values: quiet, normal]
-k, --color <COLOR> When to use color [possible values: always, never, auto]
-f, --format <FORMAT> What format to use [possible values: json, human]
Path Flags:
-c, --config <CONFIG> Path to the configuration folder
-d, --data <DATA> Path to the data folder
-C, --cache <CACHE> Path to the cache folder
This SO post seems to suggest it can't be done
Yeah I've seen that one. Our options then are either to try to work with the Clap folks to make that possible (long-term) and substitute our own help text for the top level help commands (short-term). We can discuss both, I think. Probably wouldn't want to pursue the Clap outreach until later, maybe the 3.7 milestone.
Closing since it's not possible in Clap and not a priority for us.