← Back to issue list

`snapcraft metrics` CLI requires `--name` but does not list the possible values

View original Github issue

Metadata

Project
snapcraft
Number
#6401
Type
issue
State
open
Author
bepri
Labels
Status: Triaged
Created
Updated
Closed
—

Current evaluation

Enhancement: `snapcraft metrics --help` omits the valid `--name` metric values, forcing users to check store docs. Triaged, assigned to a contributor, with maintainer-approved approach: hardcoded list in help now, store-backed `list-metrics` command later.

Suggested action: keep open

Reason: The issue is labelled 'Status: Triaged', maintainer bepri assigned it to @distopicx01-ops ('I've gone ahead and assigned this to you'), and mr-cal agreed to the concrete design: hardcode the metric names in the help/validation error short-term, then add a `list-metrics` command that queries the store with a test asserting the hardcoded list matches store output. The contributor confirmed intent to revise their in-progress PR, so this is valid, scoped, and actively being worked on. Confidence is capped at 70 because the repository tools returned 'No pinned SHA available for project snapcraft', so I could not verify the metrics command source or confirm whether an associated PR has already merged.

Evaluated by: mr-cal-bot

Impact: 32 Quick Win: 21 Complexity: 22 Confidence: 70 Actionability: 85

Issue body

### Check existing issues - [x] I've verified that this request isn't described by any existing issues. ### Request In order to use the `metrics` command, I have to open up a browser to read the metrics docs page, at which point I may as well just visit the web-based metrics dashboard. ``` imani@azalea:~$ snapcraft metrics -h Usage: snapcraft metrics [options] <snap-name> Summary: Retrieve store metric data for a snap you own. New metrics are generated daily. Positional arguments: snap-name: The snap name to check Options: -h, --help: Show this help message and exit -v, --verbose: Show debug information and be more verbose -q, --quiet: Only show warnings and errors, not progress --verbosity: Set the verbosity level to 'quiet', 'brief', 'verbose', 'debug' or 'trace' -V, --version: Show the application version and exit --name: Metric to view --start: Date in the format of YYYY-MM-DD. Defaults to yesterday. --end: Date in the format of YYYY-MM-DD. Defaults to yesterday. --format: Format for output See also: list list-registered names register upload-metadata For a summary of all commands, run 'snapcraft help --all'. imani@azalea:~$ snapcraft metrics --name Usage: snapcraft [options] command [args]... Try 'snapcraft metrics -h' for help. Error: argument --name: expected one argument imani@azalea:~$ snapcraft --version snapcraft 9.0.1 ``` ### Document location Provide the URL or file path of the relevant page.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 32
Quick Win: 21
Complexity: 22
Confidence: 70
Actionability: 85
keep open Enhancement: `snapcraft metrics --help` omits the valid `--name` metric values, forcing users to check store docs. Triaged, assigned to a contributor, with maintainer-approved approach: hardcoded list in help now, store-backed `list-metrics` command later.
stealth/space-bunny-alpha
Impact: 30
Quick Win: 25
Complexity: 12
Confidence: 95
Actionability: 94
keep open Enhancement to list valid values for snapcraft metrics --name in CLI help is triaged and assigned, with a maintainer-approved contributor ready to revise an in-progress PR.
qwen/qwen3.6-35b-a3b
Impact: 50
Quick Win: 42
Staleness: 10
Complexity: 15
Confidence: 85
Support Request: 10
keep open CLI metrics command --name argument lacks help text listing valid metric values; triaged with volunteer ready to fix
qwen3.6-35b-a3b-mtp-q6
Impact: 55
Quick Win: 41
Staleness: 15
Complexity: 25
Confidence: 75
Support Request: 35
keep open snapcraft metrics CLI --name argument doesn't display available metric choices in help text. Issue is triaged but has no maintainer comments after 12 days.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 15
Confidence: 90
Support Request: 10
keep open CLI snapcraft metrics command requires a --name argument but fails to list valid metric options in its help text, forcing users to consult external documentation. Currently triaged, awaiting implementation.

Update history

Date Change
updated
updated
updated
updated
updated
updated
updated
created

Related issues

Issue Project State Summary Similarity
#6428 metrics: list valid metric names in help output snapcraft open Makes `snapcraft metrics --help` list valid `--name` metric values from MetricName;2-line change, CLA green and approved, but reviewer asked to reformat the long help into an overview list and the author has not pushed that rework yet.
81%