Getting Started
a11yst is a local CLI for web accessibility testing. It audits real pages in a browser, applies a11yst-owned profile checks, and writes structured artifacts for review and CI.
Automated checks do not establish accessibility conformance. Manual accessibility review remains necessary.
Installation¶
When @a11yst/cli is published:
pnpm add -D @a11yst/cli
pnpm exec playwright install chromium
Until then, install from a local or workspace build. Chromium is managed by Playwright; a11yst does not download browsers during package installation.
Quick start¶
a11yst init
a11yst detect
a11yst audit
Start with a small route set and the default profile. The URL in a11yst.config.ts (devServer or baseUrl) must match a running app or preview.
Findings use severity labels MINOR, MEDIUM, HIGH, and CRITICAL (never color alone). Use JSON for automation and HTML or Markdown for review.