Skip to content

CLI Commands

Check for accessibility issues.

Terminal window
a11y-lint scan [OPTIONS] INPUT
OptionDescription
--stdinRead from stdin instead of file
--color [auto|always|never]Color output mode (default: auto)
--jsonOutput results as JSON
--format [plain|json|markdown]Output format
--disable RULEDisable specific rules (can repeat)
--enable RULEEnable only specific rules (can repeat)
--strictTreat warnings as errors

Validate JSON messages against the CLI error schema.

Terminal window
a11y-lint validate messages.json
a11y-lint validate -v messages.json # Verbose output

Generate an accessibility scorecard.

Terminal window
a11y-lint scorecard output.txt
a11y-lint scorecard --json output.txt # JSON output
a11y-lint scorecard --badge output.txt # shields.io badge

Generate a markdown report.

Terminal window
a11y-lint report output.txt
a11y-lint report output.txt -o report.md
a11y-lint report --title="My Report" output.txt

Show available rules.

Terminal window
a11y-lint list-rules # Simple list
a11y-lint list-rules -v # Verbose with categories and WCAG refs

Print the JSON schema for CLI error messages.

Terminal window
a11y-lint schema