Skip to content
a11y-ci

Getting Started

Prerequisites

Section titled “Prerequisites”
  • Python 3.11+
  • a11y-lint for generating scorecards

Install

Section titled “Install”
Terminal window
pip install a11y-ci

Generate a scorecard

Section titled “Generate a scorecard”

a11y-ci consumes JSON scorecards produced by a11y-lint:

Terminal window
a11y-lint scan output.txt --json > a11y.scorecard.json

Gate on the scorecard

Section titled “Gate on the scorecard”
Terminal window
# Fail on serious+ findings (default)
a11y-ci gate --current a11y.scorecard.json


# Fail on moderate+ findings
a11y-ci gate --current a11y.scorecard.json --fail-on moderate

Detect regressions with a baseline

Section titled “Detect regressions with a baseline”
Terminal window
a11y-ci gate \
  --current a11y.scorecard.json \
  --baseline baseline/a11y.scorecard.json

The gate fails if the serious+ count increases or new serious+ finding IDs appear.

Suppress known issues temporarily

Section titled “Suppress known issues temporarily”
Terminal window
a11y-ci gate \
  --current a11y.scorecard.json \
  --allowlist a11y-ci.allowlist.json

Expired allowlist entries automatically fail the gate.