Referencia de 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

Sintaxis de comandos y referencia completa de opciones para todos los subcomandos de Axe DevTools CLI

Not for use with personal data

Una referencia rápida para cada subcomando de Axe DevTools CLI y sus opciones. Para orientación sobre el uso y ejemplos, sigue el enlace al artículo de cada comando.

axe <url> — analizar páginas por URL
axe bulk-reports — enviar resultados a Axe Reports
axe bulk-spec — ejecutar un directorio de archivos de especificaciones
axe config-selenium — configurar valores predeterminados persistentes del navegador
axe devhub — enviar resultados a Axe Developer Hub
axe licenses — mostrar licencias de dependencias
axe reporter — generar informes a partir de resultados JSON
axe ruleset — generar conjuntos de reglas personalizados
axe spec — ejecutar un archivo de especificaciones

`axe <url>`

Analiza una o más páginas web en busca de problemas de accesibilidad. Consulta Páginas de Prueba para la documentación completa.

axe <url...> [options]

Algunas opciones se guardan en un archivo de preferencias y persisten entre ejecuciones de CLI. Consulta Configuración para más detalles.

Opción	Descripción
`-a, --axe-source <path>`	Ruta a un `axe.js` archivo alternativo.
`--accept-untrusted`	Aceptar certificados SSL no confiables. Persiste.
`--axe-devhub-api-key <api-key>`	Clave API para Axe Developer Hub.
`--axe-devhub-project-id <project-id>`	ID del proyecto para Axe Developer Hub.
`--axe-devhub-server-url <url>`	URL del servidor de Axe Developer Hub. Predeterminado: `https://axe.deque.com`.
`--axe-reports-api-key <api-key>`	Clave API para Axe Reports.
`--axe-reports-dimensions <dimensions>`	Dimensiones JTBD separadas por comas para etiquetar este análisis en Axe Reports.
`--axe-reports-url <url>`	URL para enviar resultados a Axe Reports.
`--browser [name]`	Navegador a utilizar. Requiere el WebDriver correspondiente. Valores válidos: `firefox` (predeterminado), `chrome`, `safari`, `edge`, `ie`. Persiste.
`--chrome-options [options]`	Conmutadores de línea de comandos de Chrome separados por comas y pasados a ChromeDriver. Persiste.
`--chrome-path <path>`	Ruta absoluta al ejecutable del navegador Chrome.
`--chromedriver-path <path>`	Ruta absoluta al ejecutable de ChromeDriver.
`-c, --custom <path>`	Ruta a un archivo de conjunto de reglas personalizado que reemplaza a las predeterminadas.
`-d, --dir <path>`	Directorio donde se guardan los resultados JSON.
`-l, --disable <list>`	IDs de reglas separadas por comas para deshabilitar.
`-e, --exclude <list>`	Selectores CSS separados por comas para elementos a excluir de las pruebas.
`-q, --exit`	Salir con el código `1` si se encuentran violaciones.
`--enable-tracking <state>`	Habilitar (`true`) o deshabilitar (`false`) el envío de datos de uso a la biblioteca de métricas. Persiste.
`-f, --format <value>`	Formato(s) del informe: `html`, `junit`, `csv`, o una `+`combinación separada por guiones. Predeterminado: `html`. Requiere `-r, --report`.
`--filter <list>`	Tipos de resultados separados por comas a incluir: `passes`, `violations`, `incomplete`, `inapplicable`. Requiere `--format csv`.
`--headless`	Lanza el navegador en modo sin cabeza. Persiste.
`-i, --include <list>`	Selectores CSS separados por comas. Solo se prueban los elementos coincidentes.
`--load-delay <n>`	Milisegundos para esperar después de cargar la página antes de ejecutar la auditoría. Predeterminado: `0`.
`--no-git-data`	No enviar datos de rama y commit de Git a Axe Developer Hub.
`--no-reporter`	Suprimir la salida del resumen de violación.
`--page-timeout <ms>`	Milisegundos máximos para esperar a que cargue una página. Predeterminado: `60000`. Persiste.
`--post-analyze-pause <ms>`	Milisegundos para pausar después del análisis antes de la siguiente acción. Predeterminado: `2000`. Persiste.
`--post-get-pause <ms>`	Milisegundos para pausar después de cargar la página y antes de escanear. Predeterminado: `2000`. Persiste.
`--post-script-pause <ms>`	Milisegundos para pausar después de una acción del script y antes de escanear. Predeterminado: `2000`. Persiste.
`-r, --report <output-dir>`	Directorio donde se guarda el informe formateado. Usar con `-f, --format`.
`--remote-proxy [proxy-server]`	Redirigir el tráfico a través de un proxy remoto (solo ChromeDriver). Persiste.
`--remote-server [server-url]`	Conectar a un servidor remoto de WebDriver (por ejemplo, Selenium Grid, BrowserStack). Persiste.
`--rules <list>`	IDs de reglas separadas por comas para ejecutar. Solo se verifican las reglas especificadas.
`-s, --save [filename]`	Guardar resultados como un archivo JSON. El nombre del archivo predetermina a `axe-result.json`.
`--script-timeout <ms>`	Milisegundos máximos para esperar un script de flujo de trabajo. Predeterminado: `60000`. Persiste.
`--send-axe-reports`	Enviar resultados del análisis a Axe Reports.
`--set-distinct-id <id>`	Sobrescribir el ID distintivo utilizado para el seguimiento de uso. Persiste.
`--set-tracking-url <url>`	Sobrescribir la URL donde se envían los datos de métricas. Persiste.
`--show-errors`	Mostrar el seguimiento de error completo en errores.
`-j, --stdout`	Output de resultados JSON a stdout; silencia toda otra salida.
`-t, --tags <list>`	Etiquetas separadas por comas para filtrar qué reglas se ejecutan.
`--timer`	Imprimir mediciones de tiempo después de cada ejecución de prueba.
`-v, --verbose`	Incluir el nombre de la herramienta, versión y metadatos del entorno en la salida.
`-V, --version`	Mostrar el número de versión.
`--window-size <width,height>`	Establecer el tamaño de la ventana del navegador en píxeles. Persiste.

