Pa11y CLI Reporter
The default command-line reporter for Pa11y 5.0.
⚠️ this reporter is built into Pa11y, there's no need to install separately ⚠️
Table Of Contents
Pa11y CLI Reporter is compatible with Pa11y 5 and later versions. It will not work with older versions of Pa11y.
|Pa11y version||Pa11y CLI reporter version|
|1.x - 4.x||Unsupported|
Install Pa11y and Pa11y CLI Reporter with npm (locally or globally is fine):
npm install -g pa11y pa11y-reporter-cli
Run Pa11y using the CLI reporter:
pa11y --reporter cli http://example.com
Assuming you've installed both Pa11y and Pa11y CLI Reporter:
const cli = ;const pa11y = ;;
There are many ways to contribute to Pa11y CLI Reporter, we cover these in the contributing guide for this repo.
If you're ready to contribute some code, clone this repo locally and commit your code on a new branch.
Please write unit tests for your code, and check that everything works by running the following before opening a Pull Request:
You can also run verifications and tests individually:
make verify # Verify all of the code (ESLint)make test # Run all testsmake test-unit # Run the unit testsmake test-unit-coverage # Run the unit tests with coverage
Pa11y CLI Reporter is licensed under the Lesser General Public License (LGPL-3.0).
Copyright © 2017, Team Pa11y