b8e audit
Run an accessibility audit
Options
Section titled “Options”| Option | Takes | Default | Description |
|---|---|---|---|
--project <id> | value | project id to audit (default: the one b8e project selected) | |
--journeys <ids> | value | comma-separated journey ids (or all for every journey) | |
--group <id|name> | value | audit the journeys in a group, by id or name | |
--build-target <release/dist> | value | mobile only: override the release/dist read off the device with this build target (e.g. 1.4.0/a1b2c3, the commit-SHA dist only a CI caller knows) | |
--device <serial|model> | value | mobile only: the Android device to drive — an attached device by serial or model, or a stopped AVD by name, which an interactive run boots and a non-interactive one refuses (default: ANDROID_SERIAL, or the sole attached device) | |
-f, --format <format> | value | pretty | output format |
--fail-on <severity> | value | minimum finding severity that fails the run | |
-o, --output <file> | value | write the payload to a file instead of stdout | |
--timeout <duration> | value | audit timeout (e.g. 30s, 10m) | |
--max-violations <n> | value | fail when the violation count exceeds this | |
--ci | boolean | non-interactive CI mode (requires —journeys and a selected project) | |
--headless | boolean | run the audit browser headless (default) | |
--no-headless | negation | show the audit browser window |
b8e audit --help
Section titled “b8e audit --help”Identical to what the terminal prints — both are rendered from the same commander definition.
Usage: b8e audit [options] [command]
Run an accessibility audit
Options: --project <id> project id to audit (default: the one `b8e project` selected) --journeys <ids> comma-separated journey ids (or `all` for every journey) --group <id|name> audit the journeys in a group, by id or name --build-target <release/dist> mobile only: override the release/dist read off the device with this build target (e.g. 1.4.0/a1b2c3, the commit-SHA dist only a CI caller knows) --device <serial|model> mobile only: the Android device to drive — an attached device by serial or model, or a stopped AVD by name, which an interactive run boots and a non-interactive one refuses (default: ANDROID_SERIAL, or the sole attached device) -f, --format <format> output format (choices: "pretty", "json", "sarif", default: "pretty") --fail-on <severity> minimum finding severity that fails the run (choices: "critical", "serious", "moderate", "minor") -o, --output <file> write the payload to a file instead of stdout --timeout <duration> audit timeout (e.g. 30s, 10m) --max-violations <n> fail when the violation count exceeds this --ci non-interactive CI mode (requires --journeys and a selected project) --headless run the audit browser headless (default) --no-headless show the audit browser window -h, --help display help for command
Commands: stop <run-id> stop a running audit list|ls [options] list auditable journeys
EXAMPLES # Audit every journey in the selected project $ b8e audit --journeys all
# What can I audit? $ b8e audit list
# End a run that is still going $ b8e audit stop run_123
INHERITED FLAGS --org <id|slug|name> organization context [$BINCLUSIVE_ORG_ID] -y, --yes skip all prompts and accept defaults --non-interactive never prompt; fail instead of asking --progress <mode> how progress is reported -q, --quiet suppress progress output (same as --progress quiet) --no-color disable color -v, --verbose verbose diagnostics -V, --version print the CLI version -h, --help show help for command