Axe DevTools voor Web CLI
Een commandoregeltool voor het automatiseren van toegankelijkheidstests voor websites zonder het schrijven van testcode.
Axe DevTools voor Web CLI is een commandoregeltool die toegankelijkheidsanalyses uitvoert op webpagina's en rapporten genereert. Het is ontworpen voor teams die toegankelijkheidstests willen automatiseren zonder axe te integreren in een bestaand testframework, bijvoorbeeld als een stap in een CI/CD-pijplijn, of wanneer Axe DevTools API's niet beschikbaar zijn voor jouw taal.
Hoe het werkt
Elke axe analyse levert JSON-resultaatbestanden, één per geanalyseerde paginastatus. Deze bestanden worden geproduceerd bij het testen en je gebruikt ze bij het rapporteren of uploaden van resultaten.
De gebruikelijke workflow heeft twee fasen:
-
Pagina's analyseren: voer één of meer URL's door
axeen sla de JSON-resultaten op:axe <url> → test a URL directly axe spec <spec-file> → test pages and workflows defined in a YAML/JSON file axe bulk-spec <dir> → test using all spec files in a directory -
Iets doen met resultaten: converteer, upload of stuur ze naar elders:
axe reporter <results> → generate HTML, JUnit XML, or CSV reports axe bulk-reports <results> → upload to the Axe Reports service axe devhub <results> → send to Axe Developer Hub
De axe en axe spec commando's ondersteunen ook --format en --report vlaggen om rapporten in één stap te genereren, zonder een aparte axe reporter aanroep.
Commando's
| Commando | Doel |
|---|---|
axe <url...> |
Analyseer direct één of meer URL's. Standaardbrowser: Firefox. Standaardregels: WCAG 2.1 AA. |
axe spec <spec-file> |
Analyseer pagina's gedefinieerd in een YAML- of JSON-spec bestand, inclusief stappenplannen. |
axe bulk-spec <dir> |
Voer alle spec-bestanden uit die in een map en zijn submappen worden gevonden. |
axe reporter <results-dir> |
Converteer JSON-resultaten naar HTML, JUnit XML of CSV-rapporten. |
axe bulk-reports <results-dir> |
Upload JSON-resultaten naar de Axe Reports-service. |
axe devhub <results-dir> |
Stuur JSON-resultaten naar de Axe Developer Hub. |
axe ruleset |
Lijst, valideer of beheer aangepaste regels. |
axe config-selenium |
Bekijk of werk browser-/Selenium-instellingen bij. |
JSON-resultaten
Wanneer je axe spec uitvoert of gebruikt axe <url> --save, worden de resultaten als JSON-bestanden in de uitvoermap geschreven. Elk bestand legt de volledige axe analyse voor een enkele paginastatus vast: overtredingen, goedkeuringen, onvolledige controles en niet-toepasbare regels, samen met metadata zoals de URL, browser en tijdstempel.
Resultaatbestanden worden georganiseerd per project en genoemd naar de pagina die wordt getest:
<output-dir>/<project-id>/<project-id>-<page-id>[-<analyze-title>].jsonDeze bestanden worden gebruikt door axe reporter, axe bulk-reports, en axe devhub. Voor details over bestandsnaamgeving en mapstructuur, zie Rapporten genereren.
Het JSON-resultaat schema is gedefinieerd door axe-core. Voor een volledige referentie, zie de axe-core API documentatie.
In deze sectie
- Aan de slag: veelvoorkomende taken met werkende voorbeelden
- Installeren: installatiemogelijkheden (uitvoerbaar bestand of Node.js-pakket)
- Pagina's analyseren: alle opties voor
axe <url> - Pagina's analyseren met een specificatiebestand: structuur van specificatiebestanden, acties en batchverwerking
- Rapporten genereren: rapportformaten, filtering en JSON-resultaatstructuur
- Verstuur naar Axe-rapporten: upload resultaten naar de Axe-rapportenservice
- Verstuur naar de Axe Developer Hub: integreer resultaten met de Axe Developer Hub
- Configureren: browserselectie, time-outs en blijvende instellingen
- Aangepaste regelsets: WCAG 2.x, Sectie 508 en aangepaste regelsets