Comienza con Axe DevTools CLI

Antes de comenzar, instale Axe DevTools CLI.

Axe DevTools CLI se ejecuta a través del comando axe . Esta guía cubre las tres tareas más comunes.

Analizar una Página Web

Pase una o más URL directamente al comando axe . Por defecto, la CLI utiliza Firefox y ejecuta el conjunto de reglas WCAG 2.1 AA , imprimiendo los resultados en stdout:

axe https://example.com/

Analizar múltiples páginas a la vez:

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

Guardar los resultados como un archivo JSON para su uso posterior:

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

Generar un informe HTML directamente:

axe https://example.com/ --report=./axe-reports/

Para todas las opciones, vea Analizar Páginas.

Analizar Páginas Usando un Archivo de Especificación

Para escenarios más complejos, como navegar por una aplicación de una sola página, iniciar sesión, cerrar diálogos o analizar una página en múltiples puntos de un flujo de trabajo, utilice el comando axe spec con un archivo de especificación.

Un archivo de especificación (JSON o YAML) define una lista de páginas para analizar y las acciones a realizar en cada página antes de analizarlas. Un ejemplo mínimo (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

Ejecutelo con axe spec, especificando el archivo de especificación y un directorio de salida para los resultados:

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

Para una referencia completa de la estructura, acciones y opciones del archivo de especificación, consulte Analizar Páginas Usando un Archivo de Especificación.

Generar un Informe a partir de Resultados Guardados

Utilice el comando axe reporter para convertir resultados JSON guardados en HTML, JUnit XML o CSV:

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

Genere un informe JUnit XML (útil en canalizaciones de CI):

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

Genere un informe CSV:

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

Para el filtrado y otras opciones, vea Generar Informes.

Próximos Pasos

• Analizar Páginas: todas las opciones para el análisis de páginas individuales
• Analizar Páginas Usando un Archivo de Especificación: archivos de especificación, acciones y procesamiento por lotes
• Generar Informes: formatos de informe, filtrado y estructura de resultados JSON
• Enviar a Axe Reports: subir resultados al servicio Axe Reports
• Enviar a Axe Developer Hub: integrar resultados con Axe Developer Hub
• Configurar: selección del navegador, tiempos de espera, y configuraciones persistentes
• Reglas Personalizadas: WCAG 2.x, Sección 508, y conjuntos de reglas personalizadas