Référence CLI

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

Syntaxe des commandes et référence complète des options pour toutes les sous-commandes Axe DevTools CLI

Not for use with personal data

Une référence rapide pour chaque sous-commande Axe DevTools CLI et ses options. Pour des conseils d'utilisation et des exemples, suivez le lien vers l'article de chaque commande.

axe <url> — analyser les pages par URL
axe bulk-reports — envoyer les résultats à Axe Reports
axe bulk-spec — exécuter un répertoire de fichiers de spécifications
axe config-selenium — configurer les paramètres par défaut du navigateur persistant
axe devhub — envoyer les résultats au Hub Axe Developer
axe licenses — afficher les licences de dépendance
axe reporter — générer des rapports à partir des résultats JSON
axe ruleset — générer des ensembles de règles personnalisés
axe spec — exécuter un fichier de spécifications

`axe <url>`

Analyse une ou plusieurs pages web pour détecter des problèmes d’accessibilité. Voir Test des pages pour la documentation complète.

axe <url...> [options]

Certaines options sont enregistrées dans un fichier de préférences et persistent à travers les exécutions du CLI. Voir Configuration pour plus de détails.

Option	Description
`-a, --axe-source <path>`	Chemin vers un fichier `axe.js` alternatif.
`--accept-untrusted`	Accepter les certificats SSL non fiables. Persiste.
`--axe-devhub-api-key <api-key>`	Clé API pour Axe Developer Hub.
`--axe-devhub-project-id <project-id>`	ID de projet pour Axe Developer Hub.
`--axe-devhub-server-url <url>`	URL du serveur Axe Developer Hub. Valeur par défaut : `https://axe.deque.com`.
`--axe-reports-api-key <api-key>`	Clé API pour Axe Reports.
`--axe-reports-dimensions <dimensions>`	Dimensions JTBD séparées par des virgules pour taguer cette analyse dans Axe Reports.
`--axe-reports-url <url>`	URL pour envoyer les résultats à Axe Reports.
`--browser [name]`	Navigateur à utiliser. Nécessite le WebDriver correspondant. Valeurs valides : `firefox` (par défaut), `chrome`, `edge` (ou `microsoftedge`), `safari`, `ie`. Les options spécifiques au navigateur s'appliquent uniquement à Firefox, Chrome et Edge. Persistant.
`--chrome-options [options]`	Interrupteurs de ligne de commande du navigateur séparés par des virgules pour Chrome ou Edge. Persistant.
`--chrome-path <path>`	Chemin absolu vers l'exécutable du navigateur Chrome ou Edge.
`--chromedriver-path <path>`	Chemin absolu vers l'exécutable ChromeDriver ou `msedgedriver`.
`-c, --custom <path>`	Chemin vers un fichier d'ensemble de règles personnalisé, remplaçant le défaut.
`-d, --dir <path>`	Répertoire où les résultats JSON sont enregistrés.
`-l, --disable <list>`	IDs de règles à désactiver, séparés par des virgules.
`-e, --exclude <list>`	Sélecteurs CSS séparés par des virgules pour les éléments à exclure du test.
`-q, --exit`	Quitter avec le code `1` si des violations sont trouvées.
`--enable-tracking <state>`	Activer (`true`) ou désactiver (`false`) l'envoi de données d'utilisation à la bibliothèque de métriques. Persiste.
`-f, --format <value>`	Format(s) de rapport : `html`, `junit`, `csv`, `universal` ou une combinaison séparée par un `+`. Par défaut : `html`. Nécessite `-r, --report`.
`--filter <list>`	Types de résultats à inclure, séparés par des virgules : `passes`, `violations`, `incomplete`, `inapplicable`. Nécessite `--format csv`.
`--universal-best-practices`	Enregistrer `bestPracticesEnabled=true` dans les métadonnées lors de l'utilisation de `--format universal`.
`--universal-ruleset <id>`	ID de l'ensemble de règles à enregistrer dans les métadonnées lors de l'utilisation de `--format universal`. Valeurs valides : `wcag2`, `wcag2.1`, `wcag2.2`, `wcag2aaa`, `wcag2.1aaa`, `wcag2.2aaa`, `508`, `en301549`, `ttv5`, `rgaav4`. Valeur par défaut : `wcag2.1`.
`--headless`	Lancer le navigateur en mode sans tête. Persistant.
`-i, --include <list>`	Sélecteurs CSS séparés par des virgules. Seuls les éléments correspondants sont testés.
`--load-delay <n>`	Millisecondes à attendre après le chargement de la page avant de lancer l’audit. Par défaut : `0`.
`--no-git-data`	Ne pas envoyer les données de branche Git et de commit à l'Axe Developer Hub.
`--no-reporter`	Supprimer la sortie du résumé des violations.
`--page-timeout <ms>`	Millisecondes maximales à attendre pour le chargement d'une page. Valeur par défaut : `60000`. Persiste.
`--post-analyze-pause <ms>`	Millisecondes de pause après l'analyse avant la prochaine action. Valeur par défaut : `2000`. Persiste.
`--post-get-pause <ms>`	Millisecondes de pause après le chargement de la page et avant l'analyse. Valeur par défaut : `2000`. Persiste.
`--post-script-pause <ms>`	Millisecondes de pause après une action de script et avant l'analyse. Valeur par défaut : `2000`. Persiste.
`-r, --report <output-dir>`	Répertoire où le rapport formaté est écrit. Utiliser avec `-f, --format`.
`--remote-proxy [proxy-server]`	Faire transiter le trafic par un proxy distant (navigateurs basés sur Chromium uniquement : Chrome et Edge). Persistant.
`--remote-server [server-url]`	Se connecter à un serveur WebDriver distant (par exemple, Selenium Grid, BrowserStack). Persistant.
`--rules <list>`	Identifiants de règles séparés par des virgules à exécuter. Seules les règles précisées sont vérifiées.
`-s, --save [filename]`	Enregistrer les résultats sous forme de fichier JSON. Le nom de fichier par défaut est `axe-result.json`.
`--script-timeout <ms>`	Millisecondes maximales pour attendre un script de workflow. Valeur par défaut : `60000`. Persiste.
`--send-axe-reports`	Envoyer les résultats de l'analyse à Axe Reports.
`--set-distinct-id <id>`	Remplacer l'ID distinct utilisé pour le suivi de l'utilisation. Persistant.
`--set-tracking-url <url>`	Remplacer l'URL où les données des métriques sont envoyées. Persistant.
`--show-errors`	Afficher la trace complète des erreurs.
`-j, --stdout`	Sortir les résultats JSON vers stdout ; désactiver toutes les autres sorties.
`-t, --tags <list>`	Tags séparés par des virgules pour filtrer les règles exécutées.
`--timer`	Imprimer les mesures de temps après chaque exécution de test.
`-v, --verbose`	Inclure le nom de l'outil, la version et les métadonnées de l'environnement dans la sortie.
`-V, --version`	Afficher le numéro de version.
`--window-size <width,height>`	Définir la taille de la fenêtre du navigateur en pixels. Persistant.

