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> — Seiten anhand von URLs analysieren
axe bulk-reports — Ergebnisse an Axe Reports senden
axe bulk-spec — ein Verzeichnis mit Spezifikationsdateien ausführen
axe config-selenium — persistente Browser-Standards konfigurieren
axe devhub — Ergebnisse an Axe Developer Hub senden
axe licenses — Abhängigkeitslizenzen anzeigen
axe reporter — Berichte aus JSON-Ergebnissen generieren
axe ruleset — benutzerdefinierte Regelsets erstellen
axe spec — eine Spezifikationsdatei ausführen

`axe <url>`

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

axe <url...> [options]

Einige Optionen werden in einer Einstellungsdatei gespeichert und bleiben über CLI-Läufe hinweg bestehen. Siehe Konfiguration für Details.

Option	Beschreibung
`-a, --axe-source <path>`	Pfad zu einer alternativen `axe.js` Datei.
`--accept-untrusted`	Nicht vertraute SSL-Zertifikate akzeptieren. Bleibt bestehen.
`--axe-devhub-api-key <api-key>`	API-Schlüssel für Axe Developer Hub.
`--axe-devhub-project-id <project-id>`	Projekt-ID für 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>`	Durch Kommas getrennte JTBD-Dimensionen, um diesen Scan in Axe Reports zu markieren.
`--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`, `safari`, `edge`, `ie`. Bleibt bestehen.
`--chrome-options [options]`	Durch Kommas getrennte Chrome-Befehlszeilen-Schalter, die an den ChromeDriver übergeben werden. Bleibt bestehen.
`--chrome-path <path>`	Absoluter Pfad zur ausführbaren Datei des Chrome-Browsers.
`--chromedriver-path <path>`	Absoluter Pfad zur ausführbaren Datei des ChromeDriver.
`-c, --custom <path>`	Pfad zu einer benutzerdefinierten Regelset-Datei, die die Standardeinstellung ü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`	Beenden mit Code `1` bei gefundenen Verstößen.
`--enable-tracking <state>`	Aktivieren (`true`) oder deaktivieren (`false`) des Sendens von Nutzungsdaten an die Metrikbibliothek. Bleibt bestehen.
`-f, --format <value>`	Berichtsformat(e): `html`, `junit`, `csv`, oder eine `+`-getrennte Kombination. Standard: `html`. Erfordert `-r, --report`.
`--filter <list>`	Kommagetrennte Ergebnistypen zum Einbeziehen: `passes`, `violations`, `incomplete`, `inapplicable`. Erfordert `--format csv`.
`--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 wird, bevor das Audit ausgeführt wird. Standard: `0`.
`--no-git-data`	Senden Sie keine Git-Branch- und Commit-Daten an Axe Developer Hub.
`--no-reporter`	Unterdrücken Sie die Ausgabe der Verstöße-Zusammenfassung.
`--page-timeout <ms>`	Maximale Millisekunden, die auf das Laden einer Seite gewartet wird. Standard: `60000`. Bleibt bestehen.
`--post-analyze-pause <ms>`	Millisekunden, die nach der Analyse pausiert wird, bevor die nächste Aktion erfolgt. Standard: `2000`. Bleibt bestehen.
`--post-get-pause <ms>`	Millisekunden, die nach dem Laden der Seite und vor der Überprüfung pausiert wird. Standard: `2000`. Bleibt bestehen.
`--post-script-pause <ms>`	Millisekunden, die nach einer Skriptaktion und vor der Überprüfung pausiert wird. Standard: `2000`. Bleibt bestehen.
`-r, --report <output-dir>`	Verzeichnis, in dem der formatierte Bericht geschrieben wird. Verwenden mit `-f, --format`.
`--remote-proxy [proxy-server]`	Route den Datenverkehr über einen Remote-Proxy (nur ChromeDriver). Bleibt bestehen.
`--remote-server [server-url]`	Stellen Sie eine Verbindung zu einem Remote-WebDriver-Server her (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]`	Ergebnisse als JSON-Datei speichern. Dateiname ist standardmäßig `axe-result.json`.
`--script-timeout <ms>`	Maximale Millisekunden, die auf ein Workflow-Skript gewartet wird. Standard: `60000`. Bleibt bestehen.
`--send-axe-reports`	Analyseergebnisse an Axe Reports senden.
`--set-distinct-id <id>`	Überschreiben Sie die eindeutige ID, die für die Nutzungsverfolgung verwendet wird. Bleibt bestehen.
`--set-tracking-url <url>`	Überschreiben Sie die URL, an die Metrikdaten gesendet werden. Bleibt bestehen.
`--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, um zu filtern, welche Regeln ausgeführt werden.
`--timer`	Geben Sie Zeitmessungen nach jedem Testlauf aus.
`-v, --verbose`	Fügen Sie den Toolnamen, die Version und Metadaten zur Umgebung in den Ausgaben ein.
`-V, --version`	Geben Sie die Versionsnummer aus.
`--window-size <width,height>`	Setzen Sie die Browserfenstergröße in Pixel. Bleibt bestehen.

`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 markieren.
`--axe-reports-url <url>`	URL, um Ergebnisse an Axe Reports zu senden.
`--send-axe-reports`	Analysenergebnisse an Axe Reports senden.
`--verbose`	Ausführliche Protokollierung aktivieren.

