Tester des pages avec l'outil CLI

Lorsque vous utilisez le mode d'entrée URI du CLI, plusieurs options supplémentaires sont disponibles pour modifier le périmètre et l'ensemble de règles d'un test. Par exemple, le code suivant exclura l'en-tête et le pied de page d'un test et désactivera la règle de contraste des couleurs :

axe http://example.com --exclude footer,header --disable color-contrast

Options

-a, --axe-source <path>

Chemin vers un fichier axe.js alternatif. La plupart des utilisateurs n'ont pas besoin de cette option. Elle est destinée aux cas d'utilisation avancés, tels que les tests avec une version spécifique ou modifiée de axe-core.

--axe-devhub-api-key <your-API-key>

Spécifiez la clé API du compte Axe à utiliser pour envoyer les résultats d'accessibilité au Hub des développeurs Axe. Les résultats sont envoyés au projet associé à l'ID de projet spécifié (défini avec l'option en ligne de commande --axe-devhub-project-id) une fois les tests terminés. Les deux --axe-devhub-api-key et --axe-devhub-project-id sont nécessaires pour envoyer les résultats au Hub des développeurs Axe. Voir Utiliser l'interface CLI pour envoyer les résultats d'accessibilité vers Axe Developer Hub pour plus d'informations.

--axe-devhub-project-id <your-project-ID>

Spécifiez l'ID de projet du Hub des développeurs Axe pour recevoir les résultats des tests d'accessibilité. Les deux --axe-devhub-api-key et --axe-devhub-project-id sont nécessaires pour envoyer les résultats au Hub des développeurs Axe. Voir Utiliser l'interface CLI pour envoyer les résultats d'accessibilité vers Axe Developer Hub pour plus d'informations.

--axe-devhub-server-url <url>

Spécifiez l'URL du serveur du Hub des développeurs Axe. Par défaut : https://axe.deque.com. Équivalent à la variable d'environnement AXE_DEVHUB_SERVER_URL. Voir Utiliser l'interface CLI pour envoyer les résultats d'accessibilité vers Axe Developer Hub pour plus d'informations.

-c, --custom <path>

Spécifiez un jeu de règles personnalisé à utiliser. Voir Ensembles de règles personnalisés pour les détails sur la génération d'un fichier de jeu de règles.

--chrome-options [options]

Liste séparée par des virgules des options de ligne de commande de Chrome à transmettre au navigateur. Par exemple :

axe http://example.com --chrome-options="some-switch,some-other-switch"

--chrome-path <path>

Chemin absolu vers l'exécutable du navigateur Chrome. Utilisez ceci pour pointer axe vers une installation particulière de Chrome lorsque le navigateur par défaut ne peut pas être trouvé, ou si vous devez utiliser une version spécifique.

--chromedriver-path <path>

Chemin absolu vers l'exécutable ChromeDriver. ChromeDriver est un binaire séparé du navigateur Chrome ; il sert de pont qui traduit les commandes WebDriver de axe en instructions que Chrome peut exécuter.

-d, --dir <path>

Le répertoire où le fichier de résultats JSON est enregistré. Sans ce flag (ni --save ni --report), aucun fichier n'est écrit et les résultats sont affichés dans le terminal comme un résumé lisible par l'homme à la place. Voir également -j, --stdout si vous avez besoin d'une sortie lisible par machine sans écrire sur le disque.

-l, --disable <list>

Liste d'ID de règles à désactiver, séparée par des virgules. Voir descriptions des règles axe-core pour une liste complète des ID de règles.

axe http://example.com --disable color-contrast,duplicate-id

-e, --exclude <list>

Liste séparée par des virgules des sélecteurs CSS pour les éléments à exclure des tests. Par exemple :

# Exclude by element type
axe http://example.com --exclude footer,header

# Exclude by class or ID
axe http://example.com --exclude ".ad-banner,#cookie-notice"

# Exclude by attribute
axe http://example.com --exclude "[aria-hidden=true]"

-f, --format <value>

Format du rapport généré. Requiert -r, --report. Voir Création et filtrage de rapports pour les détails sur ce que contient chaque format. Par défaut : html.

axe http://example.com --report ./reports --format html+junit+csv

--filter <list>

Liste de types de résultats à inclure dans la sortie CSV, séparée par des virgules. Seuls les types spécifiés apparaîtront ; tous les autres sont exclus. Les valeurs valides sont passes, violations, incomplete, et inapplicable. Requiert --format csv.

axe reporter ./axe-reports/json/ --format=csv --filter passes,inapplicable

-i, --include <list>

Liste de sélecteurs CSS séparée par des virgules. Lorsqu'ils sont spécifiés, axe teste seulement les éléments correspondants, et tout le reste sur la page est ignoré. Cela est très restrictif, et la plupart des utilisateurs devraient plutôt utiliser -e, --exclude. Utilisez --include uniquement lorsque vous souhaitez isoler les tests sur un composant spécifique, par exemple, lors de débogages ciblés ou de contrôles CI au niveau du composant.

# Test only the main navigation
axe http://example.com --include nav

# Test only elements with a specific class or ID
axe http://example.com --include ".my-widget,#signup-form"

# Test only elements with a specific attribute
axe http://example.com --include "[data-testid=checkout]"

-j, --stdout

Écrit les résultats complets sous forme de JSON lisible par machine sur stdout au lieu du résumé lisible par l'humain. Tout autre affichage est silencé. Utilisez cela lorsque vous transmettez les résultats à un autre programme.

--load-delay <n>

Définissez le temps (en millisecondes) axe attendra après le chargement de la page avant de lancer l'audit (par défaut : 0).

--no-git-data

Ne signalez pas d'informations sur la branche et le commit Git lors de l'envoi des résultats au Hub des développeurs Axe. Voir Utiliser l'interface CLI pour envoyer les résultats d'accessibilité vers Axe Developer Hub.

--no-reporter

Supprime la sortie de synthèse des violations (ID de règles, comptes, sélecteurs affectés, et URL d'aide) sans tout réduire au silence. Les messages de progression et les résultats écrits sur disque via --save, --dir ou --report ne sont pas affectés. Principalement utile dans les pipelines CI où vous enregistrez les résultats dans un fichier et utilisez --exit pour le signalement de réussite/échec et ne voulez pas de détails de violation verbosité dans le journal de construction. Pour un silence complet avec la sortie de résultats JSON, utilisez plutôt -j, --stdout.

-q, --exit

Quitter avec le code d'échec 1 si des tests d'accessibilité échouent.

-r, --report <output-dir>

Répertoire où le rapport formaté est écrit. Fonctionne avec -f, --format pour contrôler le format de sortie (HTML par défaut). Utilisez ceci lorsque vous souhaitez un rapport lisible par l'homme ou analysable par une machine plutôt qu'un JSON brut, par exemple, un rapport HTML à partager avec des parties prenantes ou un fichier XML JUnit pour une intégration CI. Pour une sortie JSON brute, utilisez -d, --dir à la place.

--rules <list>

Liste d'ID de règles à exécuter, séparée par des virgules. Seules les règles spécifiées sont vérifiées ; toutes les autres sont ignorées. Voir descriptions des règles axe-core pour une liste complète des ID de règles.

axe http://example.com --rules color-contrast,duplicate-id

-s, --save [filename]

Enregistrez les résultats en tant que fichier JSON dans le répertoire actuel. Le nom de fichier est optionnel ; s'il est omis, le fichier est nommé axe-result.json. Pour enregistrer dans un répertoire spécifique à la place, utilisez -d, --dir.

--show-errors

Lorsque axe rencontre une erreur d'exécution (telle qu'une échec d'initialisation ou une exception levée pendant l'exécution), il imprime normalement un bref message d'erreur sur stderr. Ce flag ajoute la trace de la pile complète à cette sortie. Cela ne modifie pas la manière dont les violations d'accessibilité sont signalées. Utilisez ceci lors du débogage d'un fichier --axe-source personnalisé, du diagnostic de défaillances inattendues dans CI, ou de la collecte d'informations pour un rapport de bogue.

-t, --tags <list>

Liste de tags séparée par des virgules pour filtrer les règles à exécuter. Seules les règles correspondant à au moins un des tags spécifiés sont incluses. Voir documentation des balises axe-core pour une liste complète des tags disponibles.

axe http://example.com --tags wcag2a,wcag2aa

--timer

Imprime trois mesures de temps à la console après chaque exécution de test :

• Temps de chargement de la page Axe : durée de chargement de la page dans le navigateur
• Temps d'exécution axe-core : durée de l'analyse de la page par axe-core
• Temps total de test : temps écoulé total pour l'exécution

Utilisez ceci pour diagnostiquer les tests lents. Par exemple, utilisez cette option pour déterminer si le temps est passé à attendre le chargement de la page ou dans l'analyse Axe, ou pour enquêter sur la raison pour laquelle une exécution atteint les limites de --page-timeout ou de --script-timeout.

--universal-best-practices

Enregistre bestPracticesEnabled=true dans les métadonnées de la sortie au format universel. Requiert --format universal.

--universal-ruleset <id>

Spécifie l'ID du jeu de règles à enregistrer dans les métadonnées de la sortie au format universel. Par défaut : wcag2.1. Requiert --format universal.

-v, --verbose

Moteur de test

• : la version de axe-core utilisée : version de axe-core utilisée
• : navigateur, largeur et hauteur de la fenêtre, et orientation de l'écran : user agent du navigateur, largeur et hauteur de la vue, et orientation de l'écran
• : le nom de l'exécuteur : nom du coureur

Options de configuration

Les options suivantes contrôlent le comportement du navigateur et le timing des tests. Contrairement aux options ci-dessus, celles-ci persistent entre les exécutions de la CLI ; les définir une fois enregistre la valeur dans un fichier de préférences utilisé pour toutes les exécutions futures. Elles peuvent également être définies de manière interactive en utilisant

Les options suivantes contrôlent le comportement du navigateur et le timing des tests. Contrairement aux options ci-dessus, celles-ci persistent entre les exécutions CLI ; les définir une fois enregistre la valeur dans un fichier de préférences utilisé pour toutes les exécutions futures. Elles peuvent également être définies de manière interactive à l'aide de axe config-selenium.

Pour plus de détails, voir Options de configuration.