a11y-scan-tool
v1.0.12
Published
A CLI and web service to check web accessibility using Puppeteer and Axe-core.
Maintainers
Readme
Accessibility Analyzer ♿
An automated tool to scan any live website—including local development servers—for accessibility issues. This project provides both a powerful command-line interface (CLI) for developers and a user-friendly web application for quick scans.
This tool helps you find and fix accessibility issues, ensuring your digital content is usable by everyone, including people with disabilities.
Key Features
- Comprehensive Audits: Powered by the industry-standard Axe-core engine.
- Scan Any Live URL: Analyze any public website or a project running on your
localhost. - Dual Interface: A feature-rich CLI for developers and an easy-to-use Web App.
- Multiple Output Formats:
- Clean, color-coded summary table in the terminal.
- Downloadable PDF reports.
- Machine-readable JSON output for integrations.
Installation (CLI)
To use the command-line tool, install it globally via NPM:
npm install -g a11y-scan-toolUsage
Command-Line Interface (CLI)
The CLI is perfect for integrating accessibility scanning into your development workflow.
Basic Syntax
a11y-scan <url> [options]<url>: A live URL, such ashttps://example.comorhttp://localhost:3000.
Examples
1. Scan a live URL (default summary view):
a11y-scan [https://www.w3.org/WAI/demos/bad/](https://www.w3.org/WAI/demos/bad/)2. Scan a local development server:
a11y-scan http://localhost:30003. Generate a PDF report with a custom filename:
a11y-scan [https://example.com](https://example.com) --pdf -o my-report.pdf4. Get the raw JSON output for scripting:
a11y-scan [https://example.com](https://example.com) --jsonWeb Application (In Development)
Please note: The web application is currently under active development and is not yet feature-complete. The instructions below are for developers interested in the project's progress.
- Clone the repository.
- Install dependencies for both the
frontendandbackenddirectories. - Start the server from the
backenddirectory:npm start - Open your browser to the local address (e.g.,
http://localhost:5000) to view the web interface.
Technology Stack
- Core Engine: Axe-core
- Browser Automation: Puppeteer
- Backend & Server: Node.js, Express.js
- Frontend: React, React Router
- CLI Framework: Yargs
- PDF Generation: PDFKit
License
This project is licensed under the MIT License.
