← Back to issue list

`charmcraft init --help` doesn't list the available profiles

View original Github issue

Metadata

Project
charmcraft
Number
#966
Type
issue
State
closed
Author
sed-i
Labels
—
Created
Updated
Closed

Current evaluation

Fixed by merged PR #2311 (commit c24c0f47): charmcraft init help now lists Kubernetes, machine, and supported 12-factor profiles.

Resolution: closed resolved

Reason: The issue was closed after PR #2311 merged as commit c24c0f47. The change expanded init help to enumerate the supported profiles, including Kubernetes, machine, and the 12-factor profiles.

Evaluated by: mr-cal-bot

No scores available.

Issue body

From looking at #932 it seems that `--profile` can take `simple`, `kubernetes`, `machine`. It would be handy if `charmcraft init --help` listed all these options. Currently it only mentions `simple`: ``` --profile: Use the specified project profile (defaults to 'simple') ```

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Fixed by merged PR #2311 (commit c24c0f47): charmcraft init help now lists Kubernetes, machine, and supported 12-factor profiles.
stealth/space-bunny-alpha — closed resolved Fixed by merged PR #2311 (commit c24c0f47): charmcraft init help now lists Kubernetes, machine, and all supported 12-factor profiles.
qwen3.6-35b-a3b-mtp-q6 — — Fixed in pull request #2311. The charmcraft init help output now correctly lists all available profiles, resolving the usability concern.
qwen/qwen3.6-35b-a3b
Staleness: 88
Complexity: 10
Confidence: 85
Support Request: 5
close stale Request to update charmcraft init help output to clearly list and explain available project profiles. Discussed by maintainers but remains open with no implementation after over 3 years.
qwen3.6-35b-a3b-mtp-q6
Staleness: 80
Complexity: 20
Confidence: 85
Support Request: 10
keep open charmcraft init --help omits available profiles in the --profile flag description, though they are listed in the help summary. Maintainers acknowledge the UX gap but note it depends on an upstream Craft CLI framework update.
qwen3.6-35b-a3b-mtp-q6
Staleness: 90
Complexity: 15
Confidence: 70
Support Request: 5
close stale charmcraft init --help omits available --profile options from its description. Reported as a UX improvement; upstream Craft CLI issue opened; unresolved after ~3.5 years.

Update history

Date Change
closed

Related work

  • Likely Fixed By: canonical/charmcraft#2311 (confidence 99%)

    Merged PR #2311 directly updated charmcraft init help to list all supported profiles.

Related issues

Issue Project State Summary Similarity
#2311 docs(templates): list all 12-factor profiles in init help charmcraft merged Merged in #2311 as commit c24c0f47, expanding charmcraft help init to list all 12-factor profiles and describe them as Kubernetes charms.
78%
#1128 `charmcraft init`: issues with --profile docs, default profile, and default charm.py links charmcraft closed PR #1158 (commit 5b50d9e6) documented init profiles and replaced the outdated charm.py link; the default Kubernetes profile was left unchanged.
78%
#328 charmcraft init produces error charm for machine charms charmcraft closed Machine charms gained a dedicated charmcraft init profile, resolving Kubernetes-only initialization; the change was merged in PR #868 (commit 2ed9033c).
76%
#1112 cli: add supported profile arguments to help charmcraft merged Merged PR #1112 added supported profile arguments to Charmcraft's CLI help in commit 850a77a5.
76%
#859 Added a kubernetes profile to init command (CRAFT-1318). charmcraft merged Merged in canonical/charmcraft#859 (451c399a), adding the Kubernetes init profile and fixing the simple template for CRAFT-1318.
74%
#1383 Profile `simple` in `charmcraft init` has an unclear name charmcraft closed Charmcraft 4 removed the unclear simple init profile and made kubernetes the default in PR #2295 (commit fc17daa7).
73%
#1139 `charmcraft init --profile machine` doesn't produce `config.yaml` charmcraft closed Fixed in canonical/charmcraft#1149 via commit ca4df024: machine init now uses charmcraft.yaml and no longer tells users to edit metadata.yaml or config.yaml.
72%
#2401 feat(test): add testing profiles for init command charmcraft merged Merged PR #2401 as commit a7334d49, adding test-machine and test-kubernetes init profiles for charmcraft test; the feature shipped in Charmcraft 4.0.
71%
#2167 charmcraft init --profile machine does not produce a valid charmcraft.yaml charmcraft closed Fixed by #2200 (commit c4d43add), which migrated the machine init template from legacy bases syntax to platforms.
71%