A11YSmith Documentation

Where to go

A11YSmith has four surfaces, each with a distinct purpose. Use the one that matches what you need to do.

• Dashboard

  Review audit findings, compare runs, examine severity and standards mapping, and complete manual review tasks.

  Dashboard home page

• Workbench

  Create and manage audit runs across web, Android, and iOS. Upload artifacts, configure auth profiles, and trigger reruns.

  Separate app on port 4322

• Documentation

  Learn what A11YSmith is, how it is organized, how to use the CLI, and where to find deeper reference material.

  Docs section within the dashboard

• Desktop App

  Create audits, review findings, access tools, and manage settings in a native Electron desktop experience for consultants.

  Electron app launched from Finder or pnpm desktop-app dev

Start here

• Getting Started — install the CLI and run your first audit
• Workbench Setup — set up the consultant GUI for web and native audits
• Architecture — understand the package structure and data flow
• Rules Catalog — browse detection rules by platform

How it works

A11YSmith processes source code, CI artifacts, and documents through a pipeline of evidence collectors, a rule engine, and a verdict engine to produce structured accessibility findings.

Source Code / Artifacts / Documents
        |
        v
Evidence Collectors  (parse HTML, XML, Swift, Kotlin, OOXML, PDF)
        |
        v
Rule Engine  (match evidence against rule definitions)
        |
        v
Findings  (severity, confidence, WCAG mapping, remediation)
        |
        v
Verdict Engine  (aggregate pass/fail/review-needed)
        |
        v
Reporter  (JSON / Markdown / HTML / CSV)