cli: improve the help command
Metadata
Current evaluation
Merged PR #1789 in commit e66b29d84, giving snapcraft help parity with --help and exposing topic and plugin help; it resolved snapcraft#1698.
Resolution: closed resolved
Reason: PR #1789 was merged as commit e66b29d84. The change implemented parity with --help and made topic and plugin help visible, resolving snapcraft#1698.
Evaluated by: mr-cal-bot
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 |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #1789 in commit e66b29d84, giving snapcraft help parity with --help and exposing topic and plugin help; it resolved snapcraft#1698. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #1789 as commit e66b29d84, making help match --help and exposing topics and plugin help. Addresses Launchpad bug #1698116. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #1789 in commit e66b29d84, aligning `help` with `--help` and exposing topics and plugin help. | |
| 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. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
snapcraft#1698
(confidence 100%)
The help-parity issue was resolved by the changes merged in PR #1789.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1698 “snapcraft help” parity with --help | snapcraft | closed | Fixed by merged PR #1789 (commit e66b29d84), aligning “snapcraft help” with --help and exposing topic and plugin help. | |
| #1845 cli: implement help <command> | snapcraft | merged | PR #1845 (commit cf20b3593) by sergiusens merged command-specific help support, adding `snapcraft help <command>` to the CLI and closing feature request #1699. | |
| #32 Add help subcommand | snapcraft | closed | Implemented snapcraft help in commit 3c3cbcf84; the maintainer confirmed topic and plugin help worked as expected before closure. | |
| #1510683 Add help subcommand | snapcraft (launchpad) | closed | Help subcommand with topic and plugin support added in snapcraft (commit 1d4f90583 "Add help", plus follow-ups on snapcraft/help.py such as 0b91f34fb fixing plugin listing). Confirmed by elopio and closed by sergiusens as released in snapcraft 0.4. | |
| #1698116 snapcraft help claims to have help for topics, but doesn't | snapcraft (launchpad) | closed | Merged PR #1789 in commit e66b29d84 improved `snapcraft help` so its available topics can be discovered. | |
| #1699 snapcraft <help> command | snapcraft | closed | Feature request by maintainer sergiusens to add a `snapcraft help <command>` sub-command. Resolved by merged PR #1845, commit cf20b3593 ("cli: implement help <command> (#1845)"), which added command-specific help support. | |
| #2429 cli: fix usage string in help command | snapcraft | merged | Merged a one-line CLI fix so `snapcraft help` displays the correct usage string. | |
| #1582506 --help needs some love | snapcraft (launchpad) | closed | Resolved by snapcore/snapcraft#1307 (commit d34dc16af), replacing docopt with Click and adding clearer per-subcommand help and option summaries. | |
| #1986645 Some snapcraft 7.x commands have irrelevant "help" info | snapcraft (launchpad) | closed | Fixed in Snapcraft 8 by command-group help refactoring merged in canonical/snapcraft#4934 (commit 6a388877f). | |
| #5169 snapcraft help fails on many commands | snapcraft | closed | Fixed by merged PR #5178 (commit f97d032bf), adding missing help text for positional args; maintainer closed the issue noting the fix ships in snapcraft 8.5.1. |