a11ywatch-cli

The A11yWatch Command Line Interface. View the cli-docs for more complete info.

Build

Get the CLI by running the command below.

sh cargo install a11ywatch_cli

Then run a11ywatch -h to get all options.

```sh

start the instance. If you need the front-end client passing the -f option [min of 1.25gb of memory required alloc to docker resource]

a11ywatch start

scan a url and pipe the stdout to a file

a11ywatch scan --url https://a11ywatch.com > results.json

scan a website multi page and pipe the stdout to a file

a11ywatch crawl --url https://a11ywatch.com > results.json

if you need to upgrade the instance to new images run with the upgrade flag.

a11ywatch start --upgrade

start the instance with the front-end on port 3270.

a11ywatch start -f ```

If you experience issues the cargo install a11ywatch_cli command, try running rustup update stable to make sure your cargo version is up to date.

ENV

Here are env vars that you can configure to enhance the system abilities. You can get your Computer Vision API key here. Grab your PageSpeed API key to speed up lighthouse parallel runs.

Example of a .env file below:

COMPUTER_VISION_SUBSCRIPTION_KEY="REPLACE_WITH_KEY" COMPUTER_VISION_ENDPOINT="REPLACE_WITH_ENDPOINT" PAGESPEED_API_KEY="REPLACE_WITH_PAGESPEED_API_KEY"

You can also use the CLI to configure your Computer Vision creditials.

```sh

replace $mycv_token and $myvcvname with your project name and CV API url

a11ywatch --set-cv-token $mycv_token a11ywatch --set-cv-url https://$myvcvname.cognitiveservices.azure.com/ ```

Supported Architectures

Mac, linux, and Windows.

BETA

The following commands are currently in BETA and require you to have the repo locally tf-provider and set to your directory.

1. deploy (TERRAFORM)
2. destroy (TERRAFORM)

The scan sub command with the runner option and the remote deployment commands are a work in progress. You may experience issues with the sub commands, feel free to leave an issue when found. In general the CLI is in BETA and may contain breaking changes until v1.