Probando páginas con CLI

Cuando se utiliza 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 deshabilitará 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á destinada a casos de uso avanzados como probar contra una versión específica o parcheada de axe-core.

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

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

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

Especifica el ID del 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 al Axe Developer Hub. Consulte Uso del CLI para enviar resultados de accesibilidad al 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 Uso del CLI para enviar resultados de accesibilidad al 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 parámetros 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 no se pueda encontrar el navegador predeterminado, o necesite ejecutar una versión en particular.

--chromedriver-path <path>

Ruta absoluta al ejecutable de ChromeDriver. ChromeDriver es un binario separado del navegador Chrome en sí; actúa como un puente que traduce los comandos 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 escribirá ningún archivo, y los resultados se imprimirán en la terminal como un resumen legible para humanos. Consulte también -j, --stdout si necesita un resultado legible por máquina sin escribir en el disco.

-l, --disable <list>

Lista separada por comas de IDs de reglas a deshabilitar. Consulte 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 informe generado. Requiere -r, --report. Consulte Creación y filtrado de informes 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 serán excluidos. 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 solo prueba 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ían usar -e, --exclude en su lugar. Usa --include solo cuando quieras aislar las pruebas a un componente específico, como durante la depuración enfocada o las 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 en stdout en lugar del resumen legible por humanos en la terminal. Se silencia toda otra salida. Úsalo cuando redirijas resultados a otro programa.

--load-delay <n>

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

--no-git-data

No informes información de la rama y confirmación 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 de resumen de violaciones (IDs de reglas, conteos, selectores afectados y URLs de ayuda) sin silenciar todo. Los mensajes de progreso y los resultados escritos en disco a través de --save, --dir, o --report no se ven afectados. Principalmente útil en canalizaciones de CI donde estás guardando resultados en un archivo y usando --exit para señales de aprobación/rechazo y no quieres detalles de violaciones verbosos en el registro de construcción. Para un silencio completo con salida de resultados 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). Úsalo cuando desees un informe legible por humanos o analizable por máquina en lugar de JSON en bruto, por ejemplo, un informe HTML para compartir con las partes interesadas o un archivo JUnit XML para integración CI. Para salida en bruto en JSON, 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 ejecución (como una falla al inicializar o una excepción lanzada durante la ejecución), normalmente imprime un mensaje de error breve en stderr. Esta opción agrega el seguimiento completo de la pila a esa salida. No afecta cómo se informan las violaciones de accesibilidad. Úsalo al depurar un archivo --axe-source , 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 las reglas que coincidan 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 mediciones de tiempo en la terminal después de cada ejecución de prueba:

• Tiempo de carga de página de Axe: cuánto tardó la página en cargarse 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 principio a fin para la ejecución

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

--universal-best-practices

Registros bestPracticesEnabled=true en los metadatos de la salida en formato universal. Requiere --format universal.

--universal-ruleset <id>

Especifica el ID del conjunto de reglas para registrar en los metadatos de la salida en formato universal. Por defecto es wcag2.1. Requiere --format universal.

-v, --verbose

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

• Motor de prueba: la versión de axe-core utilizada
• Ambiente de prueba: agente de usuario del navegador, ancho y alto del visor, y orientación de la pantalla
• Ejecutor de prueba: el nombre del ejecutor

Note que esta salida solo aparece cuando se detectan violaciones. Si una página no tiene violaciones, los metadatos no se imprimen. Use esto cuando necesite confirmar exactamente qué versión de axe-core se ejecutó, verificar configuraciones del visor 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 de CLI; configurarlas una vez guarda el valor en un archivo de preferencias usado para todas las ejecuciones futuras. También pueden ser establecidas interactivamente usando axe config-selenium.

Para obtener todos los detalles, consulte Opciones de Configuración.