datasette

Eight principles, scored

Behavioral and source checks. Every non-pass row carries a copy-paste remediation prompt.

1. P1
   Non-Interactive by Default

   binary may be waiting for interactive input · no non-interactive flag found in --help; expected one of: --no-interactive, --non-interactive, -p, --print, --no-input, --batch, --headless, -y, --yes, --assume-yes

   Remediation · P1⧉ copy prompt

   Make datasette satisfy P1 (Non-Interactive by Default) from the agent-native CLI standard. Address:
   - Non-interactive by default (binary may be waiting for interactive input)
   - Non-interactive gate flag advertised in --help (no non-interactive flag found in --help; expected one of: --no-interactive, --non-interactive, -p, --print, --no-input, --batch, --headless, -y, --yes, --assume-yes)
   - Flags advertise env-var bindings in --help (2 flag(s) found in --help but no `[env: NAME]` bindings advertised)
   - `--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

   warn
2. P2
   Structured, Parseable Output

   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 · P2⧉ copy prompt

   Make datasette 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

   warn
3. P3
   Progressive Help Discovery

   `--version` works but no short alias responded (tried -V, -v, -version). Adding one shortens version probes for agents. · `--version` works but no short alias responded (tried -V, -v, -version). Adding one shortens version probes for agents.

   Remediation · P3⧉ copy prompt

   Make datasette satisfy P3 (Progressive Help Discovery) from the agent-native CLI standard. Address:
   - Version flag works (`--version` plus short alias) (`--version` works but no short alias responded (tried -V, -v, -version). Adding one shortens version probes for agents.)
   - Version flag works (`--version` plus short alias) (`--version` works but no short alias responded (tried -V, -v, -version). Adding one shortens version probes for agents.)
   - `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.)
   - Each subcommand's `--help` ships at least one invocation example (subcommands missing example invocations in their `--help`: inspect, install, package, plugins, publish, uninstall. 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

   fail
4. P4
   Fail-Fast, Actionable Errors

   All 3 checks pass.

   pass
5. P5
   Safe Retries & Mutation Boundaries

   All 2 checks pass.

   pass
6. P6
   Composable, Predictable Command Structure

   4/6 subcommand(s) follow standard verb names. Non-standard: package, plugins. 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 · P6⧉ copy prompt

   Make datasette satisfy P6 (Composable, Predictable Command Structure) from the agent-native CLI standard. Address:
   - Subcommand verbs follow community-standard names (4/6 subcommand(s) follow standard verb names. Non-standard: package, plugins. 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.)
   Requirements: https://anc.dev/p6

   warn
7. P7
   Bounded, High-Signal Responses

   no --quiet/-q flag detected in --help output · no `--verbose` / `-v` flag advertised. SHOULD-tier — agents debugging failures need a way to escalate diagnostic detail.

   Remediation · P7⧉ copy prompt

   Make datasette satisfy P7 (Bounded, High-Signal Responses) from the agent-native CLI standard. Address:
   - Quiet mode available (no --quiet/-q flag detected in --help output)
   - `--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

   warn
8. P8
   Discoverable Through Agent Skill Bundles

   All 3 checks pass.

   pass