Prueba de páginas con CLI

Al utilizar el modo de entrada URI del CLI, hay varias opciones adicionales disponibles para cambiar el alcance y el conjunto de reglas de una prueba. Por ejemplo, el siguiente código excluirá el encabezado y el pie de página de una prueba y desactivará la regla de contraste de color:

axe http://example.com --exclude footer,header --disable color-contrast

Opciones

-a, --axe-source <path>

Ruta a un axe.js archivo alternativo. La mayoría de los usuarios no necesitan esta opción. Está destinado para casos de uso avanzados como pruebas contra una versión específica o corregida de axe-core.

--axe-devhub-api-key <your-API-key>

Especifica la clave API de la cuenta de Axe que se utilizará para enviar resultados de accesibilidad a Axe Developer Hub. Los resultados se envían al proyecto asociado con el ID de proyecto especificado (especificado con la --axe-devhub-project-id opción de línea de comandos) después de que se completen las pruebas. Tanto --axe-devhub-api-key como --axe-devhub-project-id son necesarios para enviar resultados a Axe Developer Hub. Consulte Usar el CLI para enviar resultados de accesibilidad a Axe Developer Hub para más información.

--axe-devhub-project-id <your-project-ID>

Especifica el ID de proyecto de Axe Developer Hub para recibir resultados de pruebas de accesibilidad. Tanto --axe-devhub-api-key como --axe-devhub-project-id son necesarios para enviar resultados a Axe Developer Hub. Consulte Usar el CLI para enviar resultados de accesibilidad a Axe Developer Hub para más información.

--axe-devhub-server-url <url>

Especifica la URL del servidor de Axe Developer Hub. Por defecto es https://axe.deque.com. Equivalente a la variable de entorno AXE_DEVHUB_SERVER_URL . Consulte Usar el CLI para enviar resultados de accesibilidad a Axe Developer Hub para más información.

-c, --custom <path>

Especifica un conjunto de reglas personalizado para usar. Consulte Conjuntos de reglas personalizados para obtener detalles sobre cómo generar un archivo de conjunto de reglas.

--chrome-options [options]

Lista separada por comas de conmutadores de línea de comandos de Chrome para pasar al navegador. Por ejemplo:

axe http://example.com --chrome-options="some-switch,some-other-switch"

--chrome-path <path>

Ruta absoluta al ejecutable del navegador Chrome. Use esto para señalar axe a una instalación específica de Chrome cuando el navegador por defecto no pueda ser encontrado, o necesite ejecutarlo en una versión particular.

--chromedriver-path <path>

Ruta absoluta al ejecutable de ChromeDriver. ChromeDriver es un binario separado del navegador Chrome; actúa como un puente que traduce los comandos de WebDriver de axeen instrucciones que Chrome puede ejecutar.

-d, --dir <path>

El directorio donde se guarda el archivo de resultados JSON. Sin esta bandera (o --save o --report), no se escribe ningún archivo y los resultados se imprimen en la terminal como un resumen legible para humanos. Consulte también -j, --stdout si necesita una salida legible por máquina sin escribir en disco.

-l, --disable <list>

Lista separada por comas de IDs de reglas para desactivar. Vea las descripciones de reglas de axe-core para una lista completa de IDs de reglas.

axe http://example.com --disable color-contrast,duplicate-id

-e, --exclude <list>

Lista separada por comas de selectores CSS para elementos a excluir de las pruebas. Por ejemplo:

# Exclude by element type
axe http://example.com --exclude footer,header

# Exclude by class or ID
axe http://example.com --exclude ".ad-banner,#cookie-notice"

# Exclude by attribute
axe http://example.com --exclude "[aria-hidden=true]"

-f, --format <value>

Formato del reporte generado. Requiere -r, --report. Consulte Creación y filtrado de reportes para obtener detalles sobre lo que contiene cada formato. Por defecto: html.

axe http://example.com --report ./reports --format html+junit+csv

--filter <list>

Lista separada por comas de tipos de resultados para incluir en la salida CSV. Solo aparecerán los tipos especificados; todos los demás se excluirán. Los valores válidos son passes, violations, incomplete, y inapplicable. Requiere --format csv.

axe reporter ./axe-reports/json/ --format=csv --filter passes,inapplicable

-i, --include <list>

Lista separada por comas de selectores CSS. Cuando se especifica, axe prueba solo los elementos coincidentes, y todo lo demás en la página se ignora. Esto es altamente restrictivo, y la mayoría de los usuarios debería usar -e, --exclude en su lugar. Usa --include solo cuando quieras aislar pruebas a un componente específico, como durante una depuración enfocada o verificaciones de CI a nivel de componente.

# Test only the main navigation
axe http://example.com --include nav

# Test only elements with a specific class or ID
axe http://example.com --include ".my-widget,#signup-form"

