--help needs some love
Metadata
Current evaluation
Resolved by snapcore/snapcraft#1307 (commit d34dc16af), replacing docopt with Click and adding clearer per-subcommand help and option summaries.
Resolution: closed resolved
Reason: PR #1307 was merged as commit d34dc16af. Its Click-based CLI refactor enabled dedicated help for each subcommand and separated subcommand options from global help.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Typing "snapcraft <any subcommand> --help" shows the same output of "snapcraft --help".
For clarity, each subcommand should hold its own documentation, and options for subcommands should be removed from the global documentation.
There's also no need to have a huge usage list at the top. Usage for each subcommand should ideally be inside that specific subcommand's help.
Also, the summary of the "build" stage holds documentation for its option:
"""
clean Remove content - cleans downloads, builds or install artifacts.
pull Download or retrieve artifacts defined for a part.
build Build artifacts defined for a part. Build systems capable of
running parallel build jobs will do so unless
"--no-parallel-build" is specified.
"""
The option should be documented under the options header as usual, instead of the summary.
Also, these summaries might be moved to the third person perhaps. E.g.:
pull Downloads or retrieves artifacts defined for a part.
and the "clean" one might also be shortened to something like:
clean Removes downloads, builds, or install artifacts.
Anyway, sorry for the sausage report. This is all related, but not quite.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Resolved by snapcore/snapcraft#1307 (commit d34dc16af), replacing docopt with Click and adding clearer per-subcommand help and option summaries. | |
| stealth/space-bunny-alpha | — | closed resolved | Fixed by snapcore/snapcraft#1307, merged as d34dc16af: the docopt-based CLI was replaced with Click, providing per-subcommand help and cleaner option usage. | |
| stealth/space-bunny-alpha | — | closed resolved | Resolved by PR #1307, merged as d34dc16af, replacing the docopt-based CLI with Click and enabling clearer per-command help handling. | |
| stealth/space-bunny-alpha | — | closed stale | Subcommand help request was closed without a recorded fix or discussion after 3,412 days of inactivity. | |
| qwen/qwen3.6-35b-a3b | — | — | Closed without resolution. The help text and subcommand documentation improvements were not implemented, likely abandoned or superseded by later CLI updates. | |
| qwen/qwen3.6-35b-a3b | — | — | Snapcraft help documentation formatting and subcommand separation requests were closed without resolution. No fix or pull request was linked, indicating the report was abandoned due to prolonged inactivity. |
Update history
| Date | Change |
|---|---|
| created |
Related work
-
Likely Fixed By:
snapcore/snapcraft#1307
(confidence 100%)
Merged CLI refactor implementing the requested command-specific help structure.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1789 cli: improve the help command | snapcraft | merged | Merged PR #1789 in commit e66b29d84, giving snapcraft help parity with --help and exposing topic and plugin help; it resolved snapcraft#1698. | |
| #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). | |
| #32 Add help subcommand | snapcraft | closed | Implemented snapcraft help in commit 3c3cbcf84; the maintainer confirmed topic and plugin help worked as expected before closure. | |
| #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. | |
| #135 cli: Move to docopt, help cmd migrated. | snapcraft | closed | Closed unmerged and superseded by canonical/snapcraft#136, which landed the same docopt help-command migration in commit 00642d304. Review feedback was addressed there; tests stayed disabled pending the wider CLI migration. | |
| #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. | |
| #1585909 Usage message [options] could be better placed | snapcraft (launchpad) | closed | Resolved by snapcraft PR #1307 (commit d34dc16af), which replaced the docopt-based CLI with a Click-based UI and internal refactor. | |
| #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. | |
| #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. | |
| #1701 snapcraft help” only command summary | snapcraft | closed | Request for concise `snapcraft help` output was closed without implementation or explanation; no resolving PR or commit was recorded. |