Testen von Seiten mit der CLI

Wenn der URI-Eingabemodus der CLI verwendet wird, stehen mehrere zusätzliche Optionen zur Verfügung, um den Umfang und das Regelset eines Tests zu ändern. Zum Beispiel wird der folgende Code den Header und Footer von einem Test ausschließen und die Regel zur Farbkontraste deaktivieren:

axe http://example.com --exclude footer,header --disable color-contrast

Optionen

-a, --axe-source <path>

Pfad zu einer alternativen axe.js Datei. Die meisten Benutzer benötigen diese Option nicht. Sie ist für fortgeschrittene Anwendungsfälle gedacht, wie das Testen gegen eine bestimmte oder gepatchte Version von axe-core.

--axe-devhub-api-key <your-API-key>

Geben Sie den API-Schlüssel des Axe-Kontos an, der zum Senden der Barrierefreiheitsergebnisse an das Axe Developer Hub verwendet werden soll. Ergebnisse werden an das Projekt gesendet, das mit der angegebenen Projekt-ID (angegeben mit der --axe-devhub-project-id Befehlszeilenoption) verbunden ist, nachdem die Tests abgeschlossen sind. Sowohl --axe-devhub-api-key als auch --axe-devhub-project-id sind erforderlich, um Ergebnisse an das Axe Developer Hub zu senden. Siehe Verwenden der CLI zum Senden von Barrierefreiheitsergebnissen an das Axe Developer Hub für weitere Informationen.

--axe-devhub-project-id <your-project-ID>

Geben Sie die Projekt-ID des Axe Developer Hub an, um Ergebnisse der Barrierefreiheitstests zu erhalten. Sowohl --axe-devhub-api-key als auch --axe-devhub-project-id sind erforderlich, um Ergebnisse an das Axe Developer Hub zu senden. Siehe Verwenden der CLI zum Senden von Barrierefreiheitsergebnissen an das Axe Developer Hub für weitere Informationen.

--axe-devhub-server-url <url>

Geben Sie die URL des Axe Developer Hub-Servers an. Standardmäßig ist es https://axe.deque.com. Entspricht der AXE_DEVHUB_SERVER_URL Umgebungsvariable. Siehe Verwenden der CLI zum Senden von Barrierefreiheitsergebnissen an das Axe Developer Hub für weitere Informationen.

-c, --custom <path>

Geben Sie ein benutzerdefiniertes Regelset an, das verwendet werden soll. Siehe Benutzerdefinierte Regelsets für Details zum Generieren einer Regelset-Datei.

--chrome-options [options]

Kommagetrennte Liste von Chrome-Befehlszeilen-Schaltern, die an den Browser übergeben werden sollen. Zum Beispiel:

axe http://example.com --chrome-options="some-switch,some-other-switch"

--chrome-path <path>

Absoluter Pfad zur ausführbaren Datei des Chrome-Browsers. Verwenden Sie dies, um axe auf eine bestimmte Chrome-Installation zu verweisen, wenn der Standardbrowser nicht gefunden werden kann oder Sie eine bestimmte Version verwenden müssen.

--chromedriver-path <path>

Absoluter Pfad zur ausführbaren Datei von ChromeDriver. ChromeDriver ist eine separate Binärdatei vom Chrome-Browser selbst; es fungiert als Brücke, die axe's WebDriver-Kommandos in Anweisungen übersetzt, die Chrome ausführen kann.

-d, --dir <path>

Das Verzeichnis, in dem die JSON-Ergebnisdatei gespeichert wird. Ohne dieses Flag (oder --save oder --report), wird keine Datei geschrieben, und die Ergebnisse werden stattdessen als menschenlesbare Zusammenfassung im Terminal angezeigt. Siehe auch -j, --stdout , wenn Sie eine maschinenlesbare Ausgabe benötigen, ohne auf die Festplatte zu schreiben.

-l, --disable <list>

Kommagetrennte Liste von Regel-IDs, die deaktiviert werden sollen. Siehe die Beschreibungen der axe-core Regeln für eine vollständige Liste der Regel-IDs.

axe http://example.com --disable color-contrast,duplicate-id

-e, --exclude <list>

