b8e audit
Run an accessibility audit
Options
Section titled “Options”| Option | Takes | Default | Description |
|---|---|---|---|
--viewport <value> | value | web only: Desktop uses the full screen; Tablet and Mobile load the mobile layout with touch. Choices: Desktop · full screen, Laptop · 1280 × 800, Tablet · 768 × 1024, Mobile · 390 × 844. Default: desktop. | |
--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 <device> | value | mobile only: the device to drive. Android: 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). iOS: an iPhone or a simulator by name or UDID (default: BINCLUSIVE_IOS_DEVICE, or the one ready iPhone or booted simulator, else a simulator that can run VoiceOver, iPhone first) | |
--recheck | boolean | replay this journey’s tickets that are ready for re-check | |
-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 | |
--cloud | boolean | run on Binclusive’s cloud runners instead of this machine: prints the run ids, then follows the runs to a verdict (—timeout and —headless apply to local runs only) | |
--resume | boolean | android and ios, local only: start from the screen the app under test already shows, instead of relaunching it | |
--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: --viewport <value> web only: Desktop uses the full screen; Tablet and Mobile load the mobile layout with touch. Choices: Desktop · full screen, Laptop · 1280 × 800, Tablet · 768 × 1024, Mobile · 390 × 844. Default: desktop. (choices: "desktop", "laptop", "tablet", "mobile") --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 <device> mobile only: the device to drive. Android: 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). iOS: an iPhone or a simulator by name or UDID (default: BINCLUSIVE_IOS_DEVICE, or the one ready iPhone or booted simulator, else a simulator that can run VoiceOver, iPhone first) --recheck replay this journey’s tickets that are ready for re-check -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 --cloud run on Binclusive's cloud runners instead of this machine: prints the run ids, then follows the runs to a verdict (--timeout and --headless apply to local runs only) --resume android and ios, local only: start from the screen the app under test already shows, instead of relaunching it --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 [options] <run-id> Cancel an accessibility audit. A queued request and every run in it are cancelled before dispatch. A dispatched or local run records a stop request that the executor honours at its next contact. Refuses callers outside the run's organization.
EXAMPLES # Audit every journey in the selected project $ b8e audit --journeys all
# Run it on Binclusive's cloud runners: prints the run ids, then follows them to a verdict $ b8e audit --journeys jrn_123 --cloud
# Android: audit from the screen you already opened, without relaunching the app $ b8e audit --journeys jrn_123 --resume
# 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