Utilisation de l'interface CLI pour Envoyer les Résultats d'Accessibilité au 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

Présente les différentes manières de télécharger vos résultats d'accessibilité sur Axe Developer Hub en utilisant l'interface CLI

Not for use with personal data

L'interface CLI vous permet d'envoyer vos résultats d'accessibilité à Axe Developer Hub. Vous pouvez :

Télécharger les résultats à partir de tests précédents vers Axe Developer Hub. Cette option utilise la sous-commande CLI devhub et vous permet de télécharger les résultats de l'analyse des pages web à l'aide des API web ou de précédentes exécutions CLI (où vous avez analysé des pages individuelles ou exécuté des fichiers de spécification et enregistré les résultats).
Analyser des pages individuelles et envoyer les résultats directement à Axe Developer Hub (sans d'abord enregistrer les fichiers de résultats).
Exécuter des fichiers de spécifications et envoyer les résultats directement à Axe Developer Hub (sans d'abord enregistrer les fichiers de résultats).

Exigences

Pour utiliser l'interface CLI avec Axe Developer Hub, vous aurez besoin de :

Un compte Axe et un abonnement pour Axe Developer Hub. Voir Commencer avec Axe Developer Hub pour plus d'informations.
Un projet Axe Developer Hub où vous téléchargez les résultats. Voir Créer un Nouveau Projet Axe Developer Hub pour savoir comment créer un nouveau projet. Lorsque vous créez un projet, vous spécifiez que le projet utilisera l'interface CLI comme source d'entrée ou de données. Vous aurez besoin des valeurs suivantes pour télécharger les résultats :
- Votre clé API personnelle (affichée dans votre compte Axe sous Clés API)
- Votre identifiant de projet (affiché dans les instructions lors de la création d'un nouveau projet Axe Developer Hub)
(Optionnel) Si vous avez des tests qui utilisent les APIs web, vous devrez modifier vos tests pour produire un ou plusieurs fichiers de résultats. Un fichier de résultats est un fichier .json contenant les résultats de votre exécution de tests, et la procédure de création de fichiers de résultats est différente en fonction de l'API que vous utilisez. Pour plus de détails, voir Création de fichiers de résultats. Vous utilisez la sous-commande devhub pour télécharger les fichiers de résultats.

Envoi de Résultats à Axe Developer Hub

Normalement, l'interface CLI teste les sites web et produit des résultats uniquement lorsque vous utilisez l'option -s pour enregistrer les résultats (qui sont des fichiers .json contenant des informations sur les erreurs d'accessibilité des sites web testés). Vous pouvez envoyer vos résultats à Axe Developer Hub en spécifiant une clé API sur la ligne de commande avec l'option --axe-devhub-api-key (ou en définissant la variable d'environnement AXE_DEVHUB_API_KEY) et un identifiant de projet avec --axe-devhub-project-id (ou en définissant la variable d'environnement AXE_DEVHUB_PROJECT_ID).

Par défaut, le CLI télécharge également les informations Git si le répertoire où vous exécutez le CLI fait partie d'un dépôt Git. Voir Mode Git versus Sans Git pour des informations sur le fonctionnement de l'envoi des informations Git.

Le CLI associera la branche Git actuelle et l'historique des commits à vos résultats d'accessibilité.

important

Lorsque vous exécutez l'interface CLI depuis un répertoire dans un dépôt Git, les résultats que vous envoyez à Axe Developer Hub écraseront les résultats précédents du même commit (déterminé par son SHA). (Un seul ensemble de résultats peut être associé à chaque commit.) Vous devez créer un nouveau commit à chaque fois que vous exécutez l'interface CLI ou renoncer à rapporter les résultats Git en utilisant l'option --no-git-data. Voir Mode Git versus Sans Git pour plus d'informations.

Télécharger des Résultats

Si vous avez précédemment exécuté des tests et disposez de fichiers de résultats (fichiers .json généralement avec des noms tels que axe-result-2025-09-03T14 02 32-0700.json), vous pouvez télécharger ces résultats sur Axe Developer Hub avec la sous-commande devhub. Vous pouvez enregistrer les résultats en utilisant l'option de ligne de commande -s lors de l'analyse de pages ou de l'exécution de fichiers de spécification :

axe https://example.com -s

tip

Lors de l'analyse d'une page ou de l'exécution d'un fichier de spécifications, vous n'avez pas besoin de sauvegarder d'abord les résultats, puis de les télécharger. En spécifiant une clé API et un ID de projet, le CLI transmettra les résultats lorsque l'analyse de votre page sera terminée ou lorsque l'exécution de votre fichier de spécifications sera terminée. Voir Analyser des pages individuelles et Exécuter des fichiers de spécification.

L'exemple précédent crée un fichier de résultats que vous pouvez ensuite télécharger sur Axe Developer Hub, comme indiqué ci-dessous :

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

Vous pouvez utiliser . (point) comme le répertoires-ou-fichiers-de-résultats pour télécharger tous les fichiers de résultats .json dans le répertoire actuel. Vous pouvez également spécifier plusieurs répertoires ou fichiers à télécharger.

Création de fichiers de résultats avec les APIs web

Si vous utilisez les API web, vous devrez modifier vos tests API pour écrire des fichiers de résultats que vous pourrez ensuite télécharger sur Axe Developer Hub à l'aide de la sous-commande devhub. Le tableau suivant contient des liens vers des informations sur la création de fichiers de résultats, et ces API utilisent les API de rapport ou de journalisation fournies pour écrire les résultats sous forme de fichiers .json sur le disque.

API	Nom du lien
Node.js	Axe DevTools Logger
C#	Créer du JSON compatible avec le reporter
Java	Générer des rapports avec Java
Python	Créer du JSON compatible avec le reporter
Ruby	Options de reporting

Analyser des pages individuelles

Vous pouvez analyser des pages web individuelles et envoyer les résultats à Axe Developer Hub en spécifiant une clé API et l'identifiant de projet pour que les résultats soient reçus par le projet :

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

Dans cet exemple, l'interface CLI exécute des tests d'accessibilité sur le site de Google puis envoie les résultats au projet Axe Developer Hub référencé par l'identifiant de projet spécifié.

Vous pouvez également lister plusieurs pages sur la ligne de commande à tester :

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>

Visitez le projet sur Axe Developer Hub pour voir vos résultats. Voir Vue d'ensemble des problèmes d’accessibilité.

Exécuter des fichiers de spécification

Vous pouvez envoyer les résultats de l'exécution de vos fichiers de spécification en utilisant les options de ligne de commande --axe-devhub-api-key et --axe-devhub-project-id.

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

Cet exemple exécute le fichier de spécification YAML my-spec-file.yml et télécharge ses résultats d'accessibilité vers Axe Developer Hub. Voir Spécifications de flux de travail et Actions de flux de travail pour plus d'informations sur les fichiers de spécification.

tip

Si vous avez besoin de passer à la suite dans votre fichier de spécification en contournant les tests de pages, vous pouvez utiliser l'option de ligne de commande --resume-from <page> pour reprendre vos tests à partir d'une page spécifique dans votre fichier de spécification. Voir Reprendre à partir de pour plus d'informations.

Mode Git versus Sans Git

Par défaut, Axe Developer Hub associe vos résultats d'accessibilité avec le dernier commit Git sur la branche actuelle lorsque vous exécutez l'interface CLI depuis un répertoire dans un dépôt Git, vous permettant ainsi de lier facilement les erreurs d'accessibilité aux commits Git. Un effet secondaire de ce comportement est que chaque fois que vous rapportez des résultats à Axe Developer Hub, de nouveaux résultats écrasent toute autre exécution sur le même commit (basée sur son SHA). De plus, si vous passez à une autre branche, tous les résultats que vous envoyez à Axe Developer Hub seront associés au dernier commit de cette branche.

Si le comportement par défaut de Axe Developer Hub ne vous convient pas :

Vous pouvez utiliser la CLI dans un répertoire en dehors d'un dépôt Git.
Vous pouvez utiliser l'option de ligne de commande --no-git-data pour éviter le rapport d'informations Git au serveur, fonctionnant dans ce qu'on appelle le mode Sans Git où chaque fois que vous rapportez des résultats au serveur, une nouvelle exécution de test est créée et identifiée par l'heure et la date de l'exécution plutôt que par la branche et le commit comme en mode Git.

Voir Les pages de votre projet et La page des exécutions de test pour des informations sur la manière dont les résultats Git et sans Git sont organisés et présentés dans Axe Developer Hub.

Options de ligne de commande

La CLI accepte ces options de ligne de commande :

--axe-devhub-api-key Vous permet de définir votre clé API personnelle, équivalent à la variable d'environnement AXE_DEVHUB_API_KEY. Requis
--axe-devhub-project-id Définit l'identifiant de projet pour votre projet Axe Developer Hub, équivalent à la variable d'environnement AXE_DEVHUB_PROJECT_ID. Requis
--axe-devhub-server-url Vous permet d'utiliser un serveur autre que le serveur par défaut (https://axe.deque.com), équivalent à la variable d'environnement AXE_DEVHUB_SERVER_URL. Définissez cela si votre organisation utilise une instance régionale, un cloud privé ou un déploiement sur site de Axe Developer Hub. Optionnel
--no-git-data Évite de rapporter les informations Git au serveur. Voir Mode Git versus Sans Git pour plus d'informations. N'a pas de variable d'environnement équivalente. Optionnel

Variables d'environnement

Vous pouvez définir des variables d'environnement pour éviter de spécifier la clé API, l'identifiant du projet, ou l'URL du serveur sur la ligne de commande, ce qui est recommandé lors de l'utilisation de la clé API en intégration continue pour la garder secrète.

tip

Définir AXE_DEVHUB_API_KEY et AXE_DEVHUB_PROJECT_ID permettra de toujours envoyer les résultats à Axe Developer Hub chaque fois que vous analysez une page ou exécutez un fichier de spécification. Par exemple, si vous avez défini ces variables d'environnement et analysez une page avec :

axe https://somewebsite.com

Les résultats seront envoyés à Axe Developer Hub. Ce comportement s'applique lorsque vous utilisez l'interface CLI pour analyser une page ou exécuter un fichier de spécification.

AXE_DEVHUB_API_KEY Spécifie votre clé API personnelle, équivalent à l'option de ligne de commande --axe-devhub-api-key.
AXE_DEVHUB_PROJECT_ID Spécifie l'identifiant de projet pour votre projet Axe Developer Hub, équivalent à l'option de ligne de commande --axe-devhub-project-id.
AXE_DEVHUB_SERVER_URL Spécifie l'URL du serveur Axe Developer Hub (par défaut est https://axe.deque.com), équivalent à l'option de ligne de commande --axe-devhub-server-url. Définissez cela si votre organisation utilise une instance régionale, un cloud privé ou un déploiement sur site de Axe Developer Hub.