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
FAILEach subcommand's `--help` ships at least one invocation exampleProgressive Help Discoverysubcommands missing example invocations in their `--help`: check, rule, config, linter, clean, format, server, analyze, version. 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`: clean, format. 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
8 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).
`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.
PASS
Short `-h` summary differs from `--help` long form
FAIL
Each subcommand's `--help` ships at least one invocation example
subcommands missing example invocations in their `--help`: check, rule, config, linter, clean, format, server, analyze, version. 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`: clean, format. 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 (clean, format) 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 pager signal (less/more/$PAGER/--pager) in --help
PASS
Respects NO_COLOR
WARN
Subcommand verbs follow community-standard names
4/10 subcommand(s) follow standard verb names. Non-standard: check, rule, linter, format, server, analyze. MAY-tier — community-standard verbs (get/list/create/update/delete) help agents predict subcommand behavior across CLIs.
PASS
`--color` flag for explicit color control
WARN
Input-accepting commands read from stdin when no file is given
input-accepting subcommand present but `--help` does not mention stdin or `-` as a path placeholder. SHOULD-tier — agents piping data into the tool expect stdin to work when no file arg is provided.
PASS
Subcommand naming follows a consistent verb/noun convention
