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
Top Issues
FAILError messages include a hint or remediation phraseFail-Fast, Actionable Errorsstderr lacks a hint phrase. Looked for one of: try , use , expected , did you mean, see , run , for more, tip:, help:, hint:, suggestion:, available . Error messages must name what to do next, not just the symptom.
WARN--json / --jsonl short aliases for --outputStructured, Parseable Outputno --json or --jsonl short alias found. Agents and pipelines benefit from short forms alongside the canonical `--output` enum.
WARN`--raw` flag for pipe-safe unformatted outputStructured, Parseable Outputno `--raw` flag advertised. MAY-tier — useful for pipelines that want to strip formatting before piping to other tools.
target satisfies P1 via alternative gate (help-on-bare or stdin-primary)
PASS
Flags advertise env-var bindings in --help
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.
no --output/--format flag detected — tool does not ship structured output. Schema-discovery requirements (p2-must-schema-print, p2-should-schema-file) collapse to n/a via antecedent propagation.
N/A
Structured-output CLI exposes its schema at runtime
antecedent `p2-json-output` is opt_out: no --output/--format flag detected — tool does not ship structured output. Schema-discovery requirements (p2-must-schema-print, p2-should-schema-file) collapse to n/a via antecedent propagation.
WARN
--json / --jsonl short aliases for --output
no --json or --jsonl short alias found. Agents and pipelines benefit from short forms alongside the canonical `--output` enum.
WARN
`--raw` flag for pipe-safe unformatted output
no `--raw` flag advertised. MAY-tier — useful for pipelines that want to strip formatting before piping to other tools.
no `--output` or `--format` flag advertised; vacuous skip for MAY-tier extra formats.
WARN
Bad invocation exits with structured usage-error code (2)
bad invocation exited with code 3. The 0/1/2/77/78 convention reserves code 2 for usage errors; using a different non-zero code (often 1) blurs the distinction between usage errors and general failure.
SKIP
Errors emit JSON envelope with `error`/`kind`/`message` under `--output json`
binary does not advertise `--output json` in --help; MUST applies only to CLIs that opt into the JSON contract.
SKIP
JSON success and error envelopes share their non-payload key set
binary does not advertise `--output json` in --help; envelope-consistency only applies to CLIs that opt into the JSON contract.
`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.
SKIP
Short `-h` summary differs from `--help` long form
one or both of `-h` / `--help` produced empty output
SKIP
Each subcommand's `--help` ships at least one invocation example
binary has no subcommands; MUST applies conditionally to CLIs that use them.
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.
Error messages include a hint or remediation phrase
stderr lacks a hint phrase. Looked for one of: try , use , expected , did you mean, see , run , for more, tip:, help:, hint:, suggestion:, available . Error messages must name what to do next, not just the symptom.
SKIP
`--output json` produces JSON-formatted errors
binary does not advertise `--output json` in --help; SHOULD applies only to CLIs that opt into the JSON contract.
