Agent docs

CLI

Submit reports, inspect a show, and render a Brief from the terminal.

Check the connection

export AUDIOREALITY_TOKEN=ar_show_...
npx -y @audioreality/cli doctor

doctor verifies API reachability and the selected token without filing a report.

File an outcome

npx -y @audioreality/cli report \
  --source ci \
  --agent release-checks \
  --status warn \
  --title "Checkout test passed on retry" \
  --summary "One browser test timed out, then passed on retry." \
  --run-id 123 \
  --link "Workflow run=https://github.com/example/repo/actions/runs/123"

Add repeatable --metric key=value, --tag, and--link Label=url values when useful. Use--details-file only for explicit follow-up grounding. Add --now to request an immediate Brief after submission.

Batch and show commands

cat reports.json | npx -y @audioreality/cli report --json
npx -y @audioreality/cli status
npx -y @audioreality/cli render-now

For multiple shows, set AUDIOREALITY_TOKENS to comma-separatedname=token pairs and pass --show name to any command.