Clarify `charmcraft status --help` text for `--format`
Metadata
Current evaluation
Clarified `charmcraft status --format` help to state that it accepts `json`; merged via #933 (commit `2f673059`).
Resolution: closed resolved
Reason: The help-text change was merged in canonical/charmcraft#933, with commit `2f673059` updating the message to direct users to pass `--format json`.
Evaluated by: mr-cal-bot
No scores available.
Issue body
#784 implements structured output of `charmcraft status`, but the help text on it is a bit misleading:
```
base ❯ time charmcraft status --help
Usage:
charmcraft status [options] <name>
...
Options:
...
--format: Produce the result formatted as a JSON string
```
The above makes it seem like `charmcraft status charmname --format` will export in JSON, but really it wants `--format json`. Easy to fix by changing the option string to say it needs an extra arg, one of `json` or whatever else is available.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Clarified `charmcraft status --format` help to state that it accepts `json`; merged via #933 (commit `2f673059`). | |
| stealth/space-bunny-alpha | — | closed resolved | Clarified the help for charmcraft status --format in commit 2f673059, directing users to pass json rather than using a bare --format flag. | |
| stealth/space-bunny-alpha | — | closed resolved | Clarified that charmcraft status --format requires a value and only supports JSON. PR #933 was merged as 58a6600f, with implementation commit 2f673059. | |
| stealth/space-bunny-alpha | — | closed resolved | Clarified `status --format` to require an explicit JSON argument in merged PR #933 (commit 2f673059), resolving #794. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Closed without a linked fix or PR, likely abandoned. The misleading help text for charmcraft status --format remains unupdated. | |
| qwen/qwen3.6-35b-a3b | — | — | Fixed. The charmcraft status --format help text was updated to clarify the flag requires an argument. Closed without a linked pull request. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Closed without resolution. The misleading help text for the --format flag in charmcraft status was not updated to indicate it requires an explicit argument. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
canonical/charmcraft#933
(confidence 100%)
This pull request was merged and contains the commit that resolved the issue.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #933 Update the charmcraft status --format | charmcraft | merged | Merged in canonical/charmcraft#933, commit 2f673059, clarifying that charmcraft status --format supports JSON only and fixing #794. YAML support was removed and split into #940. | |
| #799 Update `charmcraft status charmname --format json` output terminology | charmcraft | closed | Resolved by merged PR #802 (commit 74dcf904): status JSON now uses "mappings" and preserves the full track in channel values. | |
| #913 Add `charmcraft fmt` command | charmcraft | open | A maintainer-endorsed feature request to add `charmcraft format` for semantics-preserving charm file formatting remains open pending agreement on scope and standards. |