`axe bulk-reports`

Envía resultados JSON a Axe Reports. Ver Enviar a Axe Reports para la documentación completa.

axe bulk-reports <results-directory> [options]

Opción	Descripción
`--axe-reports-api-key <api-key>`	Clave API para Axe Reports.
`--axe-reports-dimensions <dimensions>`	Dimensiones JTBD separadas por comas para etiquetar este análisis en Axe Reports.
`--axe-reports-url <url>`	URL para enviar resultados a Axe Reports.
`--send-axe-reports`	Enviar resultados del análisis a Axe Reports.
`--verbose`	Habilitar registro de verbosidad.

`axe bulk-spec`

Procesa un directorio de archivos de especificaciones en una sola ejecución. Vea Workflow Specs para la documentación completa.

axe bulk-spec <spec-files-directory> [output-directory] [options]

Opción	Descripción
`-a, --axe-source <path>`	Ruta a un `axe.js` archivo alternativo.
`--accept-untrusted`	Aceptar certificados SSL no confiables. Se mantiene.
`--browser [name]`	Navegador a utilizar. Requiere el WebDriver correspondiente. Valores válidos: `firefox` (por defecto), `chrome`, `safari`, `edge`, `ie`. Se mantiene.
`-c, --custom <path>`	Ruta a un archivo de conjunto de reglas personalizado, que anula el predeterminado.
`--dismiss-alerts`	Descartar `alert()`del navegador, `confirm()`, y `prompt()` diálogos antes de escanear.
`--enable-tracking <state>`	Habilitar (`true`) o deshabilitar (`false`) el envío de datos de uso a la biblioteca de métricas. Se mantiene.
`-f, --format [value]`	Formato(s) del informe: `html`, `junit`, `csv`, o una combinación separada por `+`-. Predeterminado: `html`.
`--headless`	Lanzar el navegador en modo sin cabeza. Se mantiene.
`--no-analyze`	Eliminar el requisito de una `analyze` acción en la lista de acciones de cada página.
`--no-html`	Evitar la generación de informes HTML.
`--no-reports`	Evitar la generación de todos los archivos de informe.
`--no-wait`	Deshabilitar pausas automáticas entre acciones de flujo de trabajo.
`--page-timeout <ms>`	Milisegundos máximos para esperar que cargue una página. Predeterminado: `60000`. Se mantiene.
`--post-analyze-pause <ms>`	Milisegundos de pausa después del análisis antes de la siguiente acción. Predeterminado: `2000`. Se mantiene.
`--post-get-pause <ms>`	Milisegundos de pausa después de cargar la página y antes de escanear. Predeterminado: `2000`. Se mantiene.
`--post-script-pause <ms>`	Milisegundos de pausa después de una acción de script y antes de escanear. Predeterminado: `2000`. Se mantiene.
`--remote-proxy [proxy-server]`	Dirigir el tráfico a través de un proxy remoto (solo ChromeDriver). Se mantiene.
`--remote-server [server-url]`	Conectarse a un servidor WebDriver remoto (p. ej., Selenium Grid, BrowserStack). Se mantiene.
`--script-timeout <ms>`	Milisegundos máximos para esperar un script de flujo de trabajo. Predeterminado: `60000`. Se mantiene.
`--set-distinct-id <id>`	Sobrescribir el ID distinto utilizado para el seguimiento de uso. Persistente.
`--set-tracking-url <url>`	Sobrescribir la URL a donde se envían los datos de métricas. Persistente.
`-t, --tags [list]`	Etiquetas separadas por comas para filtrar qué reglas se ejecutan.
`--user-agent <agent>`	Establecer una cadena de agente de usuario personalizada. Persistente.
`--validate`	Validar los archivos de especificaciones sin ejecutarlos.
`--wait-network-idle-new-connections [number]`	Nuevo umbral de conexión antes de que la red se considere inactiva.
`--wait-network-idle-open-connections [number]`	Umbral de conexión abierta antes de que la red se considere inactiva.
`--wait-network-idle-timeout [ms]`	Milisegundos máximos para esperar a que la red esté inactiva antes de proceder.
`--window-size <width,height>`	Establecer el tamaño de la ventana del navegador en píxeles. Persistente.

