Run a scan on your machine

If you want to check a project for accessibility findings before you push, scan it locally.

From the project root:

b8e scan .

b8e walks the source and prints a report grouped by file. Each entry names the rule that fired and the WCAG success criterion it maps to.

To scan a subdirectory instead of the whole project, pass its path:

b8e scan ./src/components

If you want machine-readable output — to pipe into another tool, or to read a finding’s exact selector and criterion — ask for JSON:

b8e scan . --format json

To write that output to a file instead of stdout, add --output:

b8e scan . --format json --output findings.json

If you want to scan a live page rather than source, pass --url. Repeat or comma-separate it to aggregate several pages into one report:

b8e scan --url https://example.com/ --url https://example.com/pricing

A local scan never contacts the Binclusive API and never gates your build — it exits 0 whether or not it finds anything. To fail a build on findings, use b8e ci instead.

For every flag b8e scan accepts, see the scan reference. For what the scanner checks, see the rules catalog.