`axe bulk-reports`

Envoie les résultats JSON à Axe Reports. Voir Envoyer à Axe Reports pour la documentation complète.

axe bulk-reports <results-directory> [options]

Option	Description
`--axe-reports-api-key <api-key>`	Clé API pour Axe Reports.
`--axe-reports-dimensions <dimensions>`	Dimensions JTBD séparées par des virgules pour taguer cette analyse dans Axe Reports.
`--axe-reports-url <url>`	URL pour envoyer les résultats à Axe Reports.
`--send-axe-reports`	Envoyer les résultats de l'analyse à Axe Reports.
`--verbose`	Activer la journalisation détaillée.

`axe bulk-spec`

Traite un répertoire de fichiers de spécifications en une seule exécution. Voir Spécifications de Workflow pour la documentation complète.

axe bulk-spec <spec-files-directory> [output-directory] [options]

Option	Description
`-a, --axe-source <path>`	Chemin vers un fichier `axe.js` alternatif.
`--accept-untrusted`	Accepter les certificats SSL non fiables. Persiste.
`--browser [name]`	Navigateur à utiliser. Nécessite le WebDriver correspondant. Valeurs valides : `firefox` (par défaut), `chrome`, `edge` (ou `microsoftedge`), `safari`, `ie`. Les options spécifiques au navigateur s'appliquent uniquement à Firefox, Chrome et Edge. Persistant.
`-c, --custom <path>`	Chemin vers un fichier d'ensemble de règles personnalisé, remplaçant le défaut.
`--dismiss-alerts`	Ignorer les dialogues du navigateur `alert()`, `confirm()` et `prompt()` avant l'analyse.
`--enable-tracking <state>`	Activer (`true`) ou désactiver (`false`) l'envoi de données d'utilisation à la bibliothèque de métriques. Persiste.
`-f, --format [value]`	Format(s) de rapport : `html`, `junit`, `csv`, ou une combinaison séparée par un `+`. Par défaut : `html`.
`--headless`	Lancer le navigateur en mode sans tête. Persistant.
`--no-analyze`	Supprimer l'exigence d'une action `analyze` dans la liste des actions de chaque page.
`--no-html`	Empêcher la génération de rapports HTML.
`--no-reports`	Empêcher la génération de tous les fichiers de rapport.
`--no-wait`	Désactiver les pauses automatiques entre les actions du flux de travail.
`--page-timeout <ms>`	Millisecondes maximales à attendre pour le chargement d'une page. Valeur par défaut : `60000`. Persiste.
`--post-analyze-pause <ms>`	Millisecondes de pause après l'analyse avant la prochaine action. Valeur par défaut : `2000`. Persiste.
`--post-get-pause <ms>`	Millisecondes de pause après le chargement de la page et avant l'analyse. Valeur par défaut : `2000`. Persiste.
`--post-script-pause <ms>`	Millisecondes de pause après une action de script et avant l'analyse. Valeur par défaut : `2000`. Persiste.
`--remote-proxy [proxy-server]`	Faire transiter le trafic par un proxy distant (navigateurs basés sur Chromium uniquement : Chrome et Edge). Persistant.
`--remote-server [server-url]`	Se connecter à un serveur WebDriver distant (par exemple, Selenium Grid, BrowserStack). Persistant.
`--script-timeout <ms>`	Millisecondes maximales pour attendre un script de workflow. Valeur par défaut : `60000`. Persiste.
`--set-distinct-id <id>`	Remplacer l'ID distinct utilisé pour le suivi de l'utilisation. Persistant.
`--set-tracking-url <url>`	Remplacer l'URL où les données des métriques sont envoyées. Persistant.
`-t, --tags [list]`	Tags séparés par des virgules pour filtrer les règles exécutées.
`--user-agent <agent>`	Définir une chaîne d'agent utilisateur personnalisée (navigateurs basés sur Chromium uniquement : Chrome et Edge). Persistant.
`--validate`	Valider les fichiers de spécifications sans les exécuter.
`--wait-network-idle-new-connections [number]`	Seuil de nouvelles connexions avant que le réseau ne soit considéré comme inactif (navigateurs basés sur Chromium uniquement : Chrome et Edge).
`--wait-network-idle-open-connections [number]`	Seuil de connexions ouvertes avant que le réseau ne soit considéré comme inactif (navigateurs basés sur Chromium uniquement : Chrome et Edge).
`--wait-network-idle-timeout [ms]`	Temps maximal en millisecondes pour attendre l'inactivité du réseau avant de continuer (navigateurs basés sur Chromium uniquement : Chrome et Edge).
`--window-size <width,height>`	Définir la taille de la fenêtre du navigateur en pixels. Persistant.

