CLI-Referenz

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

Befehls-Syntax und vollständige Optionsreferenz für alle Axe DevTools CLI-Unterbefehle

Not for use with personal data

Ein schneller Überblick über jeden Axe DevTools CLI-Unterbefehl und seine Optionen. Für Anwendungshinweise und Beispiele folgen Sie dem Link zum Artikel jedes Befehls.

axe <url>

Analysiert eine oder mehrere Webseiten auf Barrierefreiheitsprobleme. Siehe Seiten testen für vollständige Dokumentation.

axe <url...> [options]

Einige Optionen werden in einer Voreinstellungsdatei gespeichert und bleiben bei CLI-Läufen bestehen. Siehe Konfiguration für Details.

Option Beschreibung
-a, --axe-source <path> Pfad zu einer alternativen axe.js-Datei.
--accept-untrusted Akzeptiere nicht vertrauenswürdige SSL-Zertifikate. Bleibt bestehen.
--axe-devhub-api-key <api-key> API-Schlüssel für das Axe Developer Hub.
--axe-devhub-project-id <project-id> Projekt-ID für das Axe Developer Hub.
--axe-devhub-server-url <url> URL des Axe Developer Hub-Servers. Standard: https://axe.deque.com.
--axe-reports-api-key <api-key> API-Schlüssel für Axe Reports.
--axe-reports-dimensions <dimensions> Kommagetrennte JTBD-Dimensionen, um diesen Scan in Axe Reports zu taggen.
--axe-reports-url <url> URL, um Ergebnisse an Axe Reports zu senden.
--browser [name] Zu verwendender Browser. Erfordert den entsprechenden WebDriver. Gültige Werte: firefox (Standard), chrome, edge (oder microsoftedge), safari, ie. Browserspezifische Optionen gelten nur für Firefox, Chrome und Edge. Bleibt bestehen.
--chrome-options [options] Kommagetrennte Befehlszeilen-Parameter für den Browser Chrome oder Edge. Bleibt bestehen.
--chrome-path <path> Absoluter Pfad zur ausführbaren Datei des Browsers Chrome oder Edge.
--chromedriver-path <path> Absoluter Pfad zur ausführbaren Datei von ChromeDriver oder msedgedriver.
-c, --custom <path> Pfad zu einer benutzerdefinierten Regelset-Datei, die die Standarddatei überschreibt.
-d, --dir <path> Verzeichnis, in dem JSON-Ergebnisse gespeichert werden.
-l, --disable <list> Durch Kommas getrennte Regel-IDs, die deaktiviert werden sollen.
-e, --exclude <list> Durch Kommas getrennte CSS-Selektoren für Elemente, die von der Prüfung ausgeschlossen werden.
-q, --exit Beende mit Code 1, wenn Verstöße gefunden werden.
--enable-tracking <state> Aktivieren (true) oder deaktivieren (false) Sie das Senden von Nutzungsdaten an die Metrikbibliothek. Beständig.
-f, --format <value> Berichtsformat(e): html, junit, csv, universal oder eine durch + getrennte Kombination. Standard: html. Erfordert -r, --report.
--filter <list> Kommagetrennte Ergebnisarten, die einbezogen werden sollen: passes, violations, incomplete, inapplicable. Erfordert --format csv.
--universal-best-practices Zeichnen Sie bestPracticesEnabled=true in den Metadaten auf, wenn Sie --format universal verwenden.
--universal-ruleset <id> Regelset-ID, die in den Metadaten aufgezeichnet werden soll, wenn Sie --format universal verwenden. Gültige Werte: wcag2, wcag2.1, wcag2.2, wcag2aaa, wcag2.1aaa, wcag2.2aaa, 508, en301549, ttv5, rgaav4. Standard: wcag2.1.
--headless Starten Sie den Browser im Headless-Modus. Bleibt bestehen.
-i, --include <list> Kommagetrennte CSS-Selektoren. Nur passende Elemente werden getestet.
--load-delay <n> Millisekunden, die nach dem Laden der Seite gewartet werden, bevor das Audit ausgeführt wird. Standard: 0.
--no-git-data Senden Sie keine Git-Zweig- und Commit-Daten an Axe Developer Hub.
--no-reporter Unterdrücken Sie die Ausgabe der Verstöße-Zusammenfassung.
--page-timeout <ms> Maximale Millisekunden, um auf das Laden einer Seite zu warten. Standard: 60000. Beständig.
--post-analyze-pause <ms> Millisekunden, um nach der Analyse vor der nächsten Aktion zu pausieren. Standard: 2000. Beständig.
--post-get-pause <ms> Millisekunden, um nach dem Laden der Seite und vor dem Scannen zu pausieren. Standard: 2000. Beständig.
--post-script-pause <ms> Millisekunden, um nach einer Skriptaktion und vor dem Scannen zu pausieren. Standard: 2000. Beständig.
-r, --report <output-dir> Verzeichnis, in das der formatierte Bericht geschrieben wird. Verwenden Sie mit -f, --format.
--remote-proxy [proxy-server] Leitet den Datenverkehr über einen entfernten Proxy um (nur für chromiumbasierte Browser: Chrome und Edge). Bleibt bestehen.
--remote-server [server-url] Verbinden Sie sich mit einem Remote-WebDriver-Server (z.B. Selenium Grid, BrowserStack). Bleibt bestehen.
--rules <list> Kommagetrennte Regel-IDs zum Ausführen. Nur die angegebenen Regeln werden überprüft.
-s, --save [filename] Speichern der Ergebnisse als JSON-Datei. Dateiname standardmäßig axe-result.json.
--script-timeout <ms> Maximale Millisekunden, um auf ein Workflow-Skript zu warten. Standard: 60000. Beständig.
--send-axe-reports Senden Sie Analyseergebnisse an Axe Reports.
--set-distinct-id <id> Überschreiben Sie die eindeutige ID, die für die Nutzungserfassung verwendet wird. Bleibt bestehen.
--set-tracking-url <url> Überschreiben Sie die URL, an die die Messdaten gesendet werden. Bleibt erhalten.
--show-errors Zeigen Sie den vollständigen Fehler-Stacktrace bei Fehlern an.
-j, --stdout Geben Sie JSON-Ergebnisse an stdout aus; unterdrückt alle anderen Ausgaben.
-t, --tags <list> Kommagetrennte Tags zum Filtern, welche Regeln ausgeführt werden.
--timer Geben Sie Zeitmessungen nach jedem Testlauf aus.
-v, --verbose Werkzeugname, Version und Umgebungsmetadaten in die Ausgabe einbeziehen.
-V, --version Geben Sie die Versionsnummer aus.
--window-size <width,height> Stellen Sie die Größe des Browserfensters in Pixeln ein. Bleibt erhalten.

