Commencez avec Axe DevTools CLI

Avant de commencer, installez Axe DevTools CLI.

Axe DevTools CLI fonctionne 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, le CLI utilise Firefox et exécute l'ensemble de règles WCAG 2.1 AA, imprimant les résultats sur stdout :

axe https://example.com/

Analyser plusieurs pages à la fois :

axe https://example.com/ https://example.com/about.html

Enregistrer les résultats sous forme de fichier JSON pour une utilisation ultérieure :

axe https://example.com/ --save=./axe-results.json

Gé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 la navigation à travers une application monopage, la connexion, la fermeture de dialogues ou l'analyse d'une page à plusieurs points dans un flux de travail, utilisez la commande axe spec avec un fichier de spécifications.

Un fichier de spécifications (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
          - analyze

Exécutez-le avec axe spec, en spécifiant le fichier de spécifications et un répertoire de sortie pour les résultats :

axe spec ./axe-workflow.yaml ./axe-results

Pour une référence complète de la structure du fichier de spécifications, 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=html

Générer un rapport JUnit XML (utile dans les pipelines CI) :

axe reporter ./axe-results --format=junit

Générer un rapport CSV :

axe reporter ./axe-results --format=csv

Pour les filtres et les 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écifications, actions et traitement par lots
• Générer des rapports : formats de rapports, 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 : WCAG 2.x, Section 508 et ensembles de règles personnalisées