Skip to content

b8e audit

Run an accessibility audit

OptionTakesDefaultDescription
--project <id>valueproject id to audit
--journeys <ids>valuecomma-separated journey ids (or all for every journey)
--group <id|name>valueaudit the journeys in a group, by id or name
--format <pretty|json|sarif>valueoutput format
--fail-on <critical|serious|moderate|minor>valueminimum severity that fails the run
--org <id|slug|name>valueorganization context (id, slug, or name)
--output <path>valuewrite json/sarif output to a file (default: stdout)
--timeout <ms>valueaudit timeout, in milliseconds
--max-violations <n>valuefail when the violation count exceeds this
--cibooleannon-interactive CI mode (requires —project and —journeys)
--verbosebooleanverbose diagnostics

Identical to what the terminal prints — both are rendered from the same commander definition.

Usage: b8e audit [options]
Run an accessibility audit
Options:
--project <id> project id to audit
--journeys <ids> comma-separated journey ids (or `all` for every journey)
--group <id|name> audit the journeys in a group, by id or name
--format <pretty|json|sarif> output format
--fail-on <critical|serious|moderate|minor> minimum severity that fails the run
--org <id|slug|name> organization context (id, slug, or name)
--output <path> write json/sarif output to a file (default: stdout)
--timeout <ms> audit timeout, in milliseconds
--max-violations <n> fail when the violation count exceeds this
--ci non-interactive CI mode (requires --project and --journeys)
--verbose verbose diagnostics
-h, --help display help for command