axe bulk-reports

Sendet JSON-Ergebnisse an Axe Reports. Siehe An Axe Reports senden für die vollständige Dokumentation.

axe bulk-reports <results-directory> [options]
Option Beschreibung
--axe-reports-api-key <api-key> API-Schlüssel für Axe Reports.
--axe-reports-dimensions <dimensions> Kommagetrennte JTBD-Dimensionen, um diesen Scan in Axe Reports zu taggen.
--axe-reports-url <url> URL, um Ergebnisse an Axe Reports zu senden.
--send-axe-reports Senden Sie Analyseergebnisse an Axe Reports.
--verbose Ausführliche Protokollierung aktivieren.

axe bulk-spec

Verarbeitet ein Verzeichnis von Spezifikationsdateien in einem einzigen Lauf. Siehe Workflow-Spezifikationen für vollständige Dokumentation.

axe bulk-spec <spec-files-directory> [output-directory] [options]
Option Beschreibung
-a, --axe-source <path> Pfad zu einer alternativen axe.js-Datei.
--accept-untrusted Akzeptiere nicht vertrauenswürdige SSL-Zertifikate. Bleibt bestehen.
--browser [name] Zu verwendender Browser. Erfordert den entsprechenden WebDriver. Gültige Werte: firefox (Standard), chrome, edge (oder microsoftedge), safari, ie. Browserspezifische Optionen gelten nur für Firefox, Chrome und Edge. Bleibt bestehen.
-c, --custom <path> Pfad zu einer benutzerdefinierten Regelset-Datei, die die Standarddatei überschreibt.
--dismiss-alerts Schließen Sie die Browserdialoge alert(), confirm() und prompt() vor dem Scannen.
--enable-tracking <state> Aktivieren (true) oder deaktivieren (false) Sie das Senden von Nutzungsdaten an die Metrikbibliothek. Beständig.
-f, --format [value] Berichtsformat(e): html, junit, csv oder eine durch + getrennte Kombination. Standard: html.
--headless Starten Sie den Browser im Headless-Modus. Bleibt bestehen.
--no-analyze Entfernen Sie die Anforderung einer analyze-Aktion in der Aktionsliste jeder Seite.
--no-html Verhindern Sie die Erstellung von HTML-Berichten.
--no-reports Verhindern Sie die Erstellung aller Berichtsdateien.
--no-wait Deaktivieren Sie automatische Pausen zwischen Workflow-Aktionen.
--page-timeout <ms> Maximale Millisekunden, um auf das Laden einer Seite zu warten. Standard: 60000. Beständig.
--post-analyze-pause <ms> Millisekunden, um nach der Analyse vor der nächsten Aktion zu pausieren. Standard: 2000. Beständig.
--post-get-pause <ms> Millisekunden, um nach dem Laden der Seite und vor dem Scannen zu pausieren. Standard: 2000. Beständig.
--post-script-pause <ms> Millisekunden, um nach einer Skriptaktion und vor dem Scannen zu pausieren. Standard: 2000. Beständig.
--remote-proxy [proxy-server] Leitet den Datenverkehr über einen entfernten Proxy um (nur für chromiumbasierte Browser: Chrome und Edge). Bleibt bestehen.
--remote-server [server-url] Verbinden Sie sich mit einem Remote-WebDriver-Server (z.B. Selenium Grid, BrowserStack). Bleibt bestehen.
--script-timeout <ms> Maximale Millisekunden, um auf ein Workflow-Skript zu warten. Standard: 60000. Beständig.
--set-distinct-id <id> Überschreiben Sie die eindeutige ID, die für die Nutzungserfassung verwendet wird. Bleibt bestehen.
--set-tracking-url <url> Überschreiben Sie die URL, an die die Messdaten gesendet werden. Bleibt erhalten.
-t, --tags [list] Kommagetrennte Tags zum Filtern, welche Regeln ausgeführt werden.
--user-agent <agent> Setzt eine benutzerdefinierte User-Agent-Zeichenkette (nur für chromiumbasierte Browser: Chrome und Edge). Bleibt bestehen.
--validate Die Spezifikationsdateien validieren, ohne sie auszuführen.
--wait-network-idle-new-connections [number] Neue Verbindungsgrenze, bevor das Netzwerk als inaktiv gilt (nur für chromiumbasierte Browser: Chrome und Edge).
--wait-network-idle-open-connections [number] Offene Verbindungsgrenze, bevor das Netzwerk als inaktiv gilt (nur für chromiumbasierte Browser: Chrome und Edge).
--wait-network-idle-timeout [ms] Maximale Millisekunden, die auf ein inaktives Netzwerk gewartet wird, bevor fortgefahren wird (nur für chromiumbasierte Browser: Chrome und Edge).
--window-size <width,height> Stellen Sie die Größe des Browserfensters in Pixeln ein. Bleibt erhalten.

