Skip to content

Command Audit

Operator docs use command-audit markers on shell examples.

<!-- command-audit: runnable -->
<!-- command-audit: illustrative -->
<!-- command-audit: output -->

Meaning:

  • runnable: expected to work from the repository root in a normal local checkout, or as written inside the page context.
  • illustrative: requires a generated run id, a running service, an authorized target, or local values the reader must provide.
  • output: terminal output, not a command to run.

The audit covers command-heavy operator docs, including Getting Started, scenarios, Seam, Assay, meshmapper, labs, guides, professional range pages, and demo-media pages:

python3 scripts/audit_doc_commands.py

Use this rule when adding docs:

  • quickstart and demo commands should be runnable whenever practical
  • target-specific commands should be illustrative and name the required setup
  • generated run-id examples should be illustrative
  • output blocks should not be marked as runnable commands

This is a documentation quality check, not a substitute for the tool test suite.

AIT Assay Helpers

These wrappers call Assay through its public CLI while keeping the operator in the root workbench:

python3 -m ait.cli assay inspect-family \
  --case-family agentic-redteam/assay/cases/refund_family.yaml \
  --json

python3 -m ait.cli assay list-techniques \
  --techniques agentic-redteam/assay/techniques/agentic.yaml \
  --json

python3 -m ait.cli assay craft \
  --intent refund \
  --techniques agentic-redteam/assay/techniques/agentic.yaml \
  --vars agentic-redteam/assay/vars/refund.yaml \
  --runs-dir .ait/runs \
  --run-id refund-craft