README.md

A11y Audit

Command Line Interface for Automated Accessibility Auditing of Websites

Introduction

A CLI tool that tests websites for Accessibility Issues and generates reports that can be assigned to developers.

• Support for Continuous Integration Testing
• Save Reports in CSV, HTML, Jira, JSON, Markdown & XML Formats
• Supports Page Automation using Actions
• Supports Testing Websites behind HTTP Authentication
• Reports provide Resource Links for Developers to Learn More about Accessibility

Developer Overview

Commands

• a11y-audit - Detailed Examples of a11y-audit Usage
• a11y-audit auth - Generate HTTP Authentication Tokens
• a11y-audit help - Get Help when you need it

Additional Information

• Automate with Actions - Submit Forms, Click Links & Other Fun Things
• Troubleshooting - Some of the Known Issues & how to resolve them

Install

Requirements

• Node v10+

git clone

cd ~
git clone https://github.com/bell-lab-apps/a11y-audit.git
cd a11y-audit
npm install -g
a11y-audit help

Report Samples

I've worked extensively to make the most helpful reports possible. Whether you are running a test on a single ite, or need to batch multiple tests into a single reports, I wanted to make our reports as developer friendly as possible.

Since this is a CLI tool, the default output is in a terminal window.

_Built using pa11y.