Skip to content

AI ​

Automatica11y provides an evergreen bootstrap skill you can add to your agent of choice. Automatica11y cli bundles the latest version of the runner skill and its references, so every invocation is always compatible.

ai
---
name: automatica11y
compatibility: Needs Node 20 or newer, a shell that can run npx or the installed automatica11y command, and network access to the npm registry.
description: Test and compare web accessibility. Use when someone asks how accessible a web page, Storybook, or npm component library is, asks for an accessibility or WCAG check or audit, or asks to compare the accessibility of two or more sites or component libraries (for example "how accessible is Radix Dialog?" or "compare React Aria and Headless UI").
---

# automatica11y

automatica11y tests and compares web accessibility. This skill only gets you started. The full steps ship with the tool, so they always match its version.

1. Check `node --version`. It must be 20 or newer. If it isn't, tell the user and stop. If the command fails or prints no version number, tell the user that Node.js 20 or newer couldn't be verified, include the error text, and stop.
2. Keep the user's request as they gave it: the target or targets, and any settings they named, such as a WCAG version or level. You'll apply them after you read the guide.
3. Run this, read all of what it prints, and follow it:

   ```bash
   npx --yes automatica11y@latest guide skill
   ```

   If the error mentions `ETARGET` (npm says a version doesn't exist, usually because its local list is out of date), run the command once more with `--prefer-online`: `npx --yes --prefer-online automatica11y@latest guide skill`.

   If the command exits with an error or prints no usable output, including after that retry, tell the user it failed, include the error text, and stop. Don't continue with partial instructions.

   If `automatica11y` is already installed (`automatica11y --version` prints a version), you can run `automatica11y guide skill` instead. The steps check that the installed version matches them.

   After reading the steps, pass only settings they list as supported. If the user named a setting they don't list as supported, tell the user which setting is unsupported, list the supported values from the steps, and ask which to use. Don't ask again for anything they've already said.

4. If you can't run shell commands, or `npx` can't reach the npm registry, tell the user and stop. Don't guess at results.

Once the skill is installed in your agent you can prompt it with the same commands and flags that are available to the cli.

Audit a web page ​

You can audit web pages, static html files, Storybooks, and npm packages. To audit a live web page, simply provide the URL.

prompt
/automatica11y audit "https://instructure.design/"

Compare two packages ​

Automatica11y can compare two packages, even across different frameworks. It also supports versioning, sub-component exports, and aliases. Here's an example of comparing two different versions of a button from the same package:

prompt
/automatica11y compare next-gen=npm:@instructure/ui-button/Button/v2 canvas=npm:@instructure/ui-buttons/Button/v1

The runner skill and references guide the Agent on how to write custom fixtures, how to interpret results, and how to turn the machine results (report.json) into a human-readable templated report.

See Using it with an AI agent for additional details.

Released under the MIT License