CLI zur Übermittlung von Barrierefreiheitsergebnissen an axe Developer Hub nutzen

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

Diskutiert die verschiedenen Möglichkeiten, Ihre Barrierefreiheitsergebnisse mit dem CLI an axe Developer Hub hochzuladen

Not for use with personal data

Mit dem CLI können Sie Ihre Barrierefreiheitsergebnisse an axe Developer Hub senden. Sie können:

Ergebnisse hochladen von früheren Testläufen an axe Developer Hub. Diese Option verwendet den CLI-Unterbefehl devhub und ermöglicht es Ihnen, Ergebnisse vom Analysieren von Webseiten unter Verwendung der Web-APIs oder von früheren CLI-Läufen (bei denen Sie einzelne Seiten analysiert oder Spezifikationsdateien ausgeführt und die Ergebnisse gespeichert haben) hochzuladen.
Einzelne Seiten analysieren und Ergebnisse direkt an axe Developer Hub senden (ohne zuerst Ergebnisdateien zu speichern).
Spezifikationsdateien ausführen und Ergebnisse direkt an axe Developer Hub senden (ohne zuerst Ergebnisdateien zu speichern).

Anforderungen

Um das CLI mit Axe Developer Hub zu nutzen, benötigen Sie:

Ein axe-Konto und ein Abonnement für axe Developer Hub. Siehe Erste Schritte mit axe Developer Hub für weitere Informationen.
Ein axe Developer Hub-Projekt, in dem Sie Ergebnisse hochladen. Siehe Ein neues axe Developer Hub-Projekt erstellen für Informationen zur Erstellung eines neuen Projekts. Wenn Sie ein Projekt erstellen, geben Sie an, dass das Projekt das CLI als Eingabe- oder Datenquelle verwenden wird. Sie benötigen folgende Werte, um Ergebnisse hochzuladen:
- Ihren persönlichen API-Schlüssel (angezeigt in Ihrem axe-Konto unter API-Schlüssel)
- Ihre Projekt-ID (angezeigt in den Anweisungen, wenn Sie ein neues axe Developer Hub-Projekt erstellen)
(Optional) Wenn Sie Tests haben, die die Web-APIs verwenden, müssen Sie Ihre Tests ändern, um eine Ergebnisdatei oder -dateien zu erstellen. Eine Ergebnisdatei ist eine .json-Datei, die die Ergebnisse Ihres Testlaufs enthält, und das Verfahren zur Erstellung von Ergebnisdateien variiert je nach verwendeter API. Für weitere Details siehe Ergebnisdateien erstellen. Sie verwenden den devhub-Unterbefehl, um Ergebnisdateien hochzuladen.

Ergebnisse an axe Developer Hub senden

Normalerweise testet das CLI Websites und erzeugt Ergebnisse nur, wenn Sie die Option -s verwenden, um Ergebnisse zu speichern (die .json-Dateien enthalten Informationen über Barrierefreiheitsfehler in den getesteten Websites). Sie können Ihre Ergebnisse an axe Developer Hub senden, indem Sie einen API-Schlüssel in der Befehlszeile mit der --axe-devhub-api-key-Befehlszeilenoption angeben (oder, indem Sie die AXE_DEVHUB_API_KEY-Umgebungsvariable setzen) und eine Projekt-ID mit der --axe-devhub-project-id angeben (oder, indem Sie die AXE_DEVHUB_PROJECT_ID-Umgebungsvariable setzen).

Standardmäßig lädt das CLI auch Git-Informationen hoch, wenn das Verzeichnis, in dem Sie das CLI ausführen, Teil eines Git-Repositories ist. Siehe Git- versus Gitless-Modus für Informationen darüber, wie das Hochladen von Git-Informationen funktioniert.

Das CLI wird den aktuellen Git-Branch und die Commit-Historie mit Ihren Barrierefreiheitsergebnissen verknüpfen.

important

Wenn Sie das CLI aus einem Verzeichnis innerhalb eines Git-Repositories heraus ausführen, werden die Ergebnisse, die Sie an axe Developer Hub senden, alle vorherigen Ergebnisse vom selben Commit (bestimmt durch seinen SHA) überschreiben. (Nur ein Satz von Ergebnissen kann mit jedem Commit verknüpft werden.) Sie müssen jedes Mal ein neues Commit erstellen, wenn Sie das CLI ausführen, oder darauf verzichten, Git-Ergebnisse zu melden, indem Sie die Option --no-git-data verwenden. Siehe Git- versus Gitless-Modus für weitere Informationen.

