How many of the spec's requirements were verified for this tool.
See /coverage for the full matrix.
Level
Total
Verified
Unverified
MUST
28
17
11
SHOULD
21
13
8
MAY
10
10
0
human-tui Scored as a TUI: the non-interactive audits (P1) and the SIGPIPE audit (P6) have been suppressed — TUI apps intercept the TTY by design and install their own signal handlers.
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`: fn, repo, widget, info. Examples teach agents the call shape faster than option tables; use clap's `after_help` or a dedicated `Examples:` block.
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.
WARNSubcommand verbs follow community-standard namesComposable, Predictable Command Structure2/5 subcommand(s) follow standard verb names. Non-standard: fn, repo, widget. MAY-tier — community-standard verbs (get/list/create/update/delete) help agents predict subcommand behavior across CLIs.
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`: fn, repo, widget, 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.
no pager signal (less/more/$PAGER/--pager) in --help
PASS
Respects NO_COLOR
WARN
Subcommand verbs follow community-standard names
2/5 subcommand(s) follow standard verb names. Non-standard: fn, repo, widget. MAY-tier — community-standard verbs (get/list/create/update/delete) help agents predict subcommand behavior across CLIs.
WARN
`--color` flag for explicit color control
no `--color` flag advertised. MAY-tier — `auto|always|never` lets agents and pipelines override the TTY-based default.
SKIP
Input-accepting commands read from stdin when no file is given
no input-accepting subcommand detected (process/parse/convert/transform/analyze/validate/format/lint/audit); vacuous skip for the conditional SHOULD.
WARN
Subcommand naming follows a consistent verb/noun convention
subcommand naming is inconsistent: 1 non-verb subcommand(s) (repo) mix verb and non-verb children at the second level, so an agent cannot predict where the action lives. SHOULD-tier: pick a consistent shape (all verb-first, all noun-verb hierarchy, or any combination where each non-verb group's children are uniformly verbs). The verb list is a heuristic; inspect `--help` to confirm.
WARN
Operations are subcommands, not verb-shaped flags
top-level verb-shaped flag(s) found: --query. Operations belong under the `Commands:` block (`tool search "q"`), not on the flag namespace where they fight the `--help` filtering agents rely on.
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.
