Command Line Options
The A11yWatch CLI is an easy way to get started with running, deploying, and testing web accessibility.
- Rust is required.
- Docker is required if you are not building locally.
- Nodejs is required for local installs.
If you are on Ubuntu OpenSSL is required:
apt-get update && apt upgrade -y && apt-get install -y --no-install-recommends build-essential gcc cmake libc6 libssl-dev pkg-config
You can get the CLI using
cargo or npm.
cargo install a11ywatch_clior
npm i a11ywatch-cli -g
You can run the
a11ywatch -h command to get all the options and details for the CLI.
A11yWatch web accessibility CLI.
a11ywatch [OPTIONS] [SUBCOMMAND]
Log file results path
Get the apps tmp directory location
Get github API endpoint of project
Log file results github path
Print help information
Get results file parsed to json
Get results file parsed as report list of passed / failed
Get the total amount of issues between errors,warning,notice that occurred for the
Get the total amount of issues of type error from result set
Get the total amount of issues of type warning from result set
Get results of the github html message
-s, --set-token <SET_TOKEN>
Set the API token to use for request
Set the Computer Vision API token to use for request
Set the Computer Vision API endpoint to use for request
Print version information
build Build the project on the local machine [defaults to docker runtime]
crawl Site wide scan a website url for issues
extract Extract results in formats for platforms
help Print this message or the help of the given subcommand(s)
scan Single page scan a website url for issues
start Start the application on the local machine [defaults to docker runtime]
stop Stop the project on the local machine [defaults to docker runtime]
To get started scanning your website with the CLI run the following commands.
# pass -f option to start with the front-end
# single page scan and store results
a11ywatch scan --url https://a11ywatch.com -s
# full multi site crawl
a11ywatch crawl --url https://a11ywatch.com -s -d
# full site wide crawl with subdomains and TLDS
a11ywatch crawl --url https://a11ywatch.com -s -d --subdomains --tld
If you want to display detailed reports on the last scan run
a11ywatch --results-parsed-list, the prior run also needs the
-s flag to store results. This will bring up the last scan with pass/fail reports for each page.
-d flag in order to enable real time log output of pages completed.
The command line gives you the ability to get code fixes right into your project after a scan using the
Run the following:
a11ywatch crawl --url https://a11ywatch.com -s -d --fix