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 archivo axe.js alternativo. La mayoría de los usuarios no necesitan esta opción. Está destinada a casos de uso avanzados, como pruebas con una versión específica o parcheada de axe-core.

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

Especifique la clave API de la cuenta de Axe para usar en el envío de resultados de accesibilidad a Axe Developer Hub. Los resultados se envían al proyecto asociado con el ID del proyecto especificado (especificado con la opción de línea de comandos --axe-devhub-project-id) después de completar la prueba. Se requieren tanto --axe-devhub-api-key como --axe-devhub-project-id para enviar resultados a Axe Developer Hub. Consulte Usar la CLI para Enviar Resultados de Accesibilidad a Axe Developer Hub para más información.

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

Especifique el ID del proyecto de Axe Developer Hub para recibir resultados de las pruebas de accesibilidad. Se requieren tanto --axe-devhub-api-key como --axe-devhub-project-id para enviar resultados a Axe Developer Hub. Consulte Usar la CLI para Enviar Resultados de Accesibilidad a Axe Developer Hub para más información.

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

Especifique la URL del servidor de Axe Developer Hub. El valor predeterminado es https://axe.deque.com. Equivale a la variable de entorno AXE_DEVHUB_SERVER_URL. Consulte Usar la CLI para Enviar Resultados de Accesibilidad a Axe Developer Hub para más información.

-c, --custom <path>

Especifique un conjunto de reglas personalizado a 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 apuntar axe a una instalación específica de Chrome cuando no se pueda encontrar el navegador predeterminado o necesite trabajar con 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 WebDriver de axe en 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. Consulte descripciones de reglas de axe-core para obtener 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. Predeterminado: 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 excluyen. 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 los elementos coincidentes los elementos coincidentes, y todo lo demás en la página se ignora. Esto es muy restrictivo, y la mayoría de los usuarios deberían usar -e, --exclude en su lugar. Use --include solo cuando quiera aislar las pruebas a un componente específico, como durante una depuración detallada o pruebas 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>

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

--no-git-data

No informe la información de la rama y el commit de Git al enviar resultados a Axe Developer Hub. Consulte 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 en disco mediante --save, --dir, o --report no se ven afectados. Principalmente útil en canalizaciones CI donde se están guardando resultados en un archivo y usando --exit para señalizar aprobado/rechazado y no se desean detalles de violación verbales en el registro de creación. Para un silencio completo con resultados en formato JSON, use -j, --stdout en su lugar.

-q, --exit

Salida con el código de error 1 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). Use esto cuando desee un informe legible para humanos o analizable por máquina en lugar de JSON bruto, por ejemplo, un informe HTML para compartir con interesados o un archivo XML JUnit para integración de CI. Para salida en JSON bruto, use -d, --dir en su lugar.

--rules <list>

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

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

-s, --save [filename]

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

--show-errors

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

-t, --tags <list>

Lista separada por comas de etiquetas para filtrar cuáles reglas se ejecutan. Solo las reglas que coinciden con al menos una de las etiquetas especificadas están incluidas. Consulte documentación de etiquetas de axe-core para obtener 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: tiempo que tardó en cargarse la página en el navegador
• Tiempo de ejecución de axe-core: tiempo que axe-core tardó en analizar la página
• Tiempo total de prueba: tiempo transcurrido de extremo a extremo para la ejecución

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

--universal-best-practices

Graba 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 grabar en los metadatos de la salida en formato universal. El valor predeterminado 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 viewport, 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 prueba. 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 futuras ejecuciones. También pueden configurarse de manera interactiva usando axe config-selenium.

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