navi
An interactive cheatsheet tool for the command-line
$ anc audit navi --json
Eight principles, scored
Behavioral and source checks. Every non-pass row carries a copy-paste remediation prompt.
- P1Non-Interactive by Defaultwarn
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). · 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.
Remediation · P1Make navi satisfy P1 (Non-Interactive by Default) from the agent-native CLI standard. Address: - `--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).) - 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.) Requirements: https://anc.dev/p1
- P2Structured, Parseable Outputwarn
no --json or --jsonl short alias found. Agents and pipelines benefit from short forms alongside the canonical `--output` enum. · no `--raw` flag advertised. MAY-tier — useful for pipelines that want to strip formatting before piping to other tools.
Remediation · P2Make navi satisfy P2 (Structured, Parseable Output) from the agent-native CLI standard. Address: - --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.) - `--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.) Requirements: https://anc.dev/p2
- P3Progressive Help Discoveryfail
no `examples` subcommand or `--examples` flag found. MAY-tier — a curated usage block keeps agents from hunting through long help text. · `-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.
Remediation · P3Make navi satisfy P3 (Progressive Help Discovery) from the agent-native CLI standard. Address: - `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.) - 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.) - 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.) - 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.) Requirements: https://anc.dev/p3
- P4Fail-Fast, Actionable Errorspass
All 3 checks pass.
- P5Safe Retries & Mutation Boundariespass
All 2 checks pass.
- P6Composable, Predictable Command Structurewarn
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. · no `--color` flag advertised. MAY-tier — `auto|always|never` lets agents and pipelines override the TTY-based default.
Remediation · P6Make navi satisfy P6 (Composable, Predictable Command Structure) from the agent-native CLI standard. Address: - 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.) - `--color` flag for explicit color control (no `--color` flag advertised. MAY-tier — `auto|always|never` lets agents and pipelines override the TTY-based default.) - 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.) - 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.) Requirements: https://anc.dev/p6
- P7Bounded, High-Signal Responseswarn
no `--verbose` / `-v` flag advertised. SHOULD-tier — agents debugging failures need a way to escalate diagnostic detail. · 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.
Remediation · P7Make navi satisfy P7 (Bounded, High-Signal Responses) from the agent-native CLI standard. Address: - `--verbose` flag for diagnostic escalation (no `--verbose` / `-v` flag advertised. SHOULD-tier — agents debugging failures need a way to escalate diagnostic detail.) - 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.) Requirements: https://anc.dev/p7
- P8Discoverable Through Agent Skill Bundlespass
All 3 checks pass.
All Audits
P1: Non-Interactive by Default
| N/A by human-tui | Non-interactive by default | suppressed by audit_profile: human-tui |
| N/A by human-tui | Non-interactive gate flag advertised in --help | suppressed by audit_profile: human-tui |
| 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. |
P2: Structured, Parseable Output
| OPT-OUT | Structured output support | no --output/--format flag detected in any subcommand — tool does not ship structured output. |
| N/A | Structured-output CLI exposes its schema at runtime | antecedent `p2-json-output` is opt_out: no --output/--format flag detected in any subcommand — tool does not ship structured output. |
| 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. |
| SKIP | `--output` advertises additional formats beyond text/json | no `--output` or `--format` flag advertised; vacuous skip for MAY-tier extra formats. |
| PASS | Bad invocation exits with structured usage-error code (2) | |
| 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. |
P3: Progressive Help Discovery
| PASS | Help flag produces useful output | |
| PASS | Version flag works (`--version` plus short alias) | |
| PASS | Version flag works (`--version` plus short alias) | |
| WARN | `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. |
P4: Fail-Fast, Actionable Errors
| PASS | Rejects invalid arguments | |
| PASS | Error messages include a hint or remediation phrase | |
| 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. |
P5: Safe Retries & Mutation Boundaries
| SKIP | Destructive subcommands require `--force` or `--yes` | no destructive subcommands detected; MUST applies conditionally to CLIs with destructive operations. |
| SKIP | Read and write surfaces are both visible in subcommand list | no recognizable read or write subcommand verbs; the read/write distinction is unobservable from the help surface alone. |
P6: Composable, Predictable Command Structure
| N/A by human-tui | Handles SIGPIPE gracefully | suppressed by audit_profile: human-tui |
| SKIP | Pager-using CLI ships --no-pager escape hatch | 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. |
P7: Bounded, High-Signal Responses
| PASS | Quiet mode available | |
| WARN | `--verbose` flag for diagnostic escalation | 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. |
P8: Discoverable Through Agent Skill Bundles
| PASS | Skill bundle has install path (`tool skill install [<host>]`) | |
| PASS | `skill install --all` for multi-runtime install | |
| PASS | `skill update` / `skill upgrade` for bundle refresh |
Reproduce this scorecard for navi locally and inspect the failing audits:
anc audit --command navi --audit-profile human-tui --output jsonInstall anc first if you don't have it. Add --output json to get the same JSON shape committed under scorecards/.