Verwendung der CLI zum Senden von Barrierefreiheitsergebnissen an Axe Developer Hub

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

Erörtert die verschiedenen Möglichkeiten, wie Sie Ihre Barrierefreiheitsergebnisse mit der CLI an den Axe Developer Hub hochladen können

Not for use with personal data

Mit der CLI können Sie Ihre Barrierefreiheitsergebnisse an den Axe Developer Hub senden. Sie können:

Ergebnisse hochladen von vorherigen Testläufen an den Axe Developer Hub. Diese Option verwendet den CLI-Teilbefehl devhub und ermöglicht Ihnen, Ergebnisse aus der Analyse von Webseiten über die Web-APIs oder aus vorherigen 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 den Axe Developer Hub senden (ohne vorher Ergebnisse zu speichern).
Spezifikationsdateien ausführen und Ergebnisse direkt an den Axe Developer Hub senden (ohne vorher Ergebnisse zu speichern).

Anforderungen

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

Ein Axe-Konto und ein Abonnement für den Axe Developer Hub. Weitere Informationen finden Sie unter Erste Schritte mit Axe Developer Hub.
Ein Axe Developer Hub-Projekt, in das Sie Ergebnisse hochladen. Informationen zum Erstellen eines neuen Projekts finden Sie unter Ein neues Axe Developer Hub-Projekt erstellen. Wenn Sie ein Projekt erstellen, geben Sie an, dass das Projekt die CLI als Eingabe- oder Datenquelle verwenden wird. Sie benötigen diese 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 die CLI Websites und erzeugt Ergebnisse nur, wenn Sie die Option -s verwenden, um Ergebnisse zu speichern (welche .json Dateien sind, die Informationen über Barrierefreiheitsfehler in den getesteten Websites enthalten). Sie können Ihre Ergebnisse an den Axe Developer Hub senden, indem Sie einen API-Schlüssel über die Befehlszeile mit der --axe-devhub-api-key-Option angeben (oder indem Sie die AXE_DEVHUB_API_KEY-Umgebungsvariable setzen) und eine Projekt-ID mit der --axe-devhub-project-id-Option 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 die CLI aus einem Verzeichnis innerhalb eines Git-Repositorys ausführen, werden die Ergebnisse, die Sie an den Axe Developer Hub senden, alle vorherigen Ergebnisse desselben Commits (bestimmt durch seinen SHA) überschreiben. (Nur ein Satz von Ergebnissen kann mit jedem Commit verbunden sein.) Sie müssen jedes Mal, wenn Sie die CLI ausführen, einen neuen Commit erstellen oder durch die Verwendung der Option --no-git-data auf die Berichterstattung von Git-Ergebnissen verzichten. Weitere Informationen finden Sie unter Git versus Gitless-Modus.

Ergebnisse hochladen

Wenn Sie zuvor Tests durchgeführt haben und Ergebnisdateien (.json-Dateien mit typischen Namen wie axe-result-2025-09-03T14 02 32-0700.json) besitzen, können Sie diese Ergebnisse mit dem devhub-Teilbefehl zum Axe Developer Hub hochladen. Sie können Ergebnisse speichern, indem Sie die -s-Option in der Befehlszeile 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 Prüfdateien ausführen.

Das vorherige Beispiel erstellt eine Ergebnisdatei, die Sie dann an den 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 so ändern, dass sie Ergebnisdateien schreiben, die Sie dann mit dem devhub-Teilbefehl zum Axe Developer Hub hochladen können. Die folgende Tabelle enthält Links zu Informationen über das Erstellen von Ergebnisdateien, und diese APIs verwenden die bereitgestellten Reporting- oder Logging-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 den 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 die CLI Barrierefreiheitstests auf der Google-Website durch und sendet die Ergebnisse dann 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-Spezifikationsdatei my-spec-file.yml aus und lädt deren Barrierefreiheitsergebnisse in den Axe Developer Hub hoch. Weitere Informationen über Spezifikationsdateien finden Sie unter Ablaufprüfungen und Arbeitsflussaktionen.

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 der Axe Developer Hub Ihre Barrierefreiheitsergebnisse beim Ausführen der CLI aus einem Verzeichnis innerhalb eines Git-Repositorys dem neuesten Git-Commit auf dem aktuellen Branch zu, sodass Sie Barrierefreiheitsfehler leicht Git-Commits zuordnen können. Ein Nebeneffekt dieses Verhaltens ist jedoch, dass bei der Berichterstattung von Ergebnissen an den Axe Developer Hub neue Ergebnisse alle anderen Läufe auf demselben Commit (basierend auf dessen SHA) überschreiben. Wenn Sie zu einem anderen Branch wechseln, werden alle Ergebnisse, die Sie an den Axe Developer Hub senden, dem neuesten Commit auf diesem Branch zugeordnet.

Wenn das standardmäßige Verhalten 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 dargestellt 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, entspricht der AXE_DEVHUB_PROJECT_ID-Umgebungsvariable. 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

Durch das Setzen von AXE_DEVHUB_API_KEY und AXE_DEVHUB_PROJECT_ID wird immer Ergebnisse an den Axe Developer Hub senden, wann immer Sie eine Seite analysieren oder eine Spezifikationsdatei ausführen. Wenn Sie beispielsweise diese Umgebungsvariablen gesetzt haben und eine Seite analysieren mit:

axe https://somewebsite.com

Die Ergebnisse werden an den Axe Developer Hub gesendet. Dieses Verhalten tritt auf, wenn Sie die 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, entspricht der --axe-devhub-project-id-Befehlszeilenoption.
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.