Kommagetrennte Liste von CSS-Selektoren für Elemente, die von Tests ausgeschlossen werden sollen. Zum Beispiel:

# Exclude by element type
axe http://example.com --exclude footer,header

# Exclude by class or ID
axe http://example.com --exclude ".ad-banner,#cookie-notice"

# Exclude by attribute
axe http://example.com --exclude "[aria-hidden=true]"

-f, --format <value>

Format des generierten Berichts. Erfordert -r, --report. Siehe Erstellen und Filtern von Berichten für Details, was jedes Format enthält. Standard: html.

axe http://example.com --report ./reports --format html+junit+csv

--filter <list>

Kommagetrennte Liste von Ergebnistypen, die in der CSV-Ausgabe enthalten sein sollen. Nur die angegebenen Typen werden angezeigt; alle anderen sind ausgeschlossen. Gültige Werte sind passes, violations, incompleteund inapplicable. Erfordert --format csv.

axe reporter ./axe-reports/json/ --format=csv --filter passes,inapplicable

-i, --include <list>

Kommagetrennte Liste von CSS-Selektoren. Wenn angegeben, testet axe nur die übereinstimmenden Elemente, und alles andere auf der Seite wird ignoriert. Dies ist sehr restriktiv, und die meisten Benutzer sollten stattdessen verwenden. Verwenden Sie -e, --exclude nur, wenn Sie das Testen auf eine bestimmte Komponente isolieren möchten, etwa während des fokussierten Debugging oder bei Komponententests auf CI-Ebene. --include Schreiben Sie die vollständigen Ergebnisse als maschinenlesbares JSON in stdout anstelle der menschenlesbaren Zusammenfassung im Terminal. Alle anderen Ausgaben werden unterdrückt. Verwenden Sie dies, wenn Sie Ergebnisse an ein anderes Programm weiterleiten möchten.

# Test only the main navigation
axe http://example.com --include nav

# Test only elements with a specific class or ID
axe http://example.com --include ".my-widget,#signup-form"

# Test only elements with a specific attribute
axe http://example.com --include "[data-testid=checkout]"

-j, --stdout

Legen Sie fest, wie viel Zeit (Millisekunden) gewartet wird, nachdem die Seite geladen wurde, bevor die Prüfung gestartet wird (Standard: 0).

--load-delay <n>

Übermitteln Sie keine Informationen zu Git-Branch und Commit, wenn Sie Ergebnisse an Axe Developer Hub senden. Siehe axe Verwendung des CLI zum Senden von Zugänglichkeitsergebnissen an Axe Developer Hub

--no-git-data

. Unterdrückt die Ausgabe der Verletzungszusammenfassung (Regel-IDs, Anzahlen, betroffene Selektoren und Hilfe-URLs), ohne alles zu unterdrücken. Fortschrittsmeldungen und Ergebnisse, die über,

--no-reporter

oder --savegeschrieben werden, sind nicht betroffen. Vor allem in CI-Pipelines nützlich, in denen Sie Ergebnisse in einer Datei speichern und --dirfür Pass/Fail-Signalisierung verwenden und keine ausführlichen Verletzungsdetails im Build-Log wünschen. Für vollständige Stille mit JSON-Ergebnissen verwenden Sie --report stattdessen. --exit Beenden Sie mit -j, --stdout Fehlercode, wenn irgendwelche Zugänglichkeitstests fehlschlagen.

-q, --exit

Das Verzeichnis, in dem der formatierte Bericht geschrieben wird. Funktioniert mit 1 , um das Ausgabeformat zu steuern (standardmäßig HTML). Verwenden Sie dies, wenn Sie einen menschenlesbaren oder maschinenlesbaren Bericht anstelle von rohem JSON wünschen, zum Beispiel einen HTML-Bericht zur Weitergabe an Interessengruppen oder eine JUnit-XML-Datei für CI-Integration. Für rohe JSON-Ausgabe verwenden Sie

-r, --report <output-dir>

stattdessen. -f, --format Kommagetrennte Liste von Regel-IDs, die ausgeführt werden sollen. Nur die angegebenen Regeln werden geprüft; alle anderen werden übersprungen. Siehe die -d, --dir axe-core Regelbeschreibungen

