Quick Start Guide

From zero to your first accessibility scan in under 5 minutes.

Create your account

Head to app.aulys.app/signup and create a free account. No credit card required for the free tier (up to 25 pages/month).

✓ What you get on the free plan:

• 25 page scans per month
• 1 project
• WCAG 2.1 A/AA reports
• 7-day result retention

Create a project

A Project groups scans for a single website or web app. Go to the Dashboard and click New Project.

Project settings

Project Name:   My Website
Base URL:       https://example.com
WCAG Level:     AA (recommended)
Scan Depth:     Full site (auto-discover pages)

The Base URL is used as the starting point for site-wide crawls. Individual scan URLs can be overridden later.

Run your first scan

Click New Scan inside your project, enter the URL you want to test, and hit Start Scan. Results appear in 10–60 seconds depending on page complexity.

API / cURL equivalent

curl -X POST https://api.aulys.app/v1/scans \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "wcagVersion": "2.2",
    "wcagLevel": "AA"
  }'

Review results

The results page shows violations grouped by severity — Critical, Warning, and Info. Each issue includes:

The affected HTML element and its selector
Which WCAG criterion it violates (e.g. 1.4.3 Contrast)
An AI-generated explanation of why it matters
A code fix suggestion you can copy
Links to WCAG documentation for that criterion

(Optional) Add to CI/CD

The most impactful setup is to run Aulys on every pull request so accessibility regressions are caught before they merge. Use the GitHub Action or our API.

.github/workflows/accessibility.yml

name: Accessibility Check
on: [pull_request]

jobs:
  a11y:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Run Aulys Scan
        uses: aulys-app/scan-action@v2
        with:
          api-key: ${{ secrets.AULYS_API_KEY }}
          url: https://staging.example.com
          fail-on: critical

See the full GitHub Actions guide for advanced configuration options.

What to read next

WCAG 2.2 Reference

Understand every criterion you might violate.

Read

GitHub Actions

Block PRs with new violations.

Read

Compliance Reports

Generate VPAT and EAA statements.

Read

curl -X POST https://api.aulys.app/v1/scans \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "url": "https://example.com", "wcagVersion": "2.2", "wcagLevel": "AA" }'

name: Accessibility Check on: [pull_request] jobs: a11y: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - name: Run Aulys Scan uses: aulys-app/scan-action@v2 with: api-key: ${{ secrets.AULYS_API_KEY }} url: https://staging.example.com fail-on: critical