Tester des pages avec CLI

Lors de l'utilisation du mode d'entrée URI du CLI, plusieurs options supplémentaires sont disponibles pour modifier la portée et le jeu 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 à des cas d'utilisation avancés tels que des tests contre une version spécifique ou corrigée d'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é à 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 de la ligne de commande) après que le test est terminé. Les deux --axe-devhub-api-key et --axe-devhub-project-id sont requis pour envoyer des résultats à Axe Developer Hub. Voir Utilisation du CLI pour envoyer des résultats d'accessibilité à Axe Developer Hub pour plus d'informations.

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

Spécifiez l'ID de projet 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 des résultats à Axe Developer Hub. Voir Utilisation du CLI pour envoyer des résultats d'accessibilité à Axe Developer Hub pour plus d'informations.

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

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

-c, --custom <path>

Spécifiez un jeu de règles personnalisé à utiliser. Voir Jeux de règles personnalisés pour des 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 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 désigner axe une installation spécifique de Chrome lorsque le navigateur par défaut ne peut être trouvé, ou que vous devez exécuter une version particulière.

--chromedriver-path <path>

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

-d, --dir <path>

Le 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 imprimés dans le terminal sous forme de résumé lisible par l'humain. Voir aussi -j, --stdout si vous avez besoin d'une sortie lisible par une machine sans écrire sur le disque.

-l, --disable <list>

Liste séparée par des virgules des identifiants de règles à désactiver. Voir les descriptions des règles axe-core pour une liste complète des identifiants 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 d'é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 des rapports pour des détails sur ce que chaque format contient. Défaut : html.

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

--filter <list>

Liste séparée par des virgules des types de résultats à 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 des sélecteurs CSS séparés par des virgules. Lorsqu'elle est spécifiée, axe teste uniquement les éléments correspondants, et tout le reste de 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 sur un composant spécifique, par exemple lors de débogage ciblé ou de vérifications 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

Écrire les résultats complets sous forme de JSON lisible par machine sur stdout au lieu du résumé lisible par humain dans le terminal. Tout autre résultat est réduit au silence. Utilisez ceci lors de l'acheminement des résultats vers un autre programme.

--load-delay <n>

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

--no-git-data

Ne pas signaler les informations de branche Git et de commit lors de l'envoi des résultats à Axe Developer Hub. Voir Utilisation de la CLI pour envoyer les résultats d'accessibilité à Axe Developer Hub.

--no-reporter

Supprime le résumé des violations (ID des règles, compteurs, sélecteurs affectés et URL d'aide) sans tout réduire au silence. Les messages de progression et les résultats écrits sur le disque via --save, --dir, ou --report ne sont pas affectés. Principalement utile dans les pipelines CI lorsque vous enregistrez les résultats dans un fichier et utilisez --exit pour indiquer le succès/échec et ne pas vouloir de détails verbeux sur les violations dans le journal de construction. Pour un silence total avec sortie de résultats JSON, utilisez -j, --stdout à la place.

-q, --exit

Quittez avec le code d'échec 1 si un 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'homme 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 des ID de règles à exécuter, séparés par des virgules. 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 sous forme de fichier JSON dans le répertoire actuel. Le nom de fichier est facultatif; s'il est omis, le fichier est nommé axe-result.json. Pour enregistrer dans un répertoire spécifique, utilisez -d, --dir.

--show-errors

Lorsque axe rencontre une erreur d'exécution (comme un échec d'initialisation ou une exception levée lors de l'exécution), il imprime normalement un bref message d'erreur sur stderr. Ce drapeau ajoute la trace complète de la pile à ce résultat. Cela n'affecte pas la façon dont les violations d'accessibilité sont signalées. Utilisez ceci lors du débogage d'un fichier --axe-source personnalisé, pour diagnostiquer des échecs inattendus dans CI, ou pour rassembler des informations pour un rapport de bug.

-t, --tags <list>

Liste des balises pour filtrer quelles règles sont exécutées, séparées par des virgules. 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

Affiche trois mesures de temps dans le terminal après chaque exécution de test :

• temps de chargement de la page par axe: le temps que la page a mis à charger dans le navigateur
• temps d'exécution d'axe-core: le temps qu'axe-core a mis pour analyser la page
• temps total de test: temps écoulé de bout en bout 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 d'Axe, ou pour enquêter sur la raison pour laquelle une exécution atteint les --page-timeout ou les --script-timeout limites.

-v, --verbose

Lorsqu'il y a des violations, un bloc JSON est imprimé après le résumé des violations, contenant :

• **Moteur de test**: la version axe-core utilisée
• **Environnement de test**: agent utilisateur du navigateur, largeur et hauteur de la fenêtre d'affichage, et orientation de l'écran
• **Exécuteur de test**: le nom de l'exécuteur

Notez que cette sortie n'apparaît que lorsque des violations sont détectées. Si une page ne présente aucune violation, les métadonnées ne sont pas imprimées. Utilisez cela lorsque vous devez confirmer exactement quelle version de axe-core a été utilisée, vérifier les paramètres de la fenêtre d'affichage, ou inclure les détails de l'environnement dans un rapport de bug.

Options de configuration

Les options suivantes contrôlent le comportement du navigateur et le minutage 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 avec axe config-selenium.

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