`axe config-selenium`

Configura interactivamente los valores predeterminados persistentes del navegador y del tiempo. Consulte Configuración para obtener documentación completa.

axe config-selenium [options]

Opción	Descripción
`-s, --show`	Mostrar la configuración guardada actual sin ingresar al aviso interactivo.

`axe devhub`

Envía los resultados JSON a Axe Developer Hub. Consulte Enviar a Axe Developer Hub para obtener documentación completa.

axe devhub <results-directory|file> [options]

Opción	Descripción
`--axe-devhub-api-key <api-key>`	Clave API para Axe Developer Hub. Sobrescribe la `AXE_DEVHUB_API_KEY` variable de entorno.
`--axe-devhub-project-id <project-id>`	ID del proyecto para Axe Developer Hub.
`--axe-devhub-server-url <url>`	URL del servidor de Axe Developer Hub. Predeterminado: `https://axe.deque.com`.
`--no-git-data`	No enviar los datos de rama y commit de Git a Axe Developer Hub.

`axe licenses`

Muestra y guarda las licencias de código abierto para todas las dependencias de CLI.

axe licenses [options]

`axe reporter`

Convierte los resultados JSON en informes HTML, JUnit XML o CSV. Consulte Generar Informes para obtener documentación completa.

axe reporter <results-dir> [dest-dir] [options]

Opción	Descripción
`-b, --browser [name]`	Cuando el directorio de resultados contiene resultados de múltiples navegadores, generar el informe solo a partir de los resultados de un navegador.
`-d, --dest [path]`	Directorio de salida para los informes generados. También se puede especificar como el segundo argumento posicional.
`--filter <list>`	Tipos de resultado separados por comas para incluir: `passes`, `violations`, `incomplete`, `inapplicable`. Requiere `--format csv`.
`-f, --format [type(s)]`	Formato(s) de salida: `html`, `junit`, `csv`, o una combinación. Predeterminado: `html`.

