How many of the spec's requirements were verified for this tool.
See /coverage for the full matrix.
Level
Total
Verified
Unverified
MUST
28
19
9
SHOULD
21
13
8
MAY
10
10
0
Audience signal: mixed
This tool sends mixed signals: some agent-readable affordances are present, others are not. Treat the warnings below as friction points, not defects.
This is an informational signal, not an authoritative verdict — see methodology. The per-audit evidence below is the ground truth.
Top Issues
FAILEach subcommand's `--help` ships at least one invocation exampleProgressive Help Discoverysubcommands missing example invocations in their `--help`: bug-report, config, explain, init, module, preset, print-config, prompt, session, statusline, timings, toggle. Examples teach agents the call shape faster than option tables; use clap's `after_help` or a dedicated `Examples:` block.
FAILDestructive subcommands require `--force` or `--yes`Safe Retries & Mutation Boundariesdestructive subcommand(s) without `--force` or `--yes`: preset. Irreversible operations must require explicit confirmation so they can't be invoked accidentally.
WARNStructured output supportStructured, Parseable Output--output/--format flag detected but could not validate JSON via safe probes (--help/--version override output flags in most CLIs)
target satisfies P1 via alternative gate (help-on-bare or stdin-primary)
WARN
Flags advertise env-var bindings in --help
2 flag(s) found in --help but no `[env: NAME]` bindings advertised
PASS
Secret-bearing flags expose stdin or *-file companion
WARN
`--help` advertises default values for flags
no default-value annotations found in --help. SHOULD-tier — agents reading help text need to see what value a flag falls back to when omitted (`[default: <value>]` per clap convention).
WARN
Rich-TUI affordance for TTY contexts
no rich-TUI affordance detected (no `--tui`/`--interactive`/`--ui` flag, no spinner/progress/tui mention in --help). MAY-tier — rich TUI in TTY contexts is a nice-to-have, not required.
`examples` subcommand or `--examples` flag for curated usage patterns
no `examples` subcommand or `--examples` flag found. MAY-tier — a curated usage block keeps agents from hunting through long help text.
WARN
Short `-h` summary differs from `--help` long form
`-h` and `--help` produce byte-identical output. SHOULD-tier — clap renders the short summary on `-h` and the full description on `--help` when `long_about` is set; collapsing them gives agents no concise list-level grep target.
FAIL
Each subcommand's `--help` ships at least one invocation example
subcommands missing example invocations in their `--help`: bug-report, config, explain, init, module, preset, print-config, prompt, session, statusline, timings, toggle. Examples teach agents the call shape faster than option tables; use clap's `after_help` or a dedicated `Examples:` block.
WARN
Help text pairs human and `--output json` example invocations
no paired text + `--output json` example found within 5 lines in top-level or any subcommand `--help`. Pairing keeps agents from reverse-engineering the JSON invocation from the text one.
Destructive subcommands require `--force` or `--yes`
destructive subcommand(s) without `--force` or `--yes`: preset. Irreversible operations must require explicit confirmation so they can't be invoked accidentally.
WARN
Read and write surfaces are both visible in subcommand list
write-pattern subcommand(s) present (preset) but no read-pattern surface detected. If the CLI is write-only by design the MUST is satisfied vacuously; otherwise expose the read surface with agent-recognizable verbs (list/get/show/query/find/search).
no `--verbose` / `-v` flag advertised. SHOULD-tier — agents debugging failures need a way to escalate diagnostic detail.
SKIP
`--limit` / `--max-results` flag for list operations
no list-style subcommand detected (list/ls/search/query/find/show/get); vacuous skip for the list-only SHOULD.
SKIP
Cursor-based pagination flags for list traversal
no list-style subcommand detected; vacuous skip for the list-only MAY.
SKIP
`--timeout` flag for long-running operations
no long-running subcommand detected (serve/daemon/watch/tail/monitor/follow/run/start/stream); vacuous skip for the conditional SHOULD.
WARN
Help text advertises TTY-aware verbosity behavior
no TTY-aware language found in `--help`. MAY-tier — automatic verbosity reduction when stdout is piped or redirected lets agents skip the explicit `--quiet` flag. Behavioral probes cannot simulate a real TTY without a pty crate, so this audit relies on documented intent.