axe config-selenium

Konfiguriert interaktiv dauerhafte Browser- und Timing-Standardeinstellungen. Siehe Konfiguration für vollständige Dokumentation.

axe config-selenium [options]
Option Beschreibung
-s, --show Aktuell gespeicherte Einstellungen anzeigen, ohne die interaktive Aufforderung aufzurufen.

axe devhub

Sendet JSON-Ergebnisse an das Axe Developer Hub. Siehe Senden an Axe Developer Hub für vollständige Dokumentation.

axe devhub <results-directory|file> [options]
Option Beschreibung
--axe-devhub-api-key <api-key> API-Schlüssel für das Axe Developer Hub. Überschreibt die AXE_DEVHUB_API_KEY Umgebungsvariable.
--axe-devhub-project-id <project-id> Projekt-ID für das Axe Developer Hub.
--axe-devhub-server-url <url> URL des Axe Developer Hub-Servers. Standard: https://axe.deque.com.
--no-git-data Senden Sie keine Git-Zweig- und Commit-Daten an Axe Developer Hub.

axe licenses

Zeigt und speichert die Open-Source-Lizenzen für alle CLI-Abhängigkeiten.

axe licenses [options]

axe reporter

Konvertiert JSON-Ergebnisse in HTML-, JUnit-XML- oder CSV-Berichte. Siehe Berichte erzeugen für vollständige Dokumentation.

