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		crawl budget: maximum pages to visit
--max-depth <n>	value		crawl budget: maximum link depth from the seed
--format <format>	value	pretty	output format: pretty | json | sarif
--output <path>	value		write json/sarif output to a file (default: stdout)
--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
  --max-depth <n>    crawl budget: maximum link depth from the seed
  --format <format>  output format: pretty | json | sarif (default: "pretty")
  --output <path>    write json/sarif output to a file (default: stdout)
  --timeout-ms <n>   per-page navigation/analysis timeout, in milliseconds
  -h, --help         display help for command