`axe config-selenium`

Configure de manière interactive les paramètres par défaut du navigateur et du minutage. Voir Configuration pour la documentation complète.

axe config-selenium [options]

Option	Description
`-s, --show`	Afficher les paramètres enregistrés actuels sans entrer dans l'invite interactive.

`axe devhub`

Envoie les résultats JSON au Hub Axe Developer. Voir Envoyer à Axe Developer Hub pour la documentation complète.

axe devhub <results-directory|file> [options]

Option	Description
`--axe-devhub-api-key <api-key>`	Clé API pour le Hub Axe Developer. Remplace la variable d’environnement `AXE_DEVHUB_API_KEY`.
`--axe-devhub-project-id <project-id>`	ID de projet pour Axe Developer Hub.
`--axe-devhub-server-url <url>`	URL du serveur Axe Developer Hub. Valeur par défaut : `https://axe.deque.com`.
`--no-git-data`	Ne pas envoyer les données de branche Git et de commit à l'Axe Developer Hub.

`axe licenses`

Affiche et enregistre les licences open-source de toutes les dépendances CLI.

axe licenses [options]

`axe reporter`

Convertit les résultats JSON en rapports HTML, JUnit XML ou CSV. Voir Générer des rapports pour la documentation complète.

axe reporter <results-dir> [dest-dir] [options]