--rules <list>

für eine vollständige Liste von Regel-IDs. Speichern Sie die Ergebnisse als JSON-Datei im aktuellen Verzeichnis. Der Dateiname ist optional; wenn ausgelassen, wird die Datei benannt . Um stattdessen in ein bestimmtes Verzeichnis zu speichern, verwenden Sie

axe http://example.com --rules color-contrast,duplicate-id

-s, --save [filename]

. axe-result.jsonWenn bei einem Laufzeitfehler (wie ein Initialisierungsfehler oder eine während der Ausführung ausgelöste Ausnahme) auftritt, druckt -d, --dirnormalerweise eine kurze Fehlermeldung auf stderr. Diese Option fügt dieser Ausgabe den vollständigen Stack-Trace hinzu. Sie beeinflusst nicht, wie Zugänglichkeitsverletzungen gemeldet werden. Verwenden Sie dies, wenn Sie eine benutzerdefinierte

--show-errors

Datei debuggen, unerwartete Fehler in CI diagnostizieren oder Informationen für einen Fehlerbericht sammeln. axe Kommagetrennte Liste von Tags, um zu filtern, welche Regeln ausgeführt werden sollen. Nur Regeln, die mindestens eines der angegebenen Tags erfüllen, werden einbezogen. Siehe die --axe-source axe-core Tags-Dokumentation

-t, --tags <list>

für eine vollständige Liste der verfügbaren Tags. Druckt nach jedem Testlauf drei Zeitmessungen auf das Terminal: Axe-Seitenladezeit

axe http://example.com --tags wcag2a,wcag2aa

--timer

: wie lange das Laden der Seite im Browser gedauert hat

• axe-core Ausführungszeit: wie lange axe-core zur Analyse der Seite gebraucht hat
• Gesamte Testzeit: die gesamte verstrichene Zeit für den Lauf
• Verwenden Sie dies, um langsame Tests zu diagnostizieren. Verwenden Sie zum Beispiel diese Option, um festzustellen, ob die Zeit mit dem Warten auf das Laden der Seite oder in der Axe-Analyse verbracht wird, oder um zu untersuchen, warum ein Lauf auf: end-to-end elapsed time for the run

Use this to diagnose slow tests. For example, use this option to determine whether the time is spent waiting for the page to load or in Axe analysis, or to investigate why a run is hitting --page-timeout oder --script-timeout Begrenzungen.

--universal-best-practices

Erfasst bestPracticesEnabled=true im Metadaten des universellen Format-Ausgangs. Erfordert --format universal.

--universal-ruleset <id>

Gibt die Ruleset-ID an, die im Metadaten des universellen Format-Ausgangs aufgezeichnet wird. Standardmäßig auf wcag2.1. Erfordert --format universal.

-v, --verbose

Wenn Verstöße festgestellt werden, wird nach der Zusammenfassung der Verstöße ein JSON-Block gedruckt, der Folgendes enthält:

• Test-Engine: die verwendete axe-core Version
• Testumgebung: Browser-User-Agent, Ansichtsfensterbreite und -höhe sowie Bildschirmausrichtung
• Test-Runner: der Name des Runners

Beachten Sie, dass dieser Ausgang nur angezeigt wird, wenn Verstöße festgestellt werden. Wenn eine Seite keine Verstöße aufweist, werden die Metadaten nicht gedruckt. Verwenden Sie dies, wenn Sie genau bestätigen müssen, welche axe-core Version ausgeführt wurde, die Ansichtsfenstereinstellungen überprüfen oder Umgebungsdetails in einem Fehlerbericht enthalten möchten.

Konfigurationsoptionen

Die folgenden Optionen steuern das Browserverhalten und die Testzeit. Im Gegensatz zu den oben genannten Optionen bleiben diese zwischen CLI-Durchläufen bestehen; wenn Sie sie einmal einstellen, wird der Wert in einer Präferenzdatei gespeichert, die für alle zukünftigen Läufe verwendet wird. Sie können auch interaktiv mit axe config-selenium.

Für vollständige Details siehe Konfigurationsoptionen.