Context
The examples README has a JSON CLI checks for automation section with these commands:
browsertrace doctor --json
browsertrace list --status failed --json
browsertrace show <run_id> --json
A first-time contributor can make that section more useful by adding a short expected-output note.
Scope
Docs-only change in examples/README.md.
Please add 2-4 sentences or bullets under JSON CLI checks for automation that explain what a reader should expect from the JSON output, for example:
browsertrace doctor --json prints local install and trace-store status.
browsertrace list --status failed --json prints recent failed runs as JSON with run IDs and status.
browsertrace show <run_id> --json prints one run with run details and step timeline data.
Keep the note short and do not change CLI behavior.
Verification
Run at least:
uv run --python 3.11 --extra dev pytest tests/test_metadata.py -q
git diff --check
If you also run the CLI manually, include the commands in the PR description.
Acceptance criteria
examples/README.md has a concise expected-output note below the JSON CLI checks.
- The note mentions
doctor --json, list --status failed --json, and show <run_id> --json.
- No runtime code changes are made.
- Verification commands are included in the PR description.
Context
The examples README has a
JSON CLI checks for automationsection with these commands:A first-time contributor can make that section more useful by adding a short expected-output note.
Scope
Docs-only change in
examples/README.md.Please add 2-4 sentences or bullets under
JSON CLI checks for automationthat explain what a reader should expect from the JSON output, for example:browsertrace doctor --jsonprints local install and trace-store status.browsertrace list --status failed --jsonprints recent failed runs as JSON with run IDs and status.browsertrace show <run_id> --jsonprints one run with run details and step timeline data.Keep the note short and do not change CLI behavior.
Verification
Run at least:
If you also run the CLI manually, include the commands in the PR description.
Acceptance criteria
examples/README.mdhas a concise expected-output note below the JSON CLI checks.doctor --json,list --status failed --json, andshow <run_id> --json.