Configuración de Axe DevTools para Web CLI

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

Establezca el navegador, el tiempo de espera, el tamaño de la ventana y otros valores predeterminados persistentes para Axe DevTools para Web CLI.

Not for use with personal data

Las banderas descritas en este artículo están disponibles para axe <url>, axe spec y axe bulk-spec. Cuando estableces una de estas banderas, el valor se guarda en el archivo de preferencias y se convierte en el predeterminado para todas las ejecuciones posteriores. Para ver o cambiar preferencias de forma interactiva, incluyendo restablecer valores que no tienen una bandera correspondiente, utiliza axe config-selenium.

Opciones del Navegador

--accept-untrusted

Instruye al navegador para aceptar certificados SSL no confiables. Usa esto al probar páginas en servidores de desarrollo local o entornos internos que utilizan certificados autofirmados. Pasar esta bandera guarda acceptUntrustedCertificates: true en el archivo de preferencias. Para restablecerlo a false, ejecuta axe config-selenium y responde No cuando se te pida, o edita el archivo de preferencias directamente.

axe <url> --accept-untrusted

--browser <name>

Especifica qué navegador usar. El WebDriver correspondiente debe estar instalado y disponible en tu $PATH. Los valores válidos son: firefox (predeterminado), chrome, safari, edge, ie.

axe <url> --browser chrome

Si encuentras un error al iniciar el navegador en tu primera ejecución, es posible que GeckoDriver (el WebDriver de Firefox) no esté instalado. Intenta con --browser chrome, que generalmente funciona sin configuración adicional en la mayoría de los sistemas.

Pasar esta bandera guarda el nombre del navegador en el archivo de preferencias. Todas las ejecuciones posteriores, incluidas las ejecuciones sin --browser, usarán el navegador guardado. Para cambiar el navegador guardado, ejecuta axe config-selenium y elige un navegador diferente en el indicador, o edita el archivo de preferencias directamente.

--headless

Inicia el navegador en modo sin cabeza (sin ventana visible). El predeterminado es false.

axe <url> --headless

--remote-server <url>

Conecta a un servidor WebDriver remoto en lugar de lanzar un navegador local. El servidor debe exponer un endpoint compatible con WebDriver de W3C, como Selenium Grid, BrowserStack o Sauce Labs remoto.

axe <url> --remote-server https://hub.browserstack.com/wd/hub

--window-size <width,height>

Establece el tamaño de la ventana del navegador en píxeles. Esto también controla el tamaño del viewport en modo invisible, lo cual es útil para probar diseños responsivos.

axe <url> --window-size 1280,900

Opciones de Temporización

--page-timeout <ms>

Tiempo máximo en milisegundos (ms) para esperar a que una página se cargue antes de fallar. El valor predeterminado es 60,000 ms (60 segundos). Aumente este valor para páginas de carga lenta o entornos de red con alta latencia.

axe <url> --page-timeout 120000

--post-analyze-pause <ms>

Tiempo en milisegundos para pausar después de completar un análisis antes de pasar a la siguiente acción en un flujo de trabajo. El valor predeterminado es 2,000 ms (2 segundos).

axe spec workflow.yml --post-analyze-pause 5000

--post-get-pause <ms>

Tiempo en milisegundos para pausar después de cargar una página y antes de comenzar el escaneo. El valor predeterminado es 2,000 ms (2 segundos). Aumente este valor si el contenido dinámico necesita más tiempo para renderizarse antes de que comience el escaneo.

axe <url> --post-get-pause 5000

--post-script-pause <ms>

Tiempo en milisegundos para pausar después de ejecutar una acción del script de flujo de trabajo y antes de continuar con la siguiente acción. El valor predeterminado es 2,000 ms (2 segundos).

axe spec workflow.yml --post-script-pause 5000

--script-timeout <ms>

Tiempo máximo en milisegundos para esperar a que un script de flujo de trabajo termine su ejecución. El valor predeterminado es 60,000 ms (60 segundos).

axe spec workflow.yml --script-timeout 120000

Seguimiento de Uso

Axe DevTools CLI incluye el @deque/metrics-library, que envía datos de uso anónimos a Deque. Estos datos incluyen información agregada como conteos de violaciones, conteos de reglas y versión del motor axe-core. No incluye URLs, contenido de páginas ni ninguna información personalmente identificable.

Un ID distinto es un valor almacenado en el archivo de preferencias que se utiliza para correlacionar eventos a través de múltiples ejecuciones de CLI sin identificar al usuario. Puedes cambiar o deshabilitar el seguimiento con las opciones a continuación. Para establecer estos valores sin usar la CLI, utiliza el variables de entorno del servicio de uso.

