@qashifthq/clearpath
v0.1.3
Published
Clearpath CLI — run accessibility checks in your CI and post per-deploy regression diffs to your pull requests.
Downloads
548
Maintainers
Readme
@qashifthq/clearpath
The Clearpath CLI runs accessibility checks inside your CI and posts a per-deploy regression diff to Clearpath, keyed by commit SHA. Because the checks run in your pipeline, your paid usage is flat and unlimited — we never run a browser for you.
Usage
npx @qashifthq/clearpath scan \
--urls https://preview.example.com,https://preview.example.com/pricing \
--token $CLEARPATH_INGEST_TOKENRequires a Chromium browser (npx playwright install chromium) available in the
runner. Commit/branch/PR are auto-detected from standard CI env vars.
Options
| Flag | Env fallback | Default |
|---|---|---|
| --urls | CLEARPATH_URLS | — (required) |
| --token | CLEARPATH_INGEST_TOKEN | — (required) |
| --api | CLEARPATH_API_URL | Clearpath cloud |
| --commit | GITHUB_SHA | local |
| --branch | GITHUB_REF_NAME | main |
| --pr | CLEARPATH_PR | none |
Exits non-zero when the project's merge-blocking policy is triggered, so the CI job fails on accessibility regressions.
For GitHub specifically, prefer the qashift/clearpath-action.