axe reporter <results-dir> [dest-dir] [options]
Option Beschreibung
-b, --browser [name] Wenn das Ergebnisverzeichnis Ergebnisse aus mehreren Browsern enthält, den Bericht nur aus den Ergebnissen eines Browsers generieren.
-d, --dest [path] Ausgabeverzeichnis für generierte Berichte. Kann auch als zweites Positionsargument angegeben werden.
--filter <list> Kommagetrennte Ergebnisarten, die einbezogen werden sollen: passes, violations, incomplete, inapplicable. Erfordert --format csv.
-f, --format [type(s)] Ausgabeformat(e): html, junit, csv, universal oder eine Kombination. Standard: html.
--universal-best-practices Zeichnen Sie bestPracticesEnabled=true in den Metadaten auf, wenn Sie --format universal verwenden.
--universal-ruleset <id> Regelset-ID, die in den Metadaten aufgezeichnet werden soll, wenn Sie --format universal verwenden. Gültige Werte: wcag2, wcag2.1, wcag2.2, wcag2aaa, wcag2.1aaa, wcag2.2aaa, 508, en301549, ttv5, rgaav4. Standard: wcag2.1.

axe ruleset

Erstellt benutzerdefinierte Regelsets. Siehe Benutzerdefinierte Regelwerke für die vollständige Dokumentation.

axe ruleset [options]
Option Beschreibung
--508 [filename] Generiere eine Standardkonfiguration für Section 508-Regeln.
--all [filename] Generiere eine Standardkonfiguration für alle unterstützten Richtlinien.
-a, --axe-source <path> Pfad zu einer benutzerdefinierten Axe-Quelle.
-c, --custom [dir] Generieren Sie ein benutzerdefiniertes Regelset aus einem Verzeichnis, das eine changes.json-Datei enthält.
-d, --destination [dir] Ausgabeverzeichnis. Standard: aktuelles Arbeitsverzeichnis.
-x, --disable-other-rules Deaktivieren Sie alle Regeln, die nicht in der rules-Eigenschaft enthalten sind. Standard: true.
--en301549 [filename] Generiere eine Standardkonfiguration für EN 301 549-Regeln.
-f, --format [format] Ausgabeformat.
-l, --log Generiere auch eine Liste aller im generierten Regelset enthaltenen Regeln.
--only-changes Generiere nur die Änderungen und Ergänzungen des Regelsets.
--rgaav4 [filename] Generiere eine Standardkonfiguration für RGAA v4-Regeln.
-t, --tags [list] Kommagetrennte Tags, um das Standardregelset zu filtern.
--ttv5 [filename] Generiere eine Standardkonfiguration für Trusted Tester v5-Regeln.
--wcag2 [filename] Generiere eine Standardkonfiguration für WCAG 2.0 AA-Regeln.
--wcag21 [filename] Generiere eine Standardkonfiguration für WCAG 2.1 AA-Regeln.
--wcag21aaa [filename] Generiere eine Standardkonfiguration für WCAG 2.1 AAA-Regeln.
--wcag22 [filename] Generiere eine Standardkonfiguration für WCAG 2.2 AA-Regeln.
--wcag22aaa [filename] Generiere eine Standardkonfiguration für WCAG 2.2 AAA-Regeln.
--wcag2aaa [filename] Generiere eine Standardkonfiguration für WCAG 2.0 AAA-Regeln.

