ruff

Eight principles, scored

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

1. P1
   Non-Interactive by Default

   8 flag(s) found in --help but no `[env: NAME]` bindings advertised · 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).

   Remediation · P1⧉ copy prompt

   Make ruff satisfy P1 (Non-Interactive by Default) from the agent-native CLI standard. Address:
   - Flags advertise env-var bindings in --help (8 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).)
   Requirements: https://anc.dev/p1

   warn
2. P2
   Structured, Parseable Output

   --output/--format flag detected but could not validate JSON via safe probes (--help/--version override output flags in most CLIs) · no --json or --jsonl short alias found. Agents and pipelines benefit from short forms alongside the canonical `--output` enum.

   Remediation · P2⧉ copy prompt

   Make ruff satisfy P2 (Structured, Parseable Output) from the agent-native CLI standard. Address:
   - Structured output support (--output/--format flag detected but could not validate JSON via safe probes (--help/--version override output flags in most CLIs))
   - --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

   no `examples` subcommand or `--examples` flag found. MAY-tier — a curated usage block keeps agents from hunting through long help text. · 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.

   Remediation · P3⧉ copy prompt

   Make ruff 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.)
   - 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.)
   - 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

   destructive subcommand(s) without `--force` or `--yes`: clean, format. Irreversible operations must require explicit confirmation so they can't be invoked accidentally. · 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).

   Remediation · P5⧉ copy prompt

   Make ruff satisfy P5 (Safe Retries & Mutation Boundaries) from the agent-native CLI standard. Address:
   - 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.)
   - 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).)
   Requirements: https://anc.dev/p5

   fail
6. P6
   Composable, Predictable Command Structure

   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. · 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.

   Remediation · P6⧉ copy prompt

   Make ruff satisfy P6 (Composable, Predictable Command Structure) from the agent-native CLI standard. Address:
   - 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.)
   - 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.)
   Requirements: https://anc.dev/p6

   warn
7. P7
   Bounded, High-Signal Responses

   All 6 checks pass.

   pass
8. P8
   Discoverable Through Agent Skill Bundles

   All 3 checks pass.

   pass