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 axe.js fichier alternatif. La plupart des utilisateurs n'ont pas besoin de cette option. Elle est destinée aux cas d'utilisation avancés, tels que des tests contre une version spécifique ou corrigé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 Axe Developer Hub. Les résultats sont envoyés au projet associé à l'ID de projet spécifié (spécifié avec l'option --axe-devhub-project-id en ligne de commande) une fois le test terminé. Les deux --axe-devhub-api-key et --axe-devhub-project-id sont requis pour envoyer les résultats au Axe Developer Hub. Voir Utilisation du CLI pour envoyer les résultats d'accessibilité au Axe Developer Hub pour plus d'informations.

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

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

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

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

-c, --custom <path>

Spécifiez un ensemble de règles personnalisé à utiliser. Voir Ensembles de règles personnalisés pour plus d'informations sur la génération d'un fichier d'ensemble 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 spécifique de Chrome lorsque le navigateur par défaut ne peut pas être trouvé ou lorsqu'il est nécessaire d'exécuter une version particulière.

--chromedriver-path <path>

Chemin absolu vers l'exécutable ChromeDriver. ChromeDriver est un binaire séparé du navigateur Chrome lui-même ; il agit comme une passerelle qui traduit les commandes WebDriver de axeen instructions que Chrome peut exécuter.

-d, --dir <path>

Répertoire où le fichier de résultats JSON est enregistré. Sans ce drapeau (ou --save ou --report), aucun fichier n'est écrit et les résultats sont affichés dans le terminal sous forme de résumé lisible par l'homme. Voir aussi -j, --stdout si vous avez besoin d'une sortie lisible par machine sans écrire sur le disque.

-l, --disable <list>

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

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é. Nécessite -r, --report. Voir Création et filtrage de rapports pour plus d'informations sur le contenu de chaque format. Par défaut : html.

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

--filter <list>

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

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

-i, --include <list>

Liste de sélecteurs CSS séparés par des virgules. Lorsqu'elle est spécifiée, axe teste seulement les éléments correspondants, tout le reste sur la page est ignoré. Ceci est très restrictif, et la plupart des utilisateurs devraient utiliser -e, --exclude à la place. Utilisez --include uniquement lorsque vous souhaitez isoler les tests à un composant spécifique, tel que lors du débogage ciblé ou des vérifications CI au niveau 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éterminez combien de 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 pas rapporter les informations de branche Git et de commit lors de l'envoi des résultats vers Axe Developer Hub. Voir Utiliser l'interface CLI pour envoyer les résultats d'accessibilité vers Axe Developer Hub.

--no-reporter

Supprime la sortie du résumé des violations (ID des règles, nombres, sélecteurs affectés et URL d'aide) sans tout silencer. 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 sauvegardez les résultats dans un fichier et utilisez --exit pour le signalement des réussites/échecs et ne voulez pas de détails de violation détaillés dans le journal de construction. Pour un silence complet avec une sortie de résultats JSON, utilisez -j, --stdout à la place.

-q, --exit

Sortir avec le code d'échec 1 si un quelconque test d'accessibilité échoue.

-r, --report <output-dir>

Le 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'humain ou analysable par machine plutôt qu'un JSON brut, par exemple, un rapport HTML à partager avec les parties prenantes ou un fichier XML JUnit pour l'intégration CI. Pour une sortie JSON brute, utilisez -d, --dir à la place.

--rules <list>

Liste d'ID de règles séparés par des virgules à exécuter. Seules les règles spécifiées sont vérifiées ; toutes les autres sont ignorées. Voir les 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 courant. Le nom du fichier est facultatif ; 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 (comme un échec d'initialisation ou une exception lancée pendant l'exécution), il imprime normalement un court message d'erreur sur stderr. Ce drapeau ajoute la trace de pile complète à cette sortie. Cela n'affecte pas la façon dont les violations d'accessibilité sont rapportées. Utilisez ceci lors du débogage d'un fichier --axe-source personnalisé, pour diagnostiquer des échecs inattendus dans CI, ou pour recueillir des informations pour un rapport de bogue.

-t, --tags <list>

Liste de balises séparées par des virgules pour filtrer les règles exécutées. Seules les règles correspondant à au moins une des balises spécifiées sont incluses. Voir la documentation des balises axe-core pour une liste complète des balises 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: le temps que la page a mis à se charger dans le navigateur
• Temps d'exécution axe-core: le temps qu'axe-core a mis pour analyser la page
• Temps total de test: temps total écoulé pour l'exécution

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

--universal-best-practices

Enregistre dans les métadonnées du format universel de sortie. Nécessite bestPracticesEnabled=true . --format universal.

--universal-ruleset <id>

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

-v, --verbose

Moteur de test

• : la version de axe-core utiliséeEnvironnement de test
• : navigateur, largeur et hauteur de la fenêtre, et orientation de l'écranExécuteur de test
• : le nom de l'exécuteurNotez que cette sortie n'apparaît que lorsqu'il y a des violations. Si une page n'a pas de violations, les métadonnées ne sont pas imprimées. Utilisez ceci lorsque vous devez confirmer exactement quelle version de axe-core a été exécutée, vérifier les paramètres de la fenêtre ou inclure les détails de l'environnement dans un rapport de bogue.

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

. axe config-seleniumOption

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