Option	Description
`-b, --browser [name]`	Lorsque le répertoire de résultats contient des résultats de plusieurs navigateurs, générer le rapport à partir des résultats d'un seul navigateur.
`-d, --dest [path]`	Répertoire de sortie pour les rapports générés. Peut également être spécifié comme le deuxième argument positionnel.
`--filter <list>`	Types de résultats à inclure, séparés par des virgules : `passes`, `violations`, `incomplete`, `inapplicable`. Nécessite `--format csv`.
`-f, --format [type(s)]`	Format(s) de sortie : `html`, `junit`, `csv`, `universal`, ou une combinaison. Par défaut : `html`.
`--universal-best-practices`	Enregistrer `bestPracticesEnabled=true` dans les métadonnées lors de l'utilisation de `--format universal`.
`--universal-ruleset <id>`	ID de l'ensemble de règles à enregistrer dans les métadonnées lors de l'utilisation de `--format universal`. Valeurs valides : `wcag2`, `wcag2.1`, `wcag2.2`, `wcag2aaa`, `wcag2.1aaa`, `wcag2.2aaa`, `508`, `en301549`, `ttv5`, `rgaav4`. Valeur par défaut : `wcag2.1`.

`axe ruleset`

Génère des fichiers de règles personnalisées. Voir Règles personnalisées pour la documentation complète.

axe ruleset [options]

Option	Description
`--508 [filename]`	Générer une configuration standard pour les règles de la section 508.
`--all [filename]`	Générer une configuration standard pour toutes les lignes directrices prises en charge.
`-a, --axe-source <path>`	Chemin vers une source axe personnalisée.
`-c, --custom [dir]`	Générez un ensemble de règles personnalisé à partir d'un répertoire contenant un fichier `changes.json`.
`-d, --destination [dir]`	Répertoire de sortie. Par défaut : répertoire de travail actuel.
`-x, --disable-other-rules`	Désactiver toutes les règles non incluses dans la propriété `rules`. Valeur par défaut : `true`.
`--en301549 [filename]`	Générer une configuration standard pour les règles EN 301 549.
`-f, --format [format]`	Format de sortie.
`-l, --log`	Générer également une liste de toutes les règles incluses dans l'ensemble de règles généré.
`--only-changes`	Générer uniquement les modifications et ajouts à l'ensemble de règles.
`--rgaav4 [filename]`	Générer une configuration standard pour les règles RGAA v4.
`-t, --tags [list]`	Tags séparés par des virgules pour filtrer l'ensemble de règles standard.
`--ttv5 [filename]`	Générer une configuration standard pour les règles Trusted Tester v5.
`--wcag2 [filename]`	Générer une configuration standard pour les règles WCAG 2.0 AA.
`--wcag21 [filename]`	Générer une configuration standard pour les règles WCAG 2.1 AA.
`--wcag21aaa [filename]`	Générer une configuration standard pour les règles WCAG 2.1 AAA.
`--wcag22 [filename]`	Générer une configuration standard pour les règles WCAG 2.2 AA.
`--wcag22aaa [filename]`	Générer une configuration standard pour les règles WCAG 2.2 AAA.
`--wcag2aaa [filename]`	Générer une configuration standard pour les règles WCAG 2.0 AAA.

