Getting Started

Prerequisites

Node.js 22 or later
pnpm 9 or later

Installation

Clone the repository and install dependencies:

git clone https://github.com/HNguyenLy/A11YSmith.git && cd A11YSmith

pnpm install

Build all packages and link the CLI locally:

pnpm turbo build

cd packages/cli && pnpm link --global

After linking, the a11ysmith command is available globally. Alternatively, run commands directly from the monorepo with pnpm --filter @a11ysmith/cli exec.

Quick Start

Web Audit

Scan a live web page for accessibility issues:

a11ysmith audit-web --url https://example.com --format html

Document Audit

Scan Office documents or PDFs for accessibility issues:

a11ysmith audit-document --file report.docx --format json

Markdown Audit

Scan markdown documentation for accessibility issues:

a11ysmith audit-markdown --dir ./docs --format markdown

Android Source Audit

Scan an Android project's source code for accessibility issues:

a11ysmith audit-android-source --source ./my-android-app/app/src/**/*.xml ./my-android-app/app/src/**/*.kt --format json

iOS Source Audit

Scan an iOS project's source code for accessibility issues:

a11ysmith audit-ios-source --source ./my-ios-app/**/*.swift --format markdown

Agent Ecosystem Setup

Set up AI accessibility agents for your coding platform:

a11ysmith agent-init

a11ysmith agent-generate --platform claude-code

Example Output

After running an audit, A11YSmith produces a structured report listing each finding with its title, severity, confidence, WCAG mapping, and suggested fix. Reports can be generated in JSON, Markdown, or HTML format.

{
  "summary": {
    "total": 12,
    "highest": 2,
    "high": 4,
    "medium": 3,
    "low": 3
  },
  "findings": [
    {
      "finding_id": "a1b2c3d4-...",
      "title": "Image missing alt attribute",
      "summary": "An <img> element has no alt attribute, making it inaccessible to screen readers.",
      "severity": "highest",
      "confidence": "high",
      "wcag_sc_ids": ["1.1.1"],
      "suggested_fix": "Add a descriptive alt attribute to the image."
    }
  ]
}