webaim-wave

1.0.1 • Public • Published

CLI for WebAIM Wave Accessibility Audit tool

Setup

To use the CLI, you must sign up for a WebAim WAVE CLI API key

  1. Create an .env file
  2. Add the key API_KEY={api key value}
    • Ex: API_KEY=thisisyourkey
  3. Pass the .env file path with the --envPath flag

Flags

All flags are prepended with --

  • --envPath: Used to designate where the .env file lives. The default is the current working directory.
  • --url: URL to run the Wave accessibility tools against. Required
  • --output: location where to put the exported JSON file. The default location is the current working directory.

Example commands

webaim-wave --url=https://google.com --envPath=config/.env

webaim-wave --url=https://amazon.com --output=wave/output

Package Sidebar

Install

npm i webaim-wave

Weekly Downloads

2

Version

1.0.1

License

ISC

Unpacked Size

2.86 kB

Total Files

3

Last publish

Collaborators

  • acjanus