← Back to issue list

Support `--help` flag for craftctl

View original Github issue

Metadata

Project
craft-parts
Number
#319
Type
issue
State
open
Author
merlijn-sebrechts
Labels
—
Created
Updated
Closed
—

Current evaluation

Requested craftctl --help to list supported commands; current code still accepts only default, set, and get, and the request has not been maintainer-triaged.

Suggested action: needs triage

Reason: craft_parts/ctl.py rejects every command except default, set, and get, while the no-argument path prints only generic usage and exits with an error; unit tests likewise cover no help behavior. The request has no labels, assignee, or maintainer response—the sole comment only reports creation of internal ticket CRAFT-2958—so it still needs triage.

Evaluated by: mr-cal-bot

Impact: 30 Quick Win: 18 Complexity: 20 Confidence: 95 Actionability: 76

Issue body

I wrote [a reference doc](https://forum.snapcraft.io/t/using-the-craftctl-tool/32664) to explain the current functionality of `craftctl` from the snapcraft perspective. I had to look through the code to see what commands craftctl supports and which arguments. It might be useful to have a `--help` flag which simply prints the currently supported functionality.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 30
Quick Win: 18
Complexity: 20
Confidence: 95
Actionability: 76
needs triage Requested craftctl --help to list supported commands; current code still accepts only default, set, and get, and the request has not been maintainer-triaged.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 22
Complexity: 10
Confidence: 70
Actionability: 80
needs triage Feature request to add --help flag to craftctl CLI to display supported commands (default, set, get). Issue is open with no labels or maintainer assessment.
qwen/qwen3.8-27b
Impact: 20
Quick Win: 17
Staleness: 75
Complexity: 15
Confidence: 75
Support Request: 10
needs triage Feature request to add a --help flag to craftctl that prints supported commands (default, set, get). No maintainer response or labels; only a Jira sync bot comment. Code still lacks the flag, but docs (PR #1091) now document the commands.
qwen/qwen3.6-35b-a3b
Staleness: 95
Complexity: 5
Confidence: 85
Support Request: 10
close stale Request to add a --help flag to craftctl to display supported commands and arguments. Currently inactive for over a year with only an automated Jira sync comment.
qwen3.6-35b-a3b-mtp-q6
Staleness: 90
Complexity: 10
Confidence: 80
Support Request: 10
needs triage Request to add a --help flag to the craftctl CLI tool to display supported commands and arguments. Currently unlabelled and unassessed by maintainers for over three years.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/craft-parts#188 (confidence 96%)

    Merged documentation for valid craftctl commands and project-variable access; it clarifies the scope but does not implement CLI help.

Related issues

No related issues found above the similarity threshold.