gitwtfhub

wtf is a11y?

addyosmani/a11y — explained in plain English

Analysis updated 2026-08-02 · repo last pushed 2018-04-20

1,722JavaScriptAudience · developerComplexity · 2/5DormantSetup · moderate

TL;DR

A11y is a command-line tool that checks websites for accessibility problems like missing image descriptions and poor color contrast, helping developers fix issues before users encounter them.

Mindmap

mindmap
  root((repo))
    What it does
      Checks websites for a11y issues
      Reports pass fail or NA
      Supports multiple URLs
    How you use it
      Run via command line
      Use as JavaScript module
      Save results to file
    Tech stack
      JavaScript
      Headless browser
      Chrome audit rules
    Use cases
      Pre-release accessibility checks
      Local static site testing
      Compliance audits
    Limitations
      Best for static sites
      Complex JS apps limited support
      Needs manual PhantomJS install

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Why would anyone build with this?

REASON 1

Run an accessibility audit on your staging site before each release to catch issues early.

REASON 2

Point the tool at local HTML files to get immediate feedback while building static sites.

REASON 3

Integrate accessibility checks into a Grunt-based build workflow so tests run automatically.

REASON 4

Audit multiple URLs at once and save the results to a file for team review.

What's in the stack?

JavaScriptPhantomJSGrunt

How it stacks up

addyosmani/a11ystephengrider/redux-codestemdeckapp/stemdeck
Stars1,7221,7391,836
LanguageJavaScriptJavaScriptJavaScript
Last pushed2018-04-202022-12-102026-06-30
MaintenanceDormantDormantMaintained
Setup difficultymoderateeasymoderate
Complexity2/51/52/5
Audiencedeveloperdevelopergeneral

Figures from each repo's GitHub metadata at analysis time.

How do you spin it up?

Difficulty · moderate Time to first run · 5min

Relies on PhantomJS, which may require manual installation if the automatic setup fails.

Wtf does this do

A11y is a command-line tool that checks your website for accessibility problems, things like missing image descriptions, poor color contrast, or HTML structure that makes it hard for screen readers to navigate. You give it a URL or a local HTML file, and it produces a report telling you what passed, what failed, and what needs fixing. You install it globally and run a simple command like pointing it at a website address. It loads the page using a headless browser, runs Google Chrome's accessibility audit rules against it, and spits out results. Each check comes back as PASS, FAIL, or NA (meaning the rule didn't apply because the relevant elements weren't on the page). You can audit multiple URLs at once, save results to a file, adjust the viewport size to test different screen dimensions, or add a delay before the audit runs to let dynamic content load. Beyond the command line, developers can also use it as a JavaScript module to run audits programmatically and work with the structured results. This is useful for web developers, designers, and product teams who want to catch accessibility issues early, before users with disabilities encounter them or before a compliance audit flags them. For example, if you're building a marketing site, you could run it against your staging URL before each release. If you're working on a static site locally, you can point it at your local files and get immediate feedback. The project is currently most reliable for static sites. The team is still working on robust support for complex JavaScript applications built with frameworks like React or Angular, where content loads dynamically. It integrates with Grunt-based build setups, and a companion tool exists for that workflow. One caveat: it relies on PhantomJS under the hood, which occasionally needs manual installation if the automatic setup fails.

Yoink these prompts

Prompt 1
Install the A11y CLI tool globally and run an accessibility audit on my website at https://example.com, show me what passed and failed.
Prompt 2
Write a Node.js script that uses A11y as a module to audit three URLs, save the structured results to a JSON file, and log a summary of failures.
Prompt 3
Set up A11y to audit my local static HTML file with a 3-second delay to let dynamic content load, and adjust the viewport to 375px width to test mobile.
Prompt 4
Help me integrate A11y into my Grunt build process so accessibility checks run automatically every time I build my project.
Prompt 5
Run A11y against multiple pages of my site and explain which accessibility failures are most critical to fix first.

Frequently asked questions

wtf is a11y?

A11y is a command-line tool that checks websites for accessibility problems like missing image descriptions and poor color contrast, helping developers fix issues before users encounter them.

What language is a11y written in?

Mainly JavaScript. The stack also includes JavaScript, PhantomJS, Grunt.

Is a11y actively maintained?

Dormant — no commits in 2+ years (last push 2018-04-20).

How hard is a11y to set up?

Setup difficulty is rated moderate, with roughly 5min to a first successful run.

Who is a11y for?

Mainly developer.

View the repo → Decode another repo

This repo across BitVibe Labs

Don't trust strangers blindly. Verify against the repo.