Scanning
Run scans locally, in CI, or as a pre-commit hook. All CLI flags for the scan command.
Basic usage
equall scan [path]path defaults to the current directory. Exit codes:
| Exit | Meaning |
|---|---|
0 | Score ≥ 50 (scan OK) |
1 | Score < 50 (scan failed) |
2 | Runtime error (invalid path, scanner crash, etc.) |
Flags
| Flag | Description | Default |
|---|---|---|
-l, --level <level> | WCAG conformance target: A, AA, or AAA | AA |
--include <patterns...> | Glob patterns to include | (auto) |
--exclude <patterns...> | Glob patterns to exclude | (auto) |
--json | Emit machine-readable JSON to stdout (log goes to stderr) | |
-i, --show-ignored | Include ignored issues in the output | |
-v, --verbose | Show all occurrences for best-practice issues | |
-m, --show-manual | List WCAG criteria that require manual review | |
--no-color | Disable ANSI colors | |
--no-readability | Skip the Flesch-Kincaid reading-grade scanner |
Common recipes
Target Level A only
equall scan ./public --level AExport a JSON report
equall scan . --json > report.jsonScope to a subfolder
equall scan . --include "src/**"Run in CI (fail the build if score < 50)
# .github/workflows/a11y.yml
- run: npx equall-cli scan . --level AASkip readability checks for non-English projects
equall scan . --no-readabilityIgnore subcommand
Managing inline equall-ignore comments also ships with a dedicated subcommand — see Ignore system.