axe spec

Analysiert Seiten, die in einer JSON- oder YAML-Spezifikationsdatei definiert sind. Siehe Workflow-Spezifikationen für die vollständige Dokumentation.

axe spec <spec-file> [output-directory] [options]
Option Beschreibung
-a, --axe-source <path> Pfad zu einer alternativen axe.js-Datei.
--accept-untrusted Akzeptiere nicht vertrauenswürdige SSL-Zertifikate. Bleibt bestehen.
--axe-devhub-api-key <api-key> API-Schlüssel für das Axe Developer Hub.
--axe-devhub-project-id <project-id> Projekt-ID für das Axe Developer Hub.
--axe-devhub-server-url <url> URL des Axe Developer Hub-Servers. Standard: https://axe.deque.com.
--axe-reports-api-key <api-key> API-Schlüssel für Axe Reports.
--axe-reports-dimensions <dimensions> Kommagetrennte JTBD-Dimensionen, um diesen Scan in Axe Reports zu taggen.
--axe-reports-url <url> URL, um Ergebnisse an Axe Reports zu senden.
--browser [name] Zu verwendender Browser. Erfordert den entsprechenden WebDriver. Gültige Werte: firefox (Standard), chrome, edge (oder microsoftedge), safari, ie. Browserspezifische Optionen gelten nur für Firefox, Chrome und Edge. Bleibt bestehen.
--chrome-options [options] Kommagetrennte Befehlszeilen-Parameter für den Browser Chrome oder Edge. Bleibt bestehen.
-c, --custom <path> Pfad zu einer benutzerdefinierten Regelset-Datei, die die Standarddatei überschreibt.
--descendant-links Sammelt Links auf jeder Seite und fügt sie den Ergebnissen hinzu. Erfordert --verbose.
--dismiss-alerts Schließen Sie die Browserdialoge alert(), confirm() und prompt() vor dem Scannen.
--download-path <path> Legt fest, wo der Browser Downloads speichert (nur für chromiumbasierte Browser: Chrome und Edge).
--enable-tracking <state> Aktivieren (true) oder deaktivieren (false) Sie das Senden von Nutzungsdaten an die Metrikbibliothek. Beständig.
-f, --format [value] Berichtsformat(e): html, junit, csv, universal oder eine +-getrennte Kombination. Standard: html.
--filter <list> Kommagetrennte Ergebnisarten, die einbezogen werden sollen: passes, violations, incomplete, inapplicable. Erfordert --format csv.
--headless Starten Sie den Browser im Headless-Modus. Bleibt bestehen.
--interactive-mode Beginnen Sie mit der Ausführung von Aktionen, sobald das HTML der Seite geladen ist, ohne auf Bilder, Stylesheets und andere Ressourcen zu warten. Verwenden Sie dies für Seiten, mit denen Sie vor dem Scannen interagieren müssen oder die lange zum Laden benötigen.
--no-analyze Entfernen Sie die Anforderung einer analyze-Aktion in der Aktionsliste jeder Seite.
--no-exit Erzwingen Sie den Exit-Code 0, auch wenn Verstöße gefunden werden.
--no-git-data Senden Sie keine Git-Zweig- und Commit-Daten an Axe Developer Hub.
--no-html Verhindern Sie die Erstellung von HTML-Berichten.
--no-reports Verhindern Sie die Erstellung aller Berichtsdateien.
--no-wait Deaktivieren Sie automatische Pausen zwischen Workflow-Aktionen.
--page-name <name> Führen Sie nur die Seite mit dem angegebenen Namen aus der Spezifikationsdatei aus.
--page-source Fügen Sie den gescannten HTML-Quellcode den Ergebnissen hinzu. Erfordert --verbose.
--page-timeout <ms> Maximale Millisekunden, um auf das Laden einer Seite zu warten. Standard: 60000. Beständig.
--page-title Fügen Sie den Seitentitel den Ergebnissen hinzu. Erfordert --verbose.
--post-analyze-pause <ms> Millisekunden, um nach der Analyse vor der nächsten Aktion zu pausieren. Standard: 2000. Beständig.
--post-get-pause <ms> Millisekunden, um nach dem Laden der Seite und vor dem Scannen zu pausieren. Standard: 2000. Beständig.
--post-script-pause <ms> Millisekunden, um nach einer Skriptaktion und vor dem Scannen zu pausieren. Standard: 2000. Beständig.
--remote-proxy [proxy-server] Leitet den Datenverkehr über einen entfernten Proxy um (nur für chromiumbasierte Browser: Chrome und Edge). Bleibt bestehen.
--remote-server [server-url] Verbinden Sie sich mit einem Remote-WebDriver-Server (z.B. Selenium Grid, BrowserStack). Bleibt bestehen.
--resume-from <name> Überspringen Sie alle Seiten vor der benannten Seite in der Spezifikationsdatei.
--scanned-url Fügen Sie die Basis-URL und die Scan-URL zu den ausführlichen Ergebnissen hinzu. Nur Chrome. Erfordert --verbose.
--script-timeout <ms> Maximale Millisekunden, um auf ein Workflow-Skript zu warten. Standard: 60000. Beständig.
--send-axe-reports Senden Sie Analyseergebnisse an Axe Reports.
--set-distinct-id <id> Überschreiben Sie die eindeutige ID, die für die Nutzungserfassung verwendet wird. Bleibt bestehen.
--set-legacy-mode Aktivieren Sie den Legacy-Scan-Modus. Veraltet — wird in Version 5.0 entfernt.
--set-tracking-url <url> Überschreiben Sie die URL, an die die Messdaten gesendet werden. Bleibt erhalten.
--silent-mode Unterdrücken Sie alle dekorativen Ausgaben; Ergebnisse werden nur angezeigt, wenn --verbose ebenfalls aktiv ist.
-t, --tags [list] Kommagetrennte Tags zum Filtern, welche Regeln ausgeführt werden.
--universal-best-practices Zeichnen Sie bestPracticesEnabled=true in den Metadaten auf, wenn Sie --format universal verwenden.
--universal-ruleset <id> Regelset-ID, die in den Metadaten aufgezeichnet werden soll, wenn Sie --format universal verwenden. Gültige Werte: wcag2, wcag2.1, wcag2.2, wcag2aaa, wcag2.1aaa, wcag2.2aaa, 508, en301549, ttv5, rgaav4. Standard: wcag2.1.
--user-agent <agent> Setzt eine benutzerdefinierte User-Agent-Zeichenkette (nur für chromiumbasierte Browser: Chrome und Edge). Bleibt bestehen.
--validate Validieren Sie die Spec-Datei, ohne sie auszuführen.
-v, --verbose Werkzeugname, Version und Umgebungsmetadaten in die Ausgabe einbeziehen.
--wait-network-idle-new-connections [number] Neue Verbindungsgrenze, bevor das Netzwerk als inaktiv gilt (nur für chromiumbasierte Browser: Chrome und Edge).
--wait-network-idle-open-connections [number] Offene Verbindungsgrenze, bevor das Netzwerk als inaktiv gilt (nur für chromiumbasierte Browser: Chrome und Edge).
--wait-network-idle-polling-every [ms] Abfrageintervall in Millisekunden für die Erkennung von Netzwerk-Inaktivität (nur für chromiumbasierte Browser: Chrome und Edge).
--wait-network-idle-timeout [ms] Maximale Millisekunden, die auf ein inaktives Netzwerk gewartet wird, bevor fortgefahren wird (nur für chromiumbasierte Browser: Chrome und Edge).
--window-size <width,height> Stellen Sie die Größe des Browserfensters in Pixeln ein. Bleibt erhalten.

Is this page helpful?

Help us improve this page

Still need help?