Ergebnisse hochladen

Wenn Sie zuvor Tests ausgeführt haben und Ergebniss-Dateien (.json-Dateien, typischerweise mit Namen wie axe-result-2025-09-03T14 02 32-0700.json) besitzen, können Sie diese Ergebnisse mit dem devhub-Unterbefehl an axe Developer Hub hochladen. Sie können Ergebnisse speichern, indem Sie die -s-Befehlszeilenoption verwenden, wenn Sie Seiten testen oder Spezifikationsdateien ausführen:

axe https://example.com -s

tip

Beim Analysieren einer Seite oder Ausführen einer Spezifikationsdatei müssen Sie die Ergebnisse nicht erst speichern und dann hochladen. Indem Sie einen API-Schlüssel und eine Projekt-ID angeben, lädt das CLI die Ergebnisse hoch, wenn Ihre Seitenanalyse abgeschlossen ist oder wenn Ihre Spezifikationsdatei die Ausführung beendet. Siehe Einzelne Seiten analysieren und Spezifikationsdateien ausführen.

Das obige Beispiel erstellt eine Ergebnisdatei, die Sie dann an axe Developer Hub hochladen können, wie unten gezeigt:

axe devhub <results-dir(s)-or-file(s)> --axe-devhub-api-key <your-API-key> --axe-devhub-project-id <your-project-ID>

Sie können . (Punkt) als ergebnis-verzeichnisse)-oder-dateien) verwenden, um alle .json-Ergebnisdateien im aktuellen Verzeichnis hochzuladen. Sie können auch mehrere Verzeichnisse oder Dateien angeben, die hochgeladen werden sollen.

Ergebnisdateien mit den Web-APIs erstellen

Wenn Sie die Web-APIs verwenden, müssen Sie Ihre API-Tests anpassen, um Ergebnisdateien zu schreiben, die Sie dann mit dem devhub-Unterbefehl an axe Developer Hub hochladen können. Die folgende Tabelle enthält Links mit Informationen zur Erstellung von Ergebnisdateien, und diese APIs verwenden die bereitgestellten Bericht- oder Protokollierungs-APIs, um Ergebnisse als .json-Dateien auf die Festplatte zu schreiben.

API	Linkname
Node.js	axe DevTools Logger
C#	Reporter-kompatibles JSON erstellen
Java	Berichte mit Java generieren
Python	Reporter-kompatibles JSON erstellen
Ruby	Meldungsoptionen

Einzelne Seiten analysieren

Sie können einzelne Webseiten scannen und die Ergebnisse an das axe Developer Hub senden, indem Sie einen API-Schlüssel und die Projekt-ID für das Projekt angeben, das die Ergebnisse erhalten soll:

axe https://google.com --axe-devhub-api-key <your-API-key> --axe-devhub-project-id <your-project-ID>

In diesem Beispiel führt das CLI Barrierefreiheitstests gegen die Website von Google durch und sendet dann die Ergebnisse an das axe Developer Hub Projekt, das durch die angegebene Projekt-ID referenziert wird.

Sie können auch mehrere Seiten auf der Befehlszeile zur Prüfung angeben:

axe https://example.com/page1.html https://example.com/page2.html --axe-devhub-api-key <your-API-key> --axe-devhub-project-id <your-project-ID>

Besuchen Sie das Projekt im axe Developer Hub, um Ihre Ergebnisse zu sehen. Siehe Übersicht über die Ansicht von Barrierefreiheitsthemen.

Prüfdateien ausführen

Sie können die Ergebnisse des Ausführens Ihrer Prüfdateien senden, indem Sie die Befehlszeilenoptionen --axe-devhub-api-key und --axe-devhub-project-id verwenden.

axe spec my-spec-file.yml --axe-devhub-api-key <your-API-key> --axe-devhub-project-id <your-project-ID>

Dieses Beispiel führt die YAML-Prüfdatei my-spec-file.yml aus und lädt die Ergebnisse zur Barrierefreiheit ins axe Developer Hub hoch. Siehe Ablaufprüfungen und Arbeitsflussaktionen für weitere Informationen über Prüfdateien.

tip

Wenn Sie in Ihrer Prüfdatei zu einem bestimmten Punkt vorrücken müssen, indem Sie das Testen von Seiten überspringen, können Sie die Befehlszeilenoption --resume-from <page> verwenden, um Ihre Tests von einer bestimmten Seite in Ihrer Prüfdatei fortzusetzen. Siehe Fortfahren von für weitere Informationen.

Git versus Gitless-Modus