--enable-tracking <state>

Habilita o deshabilita el envío de datos de uso a la biblioteca de métricas. Pasa true para habilitar o false para deshabilitar. La variable de entorno correspondiente es AXE_TRACK_USAGE — ver Variables de Entorno del Servicio de Uso.

axe <url> --enable-tracking false

--set-distinct-id <id>

Cambia el ID distintivo utilizado para correlacionar eventos de uso. El ID se almacena en el archivo de preferencias y se utiliza en diferentes ejecuciones. La variable de entorno correspondiente es AXE_DISTINCT_ID — ver Variables de Entorno del Servicio de Uso.

axe <url> --set-distinct-id my-team-id

--set-tracking-url <url>

Cambia el punto final donde se envían las métricas de uso. Usa esto si tu organización enruta telemetría a través de un proxy interno. La variable de entorno correspondiente es AXE_METRICS_URL — ver Variables de Entorno del Servicio de Uso.

axe <url> --set-tracking-url https://metrics.example.com/collect

Variables de Entorno del Servicio de Uso

Además de las banderas de CLI, puedes configurar el servicio de uso y establecer propiedades en los eventos reportados utilizando variables de entorno. La columna Puede Sobrescribir indica si el valor de la variable de entorno puede sobrescribir un valor ya establecido programáticamente a través de la biblioteca de métricas. Un guion (—) indica que el concepto no se aplica a esa variable.

Nombre Tipo Puede sobrescribir Descripción
AXE_DISTINCT_ID Cadena Un identificador UUID que permanece igual para el usuario registrado (a menos que se regenere)
AXE_METRICS_URL Cadena La URL del punto final de uso de REST
AXE_TRACK_USAGE Booleano Habilita la generación de informes de servicio de uso (el valor predeterminado es false)
AXE_APPLICATION Cadena falso La aplicación que se utilizó para verificar errores de accesibilidad
AXE_DEV_INSTANCE Booleano verdadero Indica si este evento es producto de las acciones de un desarrollador de software. Útil para marcar y luego eliminar eventos registrados durante el desarrollo o las pruebas.
AXE_DEPARTMENT Cadena verdadero El departamento del usuario dentro de la organización
AXE_KEYCLOAK_ID Cadena falso El ID de Keycloak del usuario
AXE_LOGGED_IN Booleano falso Registra si el usuario está conectado a la aplicación bajo prueba
AXE_ORGANIZATION Cadena verdadero La organización del usuario
AXE_SESSION_ID Cadena falso Un UUID que identifica la sesión del usuario
AXE_USER_ID Cadena falso La identidad específica de un usuario, como su nombre o ID de inicio de sesión
AXE_USER_JOB_ROLE Cadena falso El rol laboral del usuario
AXE_USER_STATUS Cadena falso Información de estado que desea asociar con el usuario

axe config-selenium

Utiliza axe config-selenium para configurar los valores predeterminados de forma interactiva. Se te pedirá que introduzcas valores para el navegador, tiempo de espera y otras configuraciones. Tus respuestas se guardan en el archivo de preferencias y se convierten en predeterminadas para todas las ejecuciones posteriores de CLI.

$ axe config-selenium
? Choose browser for running automated tests: (Use arrow keys)
? Choose browser for running automated tests: chrome
? Enter a value for pageLoadTimeout: 60000
? Enter a value for setScriptTimeout: 60000
? Accept untrusted ssl certs: Yes
? Enter a value for postGetPause: 2000
? Enter a value for postScriptPause: 2000
? Enter a value for postAnalysisPause: 2000
? Launch browser in headless mode: No

Results saved to ~/.config/preferences/com.deque.axe.devtools.cli.pref

Para ver la configuración guardada actual sin entrar en el indicador interactivo, utiliza la bandera --show:

axe config-selenium --show

Archivo de Preferencias

Todos los valores predeterminados configurables se guardan en un archivo JSON en:

~/.config/preferences/com.deque.axe.devtools.cli.pref

Un archivo típico se ve así:

{
  "selenium": {
    "acceptUntrustedCertificates": false,
    "browser": "firefox",
    "headless": false,
    "pageLoadTimeout": 60000,
    "postAnalysisPause": 2000,
    "postGetPause": 2000,
    "postScriptPause": 2000,
    "setScriptTimeout": 60000
  }
}

Puedes editar este archivo directamente como alternativa a usar axe config-selenium o pasar banderas en la línea de comandos. Esto es útil para restablecer valores booleanos como acceptUntrustedCertificates sin ejecutar el indicador interactivo.