`axe bulk-spec`

Verarbeitet ein Verzeichnis von Spezifikationsdateien in einem einzigen Durchlauf. Siehe Arbeitsablaufspezifikationen für die 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`	Unvertrauenswürdige SSL-Zertifikate akzeptieren. Bleibt bestehen.
`--browser [name]`	Zu verwendender Browser. Erfordert den entsprechenden WebDriver. Gültige Werte: `firefox` (Standard), `chrome`, `safari`, `edge`, `ie`. Bleibt bestehen.
`-c, --custom <path>`	Pfad zu einer benutzerdefinierten Regelsatzdatei, die den Standard überschreibt.
`--dismiss-alerts`	Browser-, `alert()`und `confirm()`-Dialoge vor dem Scannen schließen. `prompt()` aktivieren (
`--enable-tracking <state>`	) oder deaktivieren (`true`) die Übermittlung von Nutzungsdaten an die Metrikbibliothek. Bleibt bestehen.`false`Berichtsformat(e):
`-f, --format [value]`	, `html`, `junit`, oder eine `csv`-getrennte Kombination. Standard: `+`. `html`Browser im kopflosen Modus starten. Bleibt bestehen.
`--headless`	Entferne die Anforderung für eine
`--no-analyze`	-Aktion in der Aktionsliste jeder Seite. `analyze` Erzeugung des HTML-Berichts verhindern.
`--no-html`	Erzeugung aller Berichtdateien verhindern.
`--no-reports`	Automatische Pausen zwischen Workflow-Aktionen deaktivieren.
`--no-wait`	Maximale Millisekunden, um auf das Laden einer Seite zu warten. Standard:
`--page-timeout <ms>`	. Bleibt bestehen. `60000`Millisekunden zum Pausieren nach der Analyse vor der nächsten Aktion. Standard:
`--post-analyze-pause <ms>`	. Bleibt bestehen. `2000`Millisekunden zum Pausieren nach dem Laden einer Seite und bevor das Scannen beginnt. Standard:
`--post-get-pause <ms>`	. Bleibt bestehen. `2000`Millisekunden zum Pausieren nach einer Skriptaktion und bevor das Scannen beginnt. Standard:
`--post-script-pause <ms>`	. Bleibt bestehen. `2000`Leite den Datenverkehr über einen Remote-Proxy (nur ChromeDriver). Bleibt bestehen.
`--remote-proxy [proxy-server]`	Verbindung zu einem Remote-WebDriver-Server herstellen (z.B. Selenium Grid, BrowserStack). Bleibt bestehen.
`--remote-server [server-url]`	Maximale Millisekunden, um auf ein Workflow-Skript zu warten. Standard:
`--script-timeout <ms>`	. Bleibt bestehen. `60000`. Persists.
`--set-distinct-id <id>`	Überschreiben der eindeutigen ID, die für die Nutzungserfassung verwendet wird. Bleibt bestehen.
`--set-tracking-url <url>`	Überschreiben der URL, an die Metrikdaten gesendet werden. Bleibt bestehen.
`-t, --tags [list]`	Kommagetrennte Tags, um zu filtern, welche Regeln ausgeführt werden.
`--user-agent <agent>`	Eigene User-Agent-Zeichenfolge festlegen. Bleibt bestehen.
`--validate`	Die Spezifikationsdateien validieren, ohne sie auszuführen.
`--wait-network-idle-new-connections [number]`	Neue Verbindungsschwelle, bevor das Netzwerk als inaktiv betrachtet wird.
`--wait-network-idle-open-connections [number]`	Offene Verbindungsschwelle, bevor das Netzwerk als inaktiv betrachtet wird.
`--wait-network-idle-timeout [ms]`	Maximale Millisekunden, die auf Netzwerk-Inaktivität gewartet wird, bevor fortgefahren wird.
`--window-size <width,height>`	Fenstergröße des Browsers in Pixeln festlegen. Bleibt bestehen.

`axe config-selenium`

Konfiguriert interaktiv die persistente Browser- und Zeitvorgabendefaults. Siehe Konfiguration für die 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 Axe Developer Hub. Siehe Senden an Axe Developer Hub für die vollständige Dokumentation.

axe devhub <results-directory|file> [options]

Option	Beschreibung
`--axe-devhub-api-key <api-key>`	API-Schlüssel für Axe Developer Hub. Überschreibt die `AXE_DEVHUB_API_KEY` Umgebungsvariable.
`--axe-devhub-project-id <project-id>`	Projekt-ID für Axe Developer Hub.
`--axe-devhub-server-url <url>`	URL des Axe Developer Hub-Servers. Standard: `https://axe.deque.com`.
`--no-git-data`	Keine Git-Branch- und Commit-Daten an Axe Developer Hub senden.

