Erste Schritte mit Axe DevTools CLI
Ein Schnellstartleitfaden zu den häufigsten Aufgaben der Axe DevTools CLI
Bevor Sie beginnen, installieren Sie Axe DevTools CLI.
Axe DevTools CLI läuft über den axe Befehl. Dieser Leitfaden behandelt die drei am häufigsten durchgeführten Aufgaben.
Eine Webseite analysieren
Geben Sie dem axe Befehl direkt eine oder mehrere URLs. Standardmäßig verwendet die CLI Firefox und führt das WCAG 2.1 AA Regelset aus, wobei die Ergebnisse auf stdout ausgegeben werden:
axe https://example.com/Analysieren Sie mehrere Seiten gleichzeitig:
axe https://example.com/ https://example.com/about.htmlSpeichern Sie die Ergebnisse als JSON-Datei zur späteren Verwendung:
axe https://example.com/ --save=./axe-results.jsonErstellen Sie direkt einen HTML-Bericht:
axe https://example.com/ --report=./axe-reports/Eine Übersicht aller Optionen finden Sie unter Seiten analysieren.
Seiten mit einer Spezifikationsdatei analysieren
Für komplexere Szenarien wie das Navigieren durch eine Single-Page-App, das Anmelden, das Schließen von Dialogen oder die Analyse einer Seite zu mehreren Punkten in einem Workflow verwenden Sie den axe spec Befehl mit einer Spezifikationsdatei.
Eine Spezifikationsdatei (JSON oder YAML) definiert eine Liste von Seiten, die analysiert werden sollen, und die auf jeder Seite durchzuführenden Aktionen, bevor die Analyse beginnt. Ein minimales Beispiel (axe-workflow.yaml):
projects:
- name: example
id: example
pageList:
- name: Homepage
url: https://example.com/
- name: Search Results
url: https://example.com/
actions:
- type "axe" into element "#searchform input"
- click element "#searchform button[type=submit]"
- wait for element ".search-results" to be found
- analyzeFühren Sie es mit axe spec aus, wobei Sie die Spezifikationsdatei und ein Ausgabeverzeichnis für die Ergebnisse angeben:
axe spec ./axe-workflow.yaml ./axe-resultsEine vollständige Referenz zur Struktur von Spezifikationsdateien, Aktionen und Optionen finden Sie unter Seiten mit einer Spezifikationsdatei analysieren.
Einen Bericht aus gespeicherten Ergebnissen erstellen
Verwenden Sie den axe reporter Befehl, um gespeicherte JSON-Ergebnisse in HTML, JUnit XML oder CSV zu konvertieren:
axe reporter ./axe-results --format=htmlEin JUnit XML-Bericht erstellen (nützlich in CI-Pipelines):
axe reporter ./axe-results --format=junitEinen CSV-Bericht erstellen:
axe reporter ./axe-results --format=csvFür Filterungsoptionen und weitere Optionen siehe Berichte erstellen.
Nächste Schritte
- Seiten analysieren: alle Optionen zur Analyse einzelner Seiten
- Seiten mit einer Spezifikationsdatei analysieren: Spezifikationsdateien, Aktionen und Batch-Verarbeitung
- Berichte erstellen: Berichtsformate, Filterung und Struktur der JSON-Ergebnisse
- An Axe Reports senden: Ergebnisse an den Axe Reports Service hochladen
- An Axe Developer Hub senden: Ergebnisse in Axe Developer Hub integrieren
- Konfigurieren: Browserauswahl, Timeouts und persistente Einstellungen
- Benutzerdefinierte Regelwerke: WCAG 2.x, Section 508 und benutzerdefinierte Regelsets
