Axe DevTools pour Web CLI
Un outil en ligne de commande pour automatiser les tests d'accessibilité web sans écrire de code de test.
Axe DevTools pour Web CLI est un outil en ligne de commande qui exécute des analyses d'accessibilité sur les pages web et génère des rapports. Il est conçu pour les équipes qui souhaitent automatiser les tests d'accessibilité sans intégrer axe dans un cadre de test existant, par exemple, comme une étape dans un pipeline CI/CD, ou lorsque les API Axe DevTools ne sont pas disponibles pour votre langue.
Comment ça fonctionne
Chaque analyse de axe produit fichiers de résultats JSON, un par état de page analysé. Ces fichiers sont produits lors des tests, et vous les utilisez lors de la création de rapports ou du téléchargement des résultats.
Le flux de travail typique comporte deux phases :
-
Analyser les pages : exécutez une ou plusieurs URL à travers
axeet enregistrez les résultats au format JSON :axe <url> → test a URL directly axe spec <spec-file> → test pages and workflows defined in a YAML/JSON file axe bulk-spec <dir> → test using all spec files in a directory -
Faire quelque chose avec les résultats : convertissez, téléchargez ou envoyez-les ailleurs :
axe reporter <results> → generate HTML, JUnit XML, or CSV reports axe bulk-reports <results> → upload to the Axe Reports service axe devhub <results> → send to Axe Developer Hub
Les commandes axe et axe spec prennent également en charge les indicateurs --format et --report pour générer des rapports en une seule étape, sans invocation séparée de axe reporter.
Commande
| Objectif | Analyser une ou plusieurs URL directement. Navigateur par défaut : Firefox. Ensemble de règles par défaut : WCAG 2.1 AA. |
|---|---|
axe <url...> |
Analyser les pages définies dans un fichier de spécification YAML ou JSON, y compris les flux de travail à étapes multiples. |
axe spec <spec-file> |
Exécuter tous les fichiers de spécification trouvés dans un répertoire et ses sous-répertoires. |
axe bulk-spec <dir> |
Convertir les résultats JSON en rapports HTML, XML JUnit ou CSV. |
axe reporter <results-dir> |
Télécharger les résultats JSON vers le service Axe Reports. |
axe bulk-reports <results-dir> |
Envoyer les résultats JSON au Hub Développeur Axe. |
axe devhub <results-dir> |
Lister, valider ou gérer des ensembles de règles personnalisées. |
axe ruleset |
Voir ou mettre à jour les paramètres par défaut du navigateur/Selenium. |
axe config-selenium |
Résultats JSON |
Lorsque vous exécutez
Lorsque vous exécutez axe spec ou utilisez axe <url> --save, les résultats sont écrits sous forme de fichiers JSON dans le répertoire de sortie. Chaque fichier capture l'analyse complète de axe pour un état de page unique : violations, succès, vérifications incomplètes et règles inapplicables, ainsi que des métadonnées telles que l'URL, le navigateur et le horodatage.
Ces fichiers sont utilisés par
<output-dir>/<project-id>/<project-id>-<page-id>[-<analyze-title>].jsonCes fichiers sont utilisés par axe reporter, axe bulk-reports et axe devhub. Pour plus de détails sur la nomenclature des fichiers et la structure des répertoires, voir Générer des rapports.
Le schéma des résultats JSON est défini par axe-core. Pour une référence complète, voir le ..
Démarrer
- : tâches courantes avec des exemples pratiques : tâches courantes avec des exemples pratiques
- Installer : options d'installation (exécutable ou package Node.js)
- Analyser les pages : toutes les options pour
axe <url> - Analyser les pages à l'aide d'un fichier de spécification : structure des 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 vers Axe Reports : téléchargez les résultats vers le service Axe Reports
- Envoyer vers Axe Developer Hub : intégrez les résultats au Hub pour développeurs Axe
- 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és