`axe ruleset`

Genera archivos de conjunto de reglas personalizados. Consulte Conjuntos de Reglas Personalizados para obtener documentación completa.

axe ruleset [options]

Opción	Descripción
`--508 [filename]`	Generar una configuración estándar para las reglas de la Sección 508.
`--all [filename]`	Generar una configuración estándar para todas las guías de accesibilidad admitidas.
`-a, --axe-source <path>`	Ruta a una fuente de axe personalizada.
`-c, --custom [dir]`	Generar un conjunto de reglas personalizado desde un directorio que contiene un `changes.json` archivo.
`-d, --destination [dir]`	Directorio de salida. Predeterminado: directorio de trabajo actual.
`-x, --disable-other-rules`	Desactivar todas las reglas no incluidas en la propiedad `rules` . Predeterminado: `true`.
`--en301549 [filename]`	Generar una configuración estándar para las reglas de EN 301 549.
`-f, --format [format]`	Formato de salida.
`-l, --log`	También generar una lista de todas las reglas incluidas en el conjunto de reglas generado.
`--only-changes`	Generar solo los cambios y adiciones al conjunto de reglas.
`--rgaav4 [filename]`	Generar una configuración estándar para las reglas de RGAA v4.
`-t, --tags [list]`	Etiquetas separadas por comas para filtrar el conjunto de reglas estándar.
`--ttv5 [filename]`	Generar una configuración estándar para las reglas de Trusted Tester v5.
`--wcag2 [filename]`	Generar una configuración estándar para las reglas de WCAG 2.0 AA.
`--wcag21 [filename]`	Generar una configuración estándar para las reglas de WCAG 2.1 AA.
`--wcag21aaa [filename]`	Generar una configuración estándar para las reglas de WCAG 2.1 AAA.
`--wcag22 [filename]`	Generar una configuración estándar para las reglas de WCAG 2.2 AA.
`--wcag22aaa [filename]`	Generar una configuración estándar para las reglas de WCAG 2.2 AAA.
`--wcag2aaa [filename]`	Generar una configuración estándar para las reglas de WCAG 2.0 AAA.

`axe spec`

Analiza páginas definidas en un archivo de especificaciones JSON o YAML. Consulte Especificaciones de flujo de trabajo para la documentación completa.

axe spec <spec-file> [output-directory] [options]

Opción	Descripción
`-a, --axe-source <path>`	Ruta a un `axe.js` archivo alternativo.
`--accept-untrusted`	Aceptar certificados SSL no confiables. Persiste.
`--axe-devhub-api-key <api-key>`	Clave API para Axe Developer Hub.
`--axe-devhub-project-id <project-id>`	ID del proyecto para Axe Developer Hub.
`--axe-devhub-server-url <url>`	URL del servidor de Axe Developer Hub. Predeterminado: `https://axe.deque.com`.
`--axe-reports-api-key <api-key>`	Clave API para Axe Reports.
`--axe-reports-dimensions <dimensions>`	Dimensiones JTBD separadas por comas para etiquetar este análisis en Axe Reports.
`--axe-reports-url <url>`	URL para enviar resultados a Axe Reports.
`--browser [name]`	Navegador a usar. Requiere el correspondiente WebDriver. Valores válidos: `firefox` (predeterminado), `chrome`, `safari`, `edge`, `ie`. Persiste.
`--chrome-options [options]`	Interruptores de línea de comandos separados por comas para pasar a ChromeDriver. Persiste.
`-c, --custom <path>`	Ruta a un archivo de conjunto de reglas personalizado, anulando el predeterminado.
`--descendant-links`	Recoger enlaces en cada página y agregarlos a los resultados. Requiere `--verbose`.
`--dismiss-alerts`	Descartar navegador `alert()`, `confirm()`, y `prompt()` cuadros de diálogo antes de escanear.
`--download-path <path>`	Establece dónde el navegador guarda las descargas (solo Chrome).
`--enable-tracking <state>`	Habilitar (`true`) o deshabilitar (`false`) el envío de datos de uso a la biblioteca de métricas. Persiste.
`-f, --format [value]`	Formato(s) de informe: `html`, `junit`, `csv`, o una combinación separada por `+`-. Predeterminado: `html`.
`--filter <list>`	Tipos de resultados separados por comas para incluir: `passes`, `violations`, `incomplete`, `inapplicable`. Requiere `--format csv`.
`--headless`	Inicia el navegador en modo sin cabeza. Persiste.
`--interactive-mode`	Permite que la CLI se ejecute en páginas que usan modo interactivo (solo Chrome).
`--no-analyze`	Elimina el requisito de una `analyze` acción en la lista de acciones de cada página.
`--no-exit`	Forzar el código de salida `0` incluso cuando se encuentran infracciones.
`--no-git-data`	No enviar datos de rama y commit de Git a Axe Developer Hub.
`--no-html`	Prevenir la generación de informes HTML.
`--no-reports`	Prevenir la generación de todos los archivos de informe.
`--no-wait`	Desactivar pausas automáticas entre acciones del flujo de trabajo.
`--page-name <name>`	Ejecutar solo la página con el nombre especificado del archivo de especificaciones.
`--page-source`	Agregar el código fuente HTML escaneado a los resultados. Requiere `--verbose`.
`--page-timeout <ms>`	Máximo de milisegundos para esperar a que una página cargue. Predeterminado: `60000`. Persiste.
`--page-title`	Agregar el título de la página a los resultados. Requiere `--verbose`.
`--post-analyze-pause <ms>`	Milisegundos para pausar después del análisis antes de la siguiente acción. Predeterminado: `2000`. Persiste.
`--post-get-pause <ms>`	Milisegundos para pausar después de cargar la página y antes de escanear. Predeterminado: `2000`. Persiste.
`--post-script-pause <ms>`	Milisegundos para pausar después de una acción de script y antes de escanear. Predeterminado: `2000`. Persiste.
`--remote-proxy [proxy-server]`	Dirigir el tráfico a través de un proxy remoto (solo ChromeDriver). Persiste.
`--remote-server [server-url]`	Conectar a un servidor remoto de WebDriver (por ejemplo, Selenium Grid, BrowserStack). Persiste.
`--resume-from <name>`	Omitir todas las páginas antes de la página nombrada en el archivo de especificaciones.
`--scanned-url`	Agregar la URL base y la URL de escaneo a los resultados detallados. Solo Chrome. Requiere `--verbose`.
`--script-timeout <ms>`	Máximo de milisegundos para esperar un script de flujo de trabajo. Predeterminado: `60000`. Persiste.
`--send-axe-reports`	Enviar los resultados del análisis a Axe Reports.
`--set-distinct-id <id>`	Sobrescribir el ID distinto usado para el seguimiento de uso. Persiste.
`--set-legacy-mode`	Habilitar el modo de escaneo heredado. Obsoleto: será eliminado en la v5.0.
`--set-tracking-url <url>`	Anular la URL a la que se envían los datos de métricas. Se mantiene.
`--silent-mode`	Suprimir toda la salida decorativa; los resultados se muestran solo cuando `--verbose` también está activo.
`-t, --tags [list]`	Etiquetas separadas por comas para filtrar qué reglas se ejecutan.
`--user-agent <agent>`	Establecer una cadena de agente de usuario personalizada. Se mantiene.
`--validate`	Validar el archivo de especificaciones sin ejecutarlo.
`-v, --verbose`	Incluir el nombre de la herramienta, la versión y los metadatos del entorno en la salida.
`--wait-network-idle-new-connections [number]`	Umbral de nuevas conexiones antes de que la red se considere inactiva.
`--wait-network-idle-open-connections [number]`	Umbral de conexiones abiertas antes de que la red se considere inactiva.
`--wait-network-idle-polling-every [ms]`	Intervalo de sondeo en milisegundos para la detección de inactividad de la red.
`--wait-network-idle-timeout [ms]`	Máximo de milisegundos a esperar por inactividad de la red antes de continuar.
`--window-size <width,height>`	Establecer el tamaño de la ventana del navegador en píxeles. Se mantiene.