`axe spec`

Analyse les pages définies dans un fichier de spécification JSON ou YAML. Voir Spécifications de Workflow pour la documentation complète.

axe spec <spec-file> [output-directory] [options]

Option	Description
`-a, --axe-source <path>`	Chemin vers un fichier `axe.js` alternatif.
`--accept-untrusted`	Accepter les certificats SSL non fiables. Persiste.
`--axe-devhub-api-key <api-key>`	Clé API pour Axe Developer Hub.
`--axe-devhub-project-id <project-id>`	ID de projet pour Axe Developer Hub.
`--axe-devhub-server-url <url>`	URL du serveur Axe Developer Hub. Valeur par défaut : `https://axe.deque.com`.
`--axe-reports-api-key <api-key>`	Clé API pour Axe Reports.
`--axe-reports-dimensions <dimensions>`	Dimensions JTBD séparées par des virgules pour taguer cette analyse dans Axe Reports.
`--axe-reports-url <url>`	URL pour envoyer les résultats à Axe Reports.
`--browser [name]`	Navigateur à utiliser. Nécessite le WebDriver correspondant. Valeurs valides : `firefox` (par défaut), `chrome`, `edge` (ou `microsoftedge`), `safari`, `ie`. Les options spécifiques au navigateur s'appliquent uniquement à Firefox, Chrome et Edge. Persistant.
`--chrome-options [options]`	Interrupteurs de ligne de commande du navigateur séparés par des virgules pour Chrome ou Edge. Persistant.
`-c, --custom <path>`	Chemin vers un fichier d'ensemble de règles personnalisé, remplaçant le défaut.
`--descendant-links`	Collectez les liens sur chaque page et ajoutez-les aux résultats. Nécessite `--verbose`.
`--dismiss-alerts`	Ignorer les dialogues du navigateur `alert()`, `confirm()` et `prompt()` avant l'analyse.
`--download-path <path>`	Définir où le navigateur enregistre les téléchargements (navigateurs basés sur Chromium uniquement : Chrome et Edge).
`--enable-tracking <state>`	Activer (`true`) ou désactiver (`false`) l'envoi de données d'utilisation à la bibliothèque de métriques. Persiste.
`-f, --format [value]`	Format(s) de rapport : `html`, `junit`, `csv`, `universal` ou une combinaison séparée par un `+`. Valeur par défaut : `html`.
`--filter <list>`	Types de résultats à inclure, séparés par des virgules : `passes`, `violations`, `incomplete`, `inapplicable`. Nécessite `--format csv`.
`--headless`	Lancer le navigateur en mode sans tête. Persistant.
`--interactive-mode`	Commencez à exécuter des actions dès que le HTML de la page est chargé, sans attendre que les images, les feuilles de style et d'autres ressources soient terminées. Utilisez ceci pour des pages avec lesquelles vous devez interagir avant de scanner, ou qui prennent beaucoup de temps à se charger complètement.
`--no-analyze`	Supprimer l'exigence d'une action `analyze` dans la liste des actions de chaque page.
`--no-exit`	Forcer le code de sortie `0` même lorsque des violations sont trouvées.
`--no-git-data`	Ne pas envoyer les données de branche Git et de commit à l'Axe Developer Hub.
`--no-html`	Empêcher la génération de rapports HTML.
`--no-reports`	Empêcher la génération de tous les fichiers de rapport.
`--no-wait`	Désactiver les pauses automatiques entre les actions du flux de travail.
`--page-name <name>`	Exécuter uniquement la page avec le nom spécifié à partir du fichier de spécification.
`--page-source`	Ajouter le code source HTML analysé aux résultats. Nécessite `--verbose`.
`--page-timeout <ms>`	Millisecondes maximales à attendre pour le chargement d'une page. Valeur par défaut : `60000`. Persiste.
`--page-title`	Ajouter le titre de la page aux résultats. Nécessite `--verbose`.
`--post-analyze-pause <ms>`	Millisecondes de pause après l'analyse avant la prochaine action. Valeur par défaut : `2000`. Persiste.
`--post-get-pause <ms>`	Millisecondes de pause après le chargement de la page et avant l'analyse. Valeur par défaut : `2000`. Persiste.
`--post-script-pause <ms>`	Millisecondes de pause après une action de script et avant l'analyse. Valeur par défaut : `2000`. Persiste.
`--remote-proxy [proxy-server]`	Faire transiter le trafic par un proxy distant (navigateurs basés sur Chromium uniquement : Chrome et Edge). Persistant.
`--remote-server [server-url]`	Se connecter à un serveur WebDriver distant (par exemple, Selenium Grid, BrowserStack). Persistant.
`--resume-from <name>`	Passer toutes les pages avant la page nommée dans le fichier de spécification.
`--scanned-url`	Ajouter l'URL de base et l'URL d'analyse aux résultats détaillés. Uniquement Chrome. Nécessite `--verbose`.
`--script-timeout <ms>`	Millisecondes maximales pour attendre un script de workflow. Valeur par défaut : `60000`. Persiste.
`--send-axe-reports`	Envoyer les résultats de l'analyse à Axe Reports.
`--set-distinct-id <id>`	Remplacer l'ID distinct utilisé pour le suivi de l'utilisation. Persistant.
`--set-legacy-mode`	Activer le mode de numérisation hérité. Obsolète — sera supprimé dans la version 5.0.
`--set-tracking-url <url>`	Remplacer l'URL où les données des métriques sont envoyées. Persistant.
`--silent-mode`	Supprimer tout affichage décoratif ; les résultats sont affichés uniquement lorsque `--verbose` est également actif.
`-t, --tags [list]`	Tags séparés par des virgules pour filtrer les règles exécutées.
`--universal-best-practices`	Enregistrer `bestPracticesEnabled=true` dans les métadonnées lors de l'utilisation de `--format universal`.
`--universal-ruleset <id>`	ID de l'ensemble de règles à enregistrer dans les métadonnées lors de l'utilisation de `--format universal`. Valeurs valides : `wcag2`, `wcag2.1`, `wcag2.2`, `wcag2aaa`, `wcag2.1aaa`, `wcag2.2aaa`, `508`, `en301549`, `ttv5`, `rgaav4`. Valeur par défaut : `wcag2.1`.
`--user-agent <agent>`	Définir une chaîne d'agent utilisateur personnalisée (navigateurs basés sur Chromium uniquement : Chrome et Edge). Persistant.
`--validate`	Valider le fichier de spécifications sans l'exécuter.
`-v, --verbose`	Inclure le nom de l'outil, la version et les métadonnées de l'environnement dans la sortie.
`--wait-network-idle-new-connections [number]`	Seuil de nouvelles connexions avant que le réseau ne soit considéré comme inactif (navigateurs basés sur Chromium uniquement : Chrome et Edge).
`--wait-network-idle-open-connections [number]`	Seuil de connexions ouvertes avant que le réseau ne soit considéré comme inactif (navigateurs basés sur Chromium uniquement : Chrome et Edge).
`--wait-network-idle-polling-every [ms]`	Intervalle de sondage en millisecondes pour la détection de l'inactivité du réseau (navigateurs basés sur Chromium uniquement : Chrome et Edge).
`--wait-network-idle-timeout [ms]`	Temps maximal en millisecondes pour attendre l'inactivité du réseau avant de continuer (navigateurs basés sur Chromium uniquement : Chrome et Edge).
`--window-size <width,height>`	Définir la taille de la fenêtre du navigateur en pixels. Persistant.