cli: improve the help command
Metadata
Current evaluation
Improved the CLI help command to match --help parity and expose hidden topics and plugin help. Merged after reviewer approval and passing CI, modifying three files with 62 additions and 11 deletions.
Suggested action: —
No scores available.
Issue body
Give it parity with --help but also extend it so topics and plugin help is
not completely hidden.
LP: #1698116
Signed-off-by: Sergio Schvezov <sergio.schvezov@canonical.com>
- [x] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/CONTRIBUTING.md)?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] If this is a bugfix. Have you checked that there is a bug report open for the issue you are trying to fix on [bug reports](https://bugs.launchpad.net/snapcraft)?
- [x] If this is a new feature. Have you discussed the design on the [forum](https://forum.snapcraft.io)?
- [x] Have you successfully run `./runtests.sh static`?
- [x] Have you successfully run `./runtests.sh unit`?
-----
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Improved the CLI help command to match --help parity and expose hidden topics and plugin help. Merged after reviewer approval and passing CI, modifying three files with 62 additions and 11 deletions. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged improvements to the CLI help command, aligning output with --help parity and exposing previously hidden topics and plugin help. Resolves LP: #1698116. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Successfully merged improvements to the CLI help command, aligning it with --help parity and exposing previously hidden topic and plugin help. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #84 fix(cli): enable per-command help queries | craft-application | merged | Merged to main, enabling per-command help queries in the CLI and resolving issue #76. Approved by two reviewers, passed CI checks, and achieved 100% diff coverage across three files. | |
| #2429 cli: fix usage string in help command | snapcraft | merged | Merged a one-line fix that corrected an incorrect usage string in the CLI help command. The change was approved, passed CI checks, and resolved the reported bug. | |
| #306 feat: remove code backticks in CLI help messages | craft-cli | merged | Merged following approval by two reviewers and successful CI checks. The update removes code backticks from CLI help messages, closes #303. Changes affect two files with 90 additions and zero deletions. | |
| #3682 cli: fix help command legacy fallback | snapcraft | merged | Merged fix for the CLI help command legacy fallback. Handles craft-cli's ProvideHelpException to standardize help output. Approved, passed CI, and achieved 100% diff coverage before merging into the 7.0 branch. | |
| #1640 cli: add what, why, and how to fix to the common errors | snapcraft | merged | Merged pull request adding what, why, and how to fix guidance to common CLI error messages. Approved by two reviewers, modified 15 files (+484/-155 lines), and passed CI after a temporary test failure was rerun. | |
| #1845 cli: implement help <command> | snapcraft | merged | Implemented snapcraft help <command> CLI functionality. Merged after passing CI checks and receiving reviewer approval. Closes issue #1699. | |
| #154 Improved short help messages. | charmcraft | merged | Merged improvements to short help messages for commands and parameters, updating output per UX suggestions. Approved by two reviewers, passed CI, and modified eight files as part of a broader help overhaul. |