Comienza con Axe DevTools CLI

Antes de comenzar, instale Axe DevTools CLI.

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

Analizar una Página Web

Pasa una o más URL directamente al comando axe. Por defecto, el 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 ver todas las opciones, consulte 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, use el comando axe spec con un archivo de especificaciones.

Un archivo de especificaciones (JSON o YAML) define una lista de páginas para analizar y las acciones a realizar en cada página antes de analizar. 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

Ejecute con axe spec, especificando el archivo de especificaciones y un directorio de salida para los resultados:

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

Para una referencia completa de la estructura del archivo de especificaciones, acciones y opciones, 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 los 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 filtrar y otras opciones, consulte Generar Informes.

Próximos Pasos

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