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`: compile, watch, init, query, fonts, info. Examples teach agents the call shape faster than option tables; use clap's `after_help` or a dedicated `Examples:` block.
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)
PASS
Flags advertise env-var bindings in --help
PASS
Secret-bearing flags expose stdin or *-file companion
PASS
`--help` advertises default values for flags
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`: compile, watch, init, query, fonts, info. 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`
no destructive subcommands detected; MUST applies conditionally to CLIs with destructive operations.
WARN
Read and write surfaces are both visible in subcommand list
read-pattern subcommand(s) present (query) but no write-pattern surface detected. If the CLI is read-only by design the MUST is satisfied vacuously; otherwise the write surface needs an agent-recognizable verb (create/add/update/set/delete/…).
no `--verbose` / `-v` flag advertised. SHOULD-tier — agents debugging failures need a way to escalate diagnostic detail.
WARN
`--limit` / `--max-results` flag for list operations
list-style subcommand present but no limit flag advertised (looked for --limit, --max-results, --max, --top, -n). SHOULD-tier — callers should be able to bound response size directly rather than scrape-then-truncate.
WARN
Cursor-based pagination flags for list traversal
list-style subcommand present but no cursor/page flag advertised (looked for --after, --before, --cursor, --page, --offset). MAY-tier — cursor pagination lets agents traverse large result sets without re-scanning earlier pages.
WARN
`--timeout` flag for long-running operations
long-running subcommand present but no timeout flag advertised (looked for --timeout, --deadline, --max-time). SHOULD-tier — without a bound, agents that hit a hung operation have to enforce timeouts externally.
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.
