:robot: a11y-ai
Experimental tool to automatically detect accessibility issues in web pages using OpenAI and provide suggestions for fixing them.
Can I help fixing your a11y issues?
Quickstart
Run it directly on your project without installing it:
npx a11y-ai
It will scan for all HTML files in the current directory and subdirectories, and will interactively ask you to apply each suggestions found.
Installation
npm install -g a11y-ai
Usage
Usage: a11y <command> <files> [options]
If no files are specified, it will scan the current directory and
subdirectories for HTML files.
Commands:
s, scan Scan files for accessibility issues
f, fix Fix accessibility issues interactively
-y, --yes Apply fixes without prompting
-c, --char-diff Use character diff instead of patch-like diff
r, report Generate a report of issues and fix suggestions
-o, --format <format> Report format [html, md] (default: html)
General options:
--api Use specified API URL
--verbose Show detailed logs
--help Show this help
You can also set the API URL using the A11Y_AI_API
environment variable.
Automated reports
You can generate a report of all the issues found in your project automatically on your CI/CD using this GitHub Action: sinedied/a11y-ai-action
You can see a complete example workflow in action on this repository.