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
FAILStructured-output CLI exposes its schema at runtimeStructured, Parseable OutputCLI emits structured output but exposes no `schema` subcommand or `--schema` flag at top level or nested one level deep. Agents need a runtime-discoverable schema to pin against shape changes.
FAILErrors emit JSON envelope with `error`/`kind`/`message` under `--output json`Structured, Parseable Outputbad invocation under `--output json` produced no parseable JSON on stderr or stdout. JSON mode must emit a JSON error envelope, not plain text.
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
47 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.
--output/--format flag detected but could not validate JSON via safe probes (--help/--version override output flags in most CLIs)
FAIL
Structured-output CLI exposes its schema at runtime
CLI emits structured output but exposes no `schema` subcommand or `--schema` flag at top level or nested one level deep. Agents need a runtime-discoverable schema to pin against shape changes.
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 1. 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.
FAIL
Errors emit JSON envelope with `error`/`kind`/`message` under `--output json`
bad invocation under `--output json` produced no parseable JSON on stderr or stdout. JSON mode must emit a JSON error envelope, not plain text.
SKIP
JSON success and error envelopes share their non-payload key set
success-mode probe (`--help --output json`) produced no parseable JSON; cannot compare envelope shapes.
`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.
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
WARN
`--output json` produces JSON-formatted errors
errors under `--output json` are not JSON-formatted. Consumers parsing stdout-as-JSON cannot recover the failure without a separate text-parsing path; switch the error writer to honor the active output mode.
