Erste Schritte mit Axe DevTools CLI
Ein Schnellstartleitfaden zu den häufigsten Aufgaben der Axe DevTools CLI
Bevor Sie loslegen, installieren Sie Axe DevTools CLI.
Axe DevTools CLI wird über den axe -Befehl ausgeführt. Dieser Leitfaden behandelt die drei häufigsten Aufgaben.
Eine Webseite analysieren
Übergeben Sie eine oder mehrere URLs direkt an den axe -Befehl. Standardmäßig verwendet die CLI Firefox und führt den WCAG 2.1 AA -Regelsatz aus und gibt die Ergebnisse auf stdout aus:
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/Alle Optionen finden Sie unter Seiten analysieren.
Seiten mit einer Spezifikationsdatei analysieren
Für komplexere Szenarien wie das Navigieren durch eine Single-Page-App, das Einloggen, das Schließen von Dialogen oder das Analysieren einer Seite an mehreren Stellen 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 Aktionen, die auf jeder Seite vor der Analyse durchgeführt werden. 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 specaus, wobei die Spezifikationsdatei und ein Ausgabeverzeichnis für die Ergebnisse angegeben werden:
axe spec ./axe-workflow.yaml ./axe-resultsEine vollständige Referenz zur Struktur, den Aktionen und den Optionen der Spezifikationsdatei 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 Filteroptionen und weitere Details siehe Berichte erstellen.
Nächste Schritte
- Seiten analysieren: alle Optionen zur Analyse einzelner Seiten
- Seiten mit einer Spezifikationsdatei analysieren: Spezifikationsdateien, Aktionen und Stapelverarbeitung
- Berichte erstellen: Berichtsformate, Filterung und JSON-Ergebnisstruktur
- An Axe Reports senden: Ergebnisse an den Axe Reports-Dienst hochladen
- An Axe Developer Hub senden: Ergebnisse mit Axe Developer Hub integrieren
- Konfigurieren: Browser-Auswahl, Zeitüberschreitungen und persistente Einstellungen
- Benutzerdefinierte Regelwerke: WCAG 2.x, Abschnitt 508 und benutzerdefinierte Regelwerke