Standardmäßig ordnet das axe Developer Hub Ihre Barrierefreiheitsergebnisse dem neuesten Git-Commit auf dem aktuellen Branch zu, wenn Sie das CLI aus einem Verzeichnis innerhalb eines Git-Repositories ausführen. Dies ermöglicht es Ihnen, Barrierefreiheitsfehler leicht mit Git-Commits zu verknüpfen. Ein Nebeneffekt dieses Verhaltens ist jedoch, dass, wann immer Sie Ergebnisse an das axe Developer Hub melden, neue Ergebnisse alle anderen Läufe überschreiben auf demselben Commit (basierend auf seinem SHA). Außerdem werden, wenn Sie zu einem anderen Branch wechseln, alle Ergebnisse, die Sie an das axe Developer Hub senden, dem neuesten Commit auf diesem Branch zugeordnet.

Wenn das Standardverhalten des axe Developer Hub nicht Ihren Wünschen entspricht:

Sie können das CLI in einem Verzeichnis außerhalb eines Git-Repositories verwenden.
Sie können die Befehlszeilenoption --no-git-data verwenden, um auf die Übermittlung von Git-Informationen an den Server zu verzichten. Dies wird als Gitless Modus bezeichnet, wobei jedes Mal, wenn Sie Ergebnisse an den Server melden, ein neuer Testlauf erstellt und durch Zeitpunkt und Datum des Laufs identifiziert wird, im Gegensatz zum Branch und Commit im Git Modus.

Siehe Die Seiten Ihres Projekts und Die Testruns-Seite für Informationen darüber, wie Git- und Gitless-Ergebnisse im axe Developer Hub organisiert und präsentiert werden.

Befehlszeilenoptionen

Der CLI akzeptiert diese Befehlszeilenoptionen:

--axe-devhub-api-key Ermöglicht es Ihnen, Ihren persönlichen API-Schlüssel festzulegen, was dem AXE_DEVHUB_API_KEY Umgebungsvariable entspricht. Erforderlich
--axe-devhub-project-id Setzt die Projekt-ID für Ihr axe Developer Hub Projekt, was der AXE_DEVHUB_PROJECT_ID Umgebungsvariable entspricht. Erforderlich
--axe-devhub-server-url Ermöglicht die Verwendung eines anderen Servers als dem Standard (https://axe.deque.com), was der AXE_DEVHUB_SERVER_URL Umgebungsvariable entspricht. Setzen Sie dies, wenn Ihre Organisation eine regionale Instanz, private Cloud oder eine On-Premises-Bereitstellung von Axe Developer Hub verwendet. Optional
--no-git-data Vermeidet die Übermittlung von Git-Informationen an den Server. Siehe Git versus Gitless-Modus für weitere Informationen. Hat keine entsprechende Umgebungsvariable. Optional

Umgebungsvariablen

Sie können Umgebungsvariablen festlegen, um zu vermeiden, dass der API-Schlüssel, die Projekt-ID oder die Server-URL auf der Befehlszeile angegeben werden müssen. Dies wird empfohlen, wenn Sie den API-Schlüssel in der kontinuierlichen Integration verwenden, um ihn geheim zu halten.

tip

Das Setzen von AXE_DEVHUB_API_KEY und AXE_DEVHUB_PROJECT_ID wird immer die Ergebnisse an das axe Developer Hub senden, wann immer Sie eine Seite analysieren oder eine Prüfdatei ausführen. Zum Beispiel, wenn Sie diese Umgebungsvariablen gesetzt haben und eine Seite analysieren mit:

axe https://somewebsite.com

Die Ergebnisse werden an das axe Developer Hub gesendet. Dieses Verhalten tritt auf, wenn Sie das CLI verwenden, um eine Seite analysieren oder eine Prüfdatei ausführen.

AXE_DEVHUB_API_KEY Gibt Ihren persönlichen API-Schlüssel an, was der --axe-devhub-api-key Befehlszeilenoption entspricht.
AXE_DEVHUB_PROJECT_ID Gibt die Projekt-ID für Ihr axe Developer Hub Projekt an, was der --axe-devhub-project-id Befehlszeilenoption entspricht.
AXE_DEVHUB_SERVER_URL Gibt die URL des Axe Developer Hub-Servers an (standardmäßig https://axe.deque.com), was der --axe-devhub-server-url Befehlszeilenoption entspricht. Setzen Sie dies, wenn Ihre Organisation eine regionale Instanz, private Cloud oder eine On-Premises-Bereitstellung von Axe Developer Hub verwendet.