b8e scan

Scan a path (or —url) for accessibility findings

Arguments

Argument	Kind	Default	Description
dir	optional	.	directory to scan (defaults to the current directory)

Options

Option	Takes	Default	Description
--url <url>	value	“	page URL to scan; repeat or comma-separate to aggregate pages into one site report
--story [id]	value	“	scan Storybook stories: bare scans every story, ids (repeat or comma-separate) scope a subset
--crawl	boolean		expand the single —url <seed> into a same-origin page set, then aggregate
--max-pages <n>	value	50	crawl budget: maximum pages to visit
--max-depth <n>	value	3	crawl budget: maximum link depth from the seed
--no-ignore	negation		also scan untracked files that .gitignore excludes
--install-browser	boolean		install Chromium if it is missing, instead of asking
-f, --format <format>	value	pretty	output format
-o, --output <file>	value		write the payload to a file instead of stdout
--no-upload	negation		do not send findings to the dashboard for this run
--timeout <duration>	value		per-page navigation/analysis timeout (e.g. 30s, 10m)
--timeout-ms <n>	value		per-page navigation/analysis timeout, in milliseconds

b8e scan --help

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

Usage: b8e scan [options] [dir]

Scan a path (or --url) for accessibility findings

Arguments:
  dir                    directory to scan (defaults to the current directory)
                         (default: ".")

Options:
  --url <url>            page URL to scan; repeat or comma-separate to aggregate
                         pages into one site report (default: [])
  --story [id]           scan Storybook stories: bare scans every story, ids
                         (repeat or comma-separate) scope a subset (default: [])
  --crawl                expand the single --url <seed> into a same-origin page
                         set, then aggregate
  --max-pages <n>        crawl budget: maximum pages to visit (default: 50)
  --max-depth <n>        crawl budget: maximum link depth from the seed
                         (default: 3)
  --no-ignore            also scan untracked files that .gitignore excludes
  --install-browser      install Chromium if it is missing, instead of asking
  -f, --format <format>  output format (choices: "pretty", "json", "sarif",
                         default: "pretty")
  -o, --output <file>    write the payload to a file instead of stdout
  --no-upload            do not send findings to the dashboard for this run
  --timeout <duration>   per-page navigation/analysis timeout (e.g. 30s, 10m)
  -h, --help             display help for command

EXAMPLES
  # Find accessibility problems in your code
  $ b8e scan ./src

  # Scan a live page, installing Chromium if it is missing
  $ b8e scan --url https://example.com --install-browser

  # Feed a script
  $ b8e scan ./src --format json | jq '.findings | length'

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