Commencez avec Axe DevTools CLI
Guide de démarrage rapide couvrant les tâches les plus courantes d’Axe DevTools CLI
Avant de commencer, installez Axe DevTools CLI.
Axe DevTools CLI s'exécute via la commande axe . Ce guide couvre les trois tâches les plus courantes.
Analyser une page web
Passez une ou plusieurs URL directement à la commande axe . Par défaut, la CLI utilise Firefox et applique le jeu de règles WCAG 2.1 AA , affichant les résultats sur stdout :
axe https://example.com/Analyser plusieurs pages à la fois :
axe https://example.com/ https://example.com/about.htmlEnregistrer les résultats sous forme de fichier JSON pour une utilisation ultérieure :
axe https://example.com/ --save=./axe-results.jsonGénérer directement un rapport HTML :
axe https://example.com/ --report=./axe-reports/Pour toutes les options, voir Analyser les pages.
Analyser des pages à l'aide d'un fichier de spécification
Pour des scénarios plus complexes tels que naviguer dans une application monopage, se connecter, fermer des dialogues, ou analyser une page à plusieurs points d’un flux de travail, utilisez la commande axe spec avec un fichier de spécification.
Un fichier de spécification (JSON ou YAML) définit une liste de pages à analyser et les actions à effectuer sur chaque page avant l'analyse. Un exemple minimal (axe-workflow.yaml) :
projects:
- name: example
id: example
pageList:
- name: Homepage
url: https://example.com/
- name: Search Results
url: https://example.com/
actions:
- type "axe" into element "#searchform input"
- click element "#searchform button[type=submit]"
- wait for element ".search-results" to be found
- analyzeExécutez-le avec axe spec, en spécifiant le fichier de spécification et un répertoire de sortie pour les résultats :
axe spec ./axe-workflow.yaml ./axe-resultsPour une référence complète de la structure des fichiers de spécification, des actions et des options, voir Analyser des pages à l'aide d'un fichier de spécification.
Générer un rapport à partir de résultats sauvegardés
Utilisez la commande axe reporter pour convertir les résultats JSON sauvegardés en HTML, JUnit XML ou CSV :
axe reporter ./axe-results --format=htmlGénérer un rapport JUnit XML (utile dans les pipelines CI) :
axe reporter ./axe-results --format=junitGénérer un rapport CSV :
axe reporter ./axe-results --format=csvPour le filtrage et d'autres options, voir Générer des rapports.
Prochaines étapes
- Analyser les pages: toutes les options pour analyser des pages individuelles
- Analyser des pages à l'aide d'un fichier de spécification: fichiers de spécification, actions et traitement par lots
- Générer des rapports: formats de rapport, filtrage et structure des résultats JSON
- Envoyer à Axe Reports: téléchargez les résultats vers le service Axe Reports
- Envoyer à Axe Developer Hub: intégrez les résultats avec Axe Developer Hub
- Configurer: sélection du navigateur, délais d'attente, et paramètres persistants
- Règles personnalisées: Règles WCAG 2.x, Section 508, et règles personnalisées