# Test only elements with a specific attribute
axe http://example.com --include "[data-testid=checkout]"

-j, --stdout

Escribe los resultados completos como JSON legible por máquina a stdout en lugar del resumen legible por humanos en la terminal. Todo otro tipo de salida es silenciado. Utiliza esto cuando canalices resultados a otro programa.

--load-delay <n>

Establece cuánto tiempo (en milisegundos) axe esperará después de la carga de la página antes de ejecutar la auditoría (por defecto: 0).

--no-git-data

No informes la información del branch y commit de Git al enviar resultados a Axe Developer Hub. Consulta Usar la CLI para Enviar Resultados de Accesibilidad a Axe Developer Hub.

--no-reporter

Suprime la salida del resumen de violaciones (IDs de reglas, conteos, selectores afectados y URLs de ayuda) sin silenciar todo. Los mensajes de progreso y los resultados escritos al disco a través de --save, --dir, o --report no se ven afectados. Principalmente útil en las pipelines de CI donde guardas los resultados en un archivo y usas --exit para señales de éxito/fallo y no quieres detalles verbosos de violaciones en el registro de la construcción. Para un silencio completo con salida de resultados en JSON, usa -j, --stdout en su lugar.

-q, --exit

Salir con 1 código de fallo si alguna prueba de accesibilidad falla.

-r, --report <output-dir>

El directorio donde se escribe el informe formateado. Funciona con -f, --format para controlar el formato de salida (HTML por defecto). Usa esto cuando quieras un informe legible por humanos o analizable por máquina en lugar de JSON puro, por ejemplo, un informe HTML para compartir con los interesados o un archivo XML de JUnit para integración en CI. Para salida de JSON puro, usa -d, --dir en su lugar.

--rules <list>

Lista separada por comas de IDs de reglas a ejecutar. Solo se verifican las reglas especificadas; todas las demás se omiten. Consulta las descripciones de reglas de axe-core para una lista completa de IDs de reglas.

axe http://example.com --rules color-contrast,duplicate-id

-s, --save [filename]

Guarda los resultados como un archivo JSON en el directorio actual. El nombre del archivo es opcional; si se omite, el archivo se nombra axe-result.json. Para guardar en un directorio específico, usa -d, --dir.

--show-errors

Cuando axe encuentra un error de tiempo de ejecución (como un fallo al inicializar o una excepción lanzada durante la ejecución), normalmente imprime un mensaje de error breve en stderr. Este indicador añade el rastreo completo del error a esa salida. No afecta cómo se informan las violaciones de accesibilidad. Usa esto al depurar un --axe-source archivo personalizado, diagnosticar fallos inesperados en CI o recopilar información para un informe de error.

-t, --tags <list>

Lista separada por comas de etiquetas para filtrar qué reglas se ejecutan. Solo se incluyen reglas que coinciden con al menos una de las etiquetas especificadas. Consulta la documentación de etiquetas de axe-core para una lista completa de etiquetas disponibles.

axe http://example.com --tags wcag2a,wcag2aa

--timer

Imprime tres medidas de tiempo en la terminal después de cada ejecución de prueba:

• tiempo de carga de página de axe: cuánto tiempo tardó en cargarse la página en el navegador
• tiempo de ejecución de axe-core: cuánto tiempo tardó axe-core en analizar la página
• Tiempo total de prueba: tiempo transcurrido de extremo a extremo para la ejecución

Usa esto para diagnosticar pruebas lentas. Por ejemplo, utiliza esta opción para determinar si el tiempo se gasta esperando a que la página cargue o en el análisis de Axe, o para investigar por qué una ejecución está alcanzando --page-timeout o --script-timeout límites.

-v, --verbose

Cuando se encuentran infracciones, se imprime un bloque JSON después del resumen de infracciones que contiene:

• **Motor de Pruebas**: la versión de axe-core utilizada
• **Entorno de Pruebas**: agente de usuario del navegador, ancho y alto de la ventana de visualización, y orientación de la pantalla
• **Ejecutor de Pruebas**: el nombre del ejecutor

Tenga en cuenta que esta salida solo aparece cuando se detectan infracciones. Si una página no tiene infracciones, no se imprime la metadata. Utilice esto cuando necesite confirmar exactamente qué versión de axe-core se ejecutó, verificar la configuración de la ventana de visualización, o incluir detalles del entorno en un informe de errores.

Opciones de configuración

Las siguientes opciones controlan el comportamiento del navegador y el tiempo de las pruebas. A diferencia de las opciones anteriores, estas persisten entre ejecuciones CLI; al configurarlas una vez, el valor se guarda en un archivo de preferencias utilizado para todas las ejecuciones futuras. También se pueden configurar de manera interactiva utilizando axe config-selenium.

Para obtener detalles completos, consulte Opciones de Configuración.