adibilis
v1.0.1
Published
Scan websites for WCAG 2.2 AA accessibility violations
Maintainers
Readme
Adibilis CLI
Scan websites for WCAG 2.2 AA accessibility violations.
Quick Start
# Scan any URL
npx adibilis scan https://your-site.com
# Scan with auto-fix suggestions
npx adibilis scan https://your-site.com --fix
# Fail CI if serious violations found
npx adibilis scan https://your-site.com --threshold serious --json
# Generate a full report
npx adibilis scan https://your-site.com --reportInstall
npm install -g adibilisCommands
adibilis scan <url>
Scan a URL for accessibility violations.
| Option | Description |
|--------|-------------|
| --fix | Show generated fix patches |
| --report | Generate HTML report and open in browser |
| --json | Output results as JSON (for CI integration) |
| --threshold <level> | Exit code 1 if violations exceed level (critical/serious/moderate/minor) |
| --api-key <key> | Adibilis API key (or ADIBILIS_API_KEY env var) |
| --pages <n> | Max pages to scan (default 1 for free, up to plan limit) |
| --ignore <rules> | Comma-separated rule IDs to ignore |
| --config <path> | Path to .adibilis.yml config file |
adibilis login
Authenticate with your Adibilis API key. The key is saved to ~/.adibilis/config.json.
adibilis init
Create a .adibilis.yml config file in the current directory.
Configuration
Create .adibilis.yml in your project root:
url: https://your-site.com
threshold: serious
ignore_rules:
- color-contrast
pages: 5CI/CD Integration
GitHub Actions
- run: npx adibilis scan $DEPLOY_URL --threshold serious --json
env:
ADIBILIS_API_KEY: ${{ secrets.ADIBILIS_API_KEY }}GitLab CI
accessibility:
script:
- npx adibilis scan $DEPLOY_URL --threshold serious --json
variables:
ADIBILIS_API_KEY: $ADIBILIS_API_KEYEnvironment Variables
| Variable | Description |
|----------|-------------|
| ADIBILIS_API_KEY | API key for authenticated scans |
| ADIBILIS_API_URL | Custom API base URL (default: production) |
API Key Priority
--api-keyflagADIBILIS_API_KEYenvironment variable~/.adibilis/config.json(saved viaadibilis login)
License
MIT