`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 die 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 Ergebnistypen zum Einbeziehen: `passes`, `violations`, `incomplete`, `inapplicable`. Erfordert `--format csv`.
`-f, --format [type(s)]`	Ausgabeformat(e): `html`, `junit`, `csv`, oder eine Kombination. Standard: `html`.

`axe ruleset`

Erzeugt benutzerdefinierte Regeldateien. 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]`	Generiere ein benutzerdefiniertes Regelset aus einem Verzeichnis, das eine `changes.json` Datei enthält.
`-d, --destination [dir]`	Ausgabeverzeichnis. Standard: aktuelles Arbeitsverzeichnis.
`-x, --disable-other-rules`	Deaktiviere 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`, `safari`, `edge`, `ie`. Bleibt bestehen.
`--chrome-options [options]`	Kommagetrennte Chrome-Befehlszeilen-Schalter, die an ChromeDriver übergeben werden. 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`	Browser schließen `alert()`, `confirm()`, und `prompt()` Dialoge vor dem Scannen.
`--download-path <path>`	Legen Sie fest, wo der Browser Downloads speichert (nur Chrome).
`--enable-tracking <state>`	Aktivieren (`true`) oder deaktivieren (`false`) das Senden von Nutzungsdaten an die Metrikbibliothek. Bleibt bestehen.
`-f, --format [value]`	Berichtsformat(e): `html`, `junit`, `csv`, oder eine `+`-getrennte Kombination. Standard: `html`.
`--filter <list>`	Durch Komma getrennte Ergebnistypen zum Einschließen: `passes`, `violations`, `incomplete`, `inapplicable`. Erfordert `--format csv`.
`--headless`	Starten Sie den Browser im Headless-Modus. Bleibt bestehen.
`--interactive-mode`	Erlauben Sie der CLI, auf Seiten zu laufen, die den interaktiven Modus verwenden (nur Chrome).
`--no-analyze`	Entfernen Sie die Anforderung für eine `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 zu den Ergebnissen hinzu. Erfordert `--verbose`.
`--page-timeout <ms>`	Maximale Millisekunden zum Warten auf das Laden einer Seite. Standard: `60000`. Bleibt bestehen.
`--page-title`	Fügen Sie den Seitentitel zu den Ergebnissen hinzu. Erfordert `--verbose`.
`--post-analyze-pause <ms>`	Millisekunden, um nach der Analyse vor der nächsten Aktion zu pausieren. Standard: `2000`. Bleibt bestehen.
`--post-get-pause <ms>`	Millisekunden, um nach dem Laden der Seite und vor dem Scannen zu pausieren. Standard: `2000`. Bleibt bestehen.
`--post-script-pause <ms>`	Millisekunden, um nach einer Skriptaktion und vor dem Scannen zu pausieren. Standard: `2000`. Bleibt bestehen.
`--remote-proxy [proxy-server]`	Leiten Sie den Datenverkehr über einen entfernten Proxy um (nur ChromeDriver). 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 detaillierten Ergebnissen hinzu. Nur Chrome. Erfordert `--verbose`.
`--script-timeout <ms>`	Maximale Millisekunden zum Warten auf ein Workflow-Skript. Standard: `60000`. Bleibt bestehen.
`--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; die Ergebnisse werden nur angezeigt, wenn `--verbose` ebenfalls aktiv ist.
`-t, --tags [list]`	Kommagetrennte Tags zum Filtern, welche Regeln ausgeführt werden.
`--user-agent <agent>`	Legen Sie eine benutzerdefinierte User-Agent-Zeichenfolge fest. Bleibt erhalten.
`--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 Verbindungsschwelle, bevor das Netzwerk als inaktiv gilt.
`--wait-network-idle-open-connections [number]`	Offene Verbindungsschwelle, bevor das Netzwerk als inaktiv gilt.
`--wait-network-idle-polling-every [ms]`	Abfrageintervall in Millisekunden für die Erkennung von Netzwerk-Inaktivität.
`--wait-network-idle-timeout [ms]`	Maximale Millisekunden, die gewartet werden, bevor nach Netzwerk-Inaktivität fortgefahren wird.
`--window-size <width,height>`	Stellen Sie die Größe des Browserfensters in Pixeln ein. Bleibt erhalten.