Documentation

Clearpath catches accessibility regressions on every deploy and tells your team exactly what got worse — right inside the pull request. Set up takes about a minute.

What you get

• • Per-deploy regression diffs keyed to your commit SHA — new, worsened, and fixed issues since the last deploy.
• • A PR status check + inline comment on every commit, with optional merge-blocking.
• • A live README badge showing your current accessibility score.
• • Trend history and a shareable, indexable public report for any URL.
• • Anti-overlay detection — we flag sites masking issues with overlay widgets instead of fixing them.

Quickstart (60 seconds)

1. 1. Create an account and a project.
2. 2. Copy the project's ingest token and add it as a CI secret named CLEARPATH_INGEST_TOKEN.
3. 3. Add the GitHub Action (below) or the CLI to your pipeline, pointed at your preview URL(s).
4. 4. Open a PR — the check and diff comment appear automatically.

GitHub Action

The fastest path on GitHub. The check runs in your runner, so usage stays flat and unlimited.

# .github/workflows/accessibility.yml
name: Accessibility
on: [pull_request]

jobs:
  clearpath:
    runs-on: ubuntu-latest
    steps:
      - uses: qashift/clearpath-action@v1
        with:
          urls: ${{ env.PREVIEW_URL }}   # or a comma-separated list
          token: ${{ secrets.CLEARPATH_INGEST_TOKEN }}

CLI (any CI)

Not on GitHub? The CLI runs anywhere Node and Chromium are available.

npx playwright install chromium
npx @qashifthq/clearpath scan \
  --urls https://preview.example.com,https://preview.example.com/pricing \
  --token $CLEARPATH_INGEST_TOKEN

Commit, branch, and PR number are auto-detected from standard CI env vars. The command exits non-zero when your merge-blocking policy is triggered.

PR bot & merge-blocking

Install the Clearpath GitHub App on your repository, then paste the installation ID into your project settings. On every commit Clearpath posts a Check Run and an upserted PR comment with the diff. Choose a policy:

• • off — report only.
• • new — fail when new violations appear.
• • new_or_worsened — fail on new or worsened (recommended).

README badge

Set a project to public in settings, then embed:

![Accessibility](https://clearpath-sandy.vercel.app/badge/<projectId>.svg)

Plans & limits

Free covers a single project and homepage scans. Paid plans unlock more projects, more pages per scan, the PR bot, badges, and longer trend history. See pricing.

FAQ