Usar la CLI para Enviar Resultados de Accesibilidad a Axe Developer Hub

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

Discute las diferentes maneras de subir los resultados de accesibilidad a Axe Developer Hub usando la CLI

Not for use with personal data

La CLI te permite enviar tus resultados de accesibilidad a Axe Developer Hub. Puedes:

Cargar resultados de pruebas anteriores a Axe Developer Hub. Esta opción utiliza el subcomando devhub de la CLI y te permite subir resultados del análisis de páginas web usando las APIs web o de ejecuciones anteriores de la CLI (donde analizaste páginas individuales o ejecutaste archivos de especificaciones y guardaste los resultados).
Analizar páginas individuales y enviar resultados directamente a Axe Developer Hub (sin primero guardar archivos de resultados).
Ejecutar archivos de especificaciones y enviar resultados directamente a Axe Developer Hub (sin primero guardar archivos de resultados).

Requisitos

Para usar la CLI con Axe Developer Hub, necesitarás:

Una cuenta de Axe y una suscripción para Axe Developer Hub. Ve Comenzar con Axe Developer Hub para más información.
Un proyecto de Axe Developer Hub donde subas resultados. Ve Crear un Nuevo Proyecto en Axe Developer Hub para obtener información sobre cómo crear un nuevo proyecto. Cuando creas un proyecto, especificas que el proyecto usará la CLI como su fuente de entrada o datos. Necesitarás estos valores para subir los resultados:
- Tu clave API personal (mostrada en tu Cuenta de Axe bajo claves API)
- Tu ID de proyecto (mostrado en las instrucciones cuando creas un nuevo proyecto en Axe Developer Hub)
(Opcional) Si tienes pruebas que usan las APIs web, necesitarás modificar tus pruebas para producir un archivo o archivos de resultados. Un archivo de resultados es un archivo .json que contiene los resultados de tu ejecución de prueba, y el procedimiento para crear archivos de resultados es diferente dependiendo de la API que utilices. Para más detalles, consulta Creando Archivos de Resultados. Utilizas el subcomando devhub para cargar archivos de resultados.

Enviar Resultados a Axe Developer Hub

Normalmente, la CLI prueba sitios web y produce resultados solo cuando usas la opción -s para guardar resultados (que son archivos .json que contienen información sobre errores de accesibilidad en los sitios web probados). Puedes enviar tus resultados a Axe Developer Hub especificando una clave API en la línea de comando con la opción de línea de comando --axe-devhub-api-key (o configurando la variable de entorno AXE_DEVHUB_API_KEY) y un ID de proyecto con --axe-devhub-project-id (o configurando la variable de entorno AXE_DEVHUB_PROJECT_ID).

Por defecto, la CLI también carga información de Git si el directorio donde estás ejecutando la CLI es parte de un repositorio Git. Consulta Modo Git versus Gitless para obtener información sobre cómo funciona la carga de información de Git.

La CLI asociará la rama de Git actual y el historial de commits con tus resultados de accesibilidad.

important

Al ejecutar la CLI desde dentro de un directorio dentro de un repositorio Git, los resultados que envíes a Axe Developer Hub sobrescribirán cualquier resultado anterior del mismo commit (determinado por su SHA). (Solo un conjunto de resultados puede estar asociado a cada commit). Necesitas crear un nuevo commit cada vez que ejecutes la CLI o renunciar a reportar resultados de Git usando la opción --no-git-data. Ve Modo Git versus Gitless para más información.

Cargar Resultados

Si has ejecutado pruebas anteriormente y tienes archivos de resultados (archivos .json típicamente con nombres como axe-result-2025-09-03T14 02 32-0700.json), puedes subir estos resultados a Axe Developer Hub con el subcomando devhub. Puedes guardar resultados usando la opción de línea de comando -s al probar páginas o ejecutar archivos de especificaciones:

axe https://example.com -s

tip

Al analizar una página o ejecutar un archivo de especificaciones, no necesitas guardar primero los resultados y luego cargarlos. Especificando una clave API y un ID de proyecto, la CLI cargará los resultados cuando el análisis de la página esté completo o cuando tu archivo de especificaciones termine de ejecutarse. Consulta Analizar Páginas Individuales y Ejecutar archivos de especificación.

El ejemplo anterior crea un archivo de resultados que luego puedes subir a Axe Developer Hub, como se muestra a continuación:

axe devhub <results-dir(s)-or-file(s)> --axe-devhub-api-key <your-API-key> --axe-devhub-project-id <your-project-ID>

Puedes usar . (punto) como el directorios-de-resultados-o-archivos para cargar todos los archivos de resultados .json en el directorio actual. También puedes especificar múltiples directorios o archivos para cargar.

Creando Archivos de Resultados con las APIs Web

Si estás usando las APIs web, necesitarás modificar tus pruebas de API para escribir archivos de resultados que luego puedas subir a Axe Developer Hub usando el subcomando devhub. La siguiente tabla contiene enlaces a información sobre cómo crear archivos de resultados, y estas APIs utilizan las APIs de informe o registro proporcionadas para escribir resultados como archivos .json en disco.

API	Nombre del Enlace
Node.js	Axe DevTools Logger
C#	Creando JSON Compatible con el Reportero
Java	Generar Informes con Java
Python	Creando JSON Compatible con el Reportero
Ruby	Opciones de Reporte

Analizar Páginas Individuales

Puedes escanear páginas web individuales y enviar los resultados a Axe Developer Hub especificando una clave API y el ID del proyecto que recibirá los resultados:

axe https://google.com --axe-devhub-api-key <your-API-key> --axe-devhub-project-id <your-project-ID>

En este ejemplo, la CLI ejecuta pruebas de accesibilidad en el sitio de Google y luego envía los resultados al proyecto de Axe Developer Hub referenciado por el ID de proyecto especificado.

También puedes listar múltiples páginas en la línea de comandos para probar:

axe https://example.com/page1.html https://example.com/page2.html --axe-devhub-api-key <your-API-key> --axe-devhub-project-id <your-project-ID>

Visita el proyecto en Axe Developer Hub para ver tus resultados. Ve Resumen de visualización de problemas de accesibilidad.

Ejecutar archivos de especificación

Puedes enviar los resultados de ejecutar tus archivos de especificación usando las opciones de línea de comandos --axe-devhub-api-key y --axe-devhub-project-id.

axe spec my-spec-file.yml --axe-devhub-api-key <your-API-key> --axe-devhub-project-id <your-project-ID>

Este ejemplo ejecuta el archivo de especificación YAML my-spec-file.yml y sube sus resultados de accesibilidad a Axe Developer Hub. Ve Especificaciones de flujo de trabajo y Acciones de flujos de trabajo para más información sobre archivos de especificación.

tip

Si necesitas avanzar en tu archivo de especificación omitiendo la prueba de páginas, puedes usar la opción de línea de comandos --resume-from <page> para reanudar tus pruebas desde una página específica en tu archivo de especificación. Consulta Reanudar desde para más información.

Modo Git versus Gitless

Por defecto, Axe Developer Hub asocia tus resultados de accesibilidad con el último commit de Git en la rama actual cuando ejecutas la CLI desde un directorio dentro de un repositorio Git, permitiéndote vincular fácilmente los errores de accesibilidad con los commits de Git. Sin embargo, un efecto secundario de este comportamiento es que cada vez que reportas resultados a Axe Developer Hub, los nuevos resultados sobrescriben cualquier otra ejecución en el mismo commit (basado en su SHA). Además, si cambias a una rama diferente, cualquier resultado que envíes a Axe Developer Hub estará asociado con el último commit en esa rama.

Si el comportamiento predeterminado de Axe Developer Hub no es lo que prefieres:

Puedes usar la CLI en un directorio fuera de un repositorio de Git.
Puedes usar la opción de línea de comandos --no-git-data para omitir el reporte de información de Git al servidor, ejecutando en lo que se llama modo Sin Git donde cada vez que informes resultados al servidor, se crea una nueva ejecución de prueba e identificada por la hora y fecha de la ejecución en lugar de la rama y el commit como en el modo Git.

Ve Páginas de tu proyecto y La página de ejecuciones de prueba para obtener información sobre cómo se organizan y presentan los resultados de Git y Gitless en Axe Developer Hub.

Opciones de línea de comandos

La CLI acepta estas opciones de línea de comandos:

--axe-devhub-api-key Te permite establecer tu clave API personal, equivalente a la variable de entorno AXE_DEVHUB_API_KEY. Requerido
--axe-devhub-project-id Establece el ID del proyecto para tu proyecto de Axe Developer Hub, equivalente a la variable de entorno AXE_DEVHUB_PROJECT_ID. Requerido
--axe-devhub-server-url Te permite usar un servidor diferente al predeterminado (https://axe.deque.com), equivalente a la variable de entorno AXE_DEVHUB_SERVER_URL. Establece esto si tu organización utiliza una instancia regional, nube privada o despliegue local de Axe Developer Hub. Opcional
--no-git-data Evita informar la información de Git al servidor. Consulta Modo Git versus Gitless para más información. No tiene una variable de entorno equivalente. Opcional

Variables de entorno

Puedes establecer variables de entorno para evitar especificar la clave API, ID del proyecto o URL del servidor en la línea de comandos, lo cual se recomienda al usar la clave API en integración continua para mantenerla secreta.

tip

Configurar AXE_DEVHUB_API_KEY y AXE_DEVHUB_PROJECT_ID permitirá siempre enviar resultados a Axe Developer Hub siempre que analices una página o ejecutes un archivo de especificación. Por ejemplo, si has configurado estas variables de entorno y analizas una página con:

axe https://somewebsite.com

Los resultados serán enviados a Axe Developer Hub. Este comportamiento se aplica cuando usas la CLI para analizar una página o ejecutar un archivo de especificación.

AXE_DEVHUB_API_KEY Especifica tu clave API personal, equivalente a la opción de línea de comandos --axe-devhub-api-key.
AXE_DEVHUB_PROJECT_ID Especifica el ID del proyecto para tu proyecto de Axe Developer Hub, equivalente a la opción de línea de comando --axe-devhub-project-id.
AXE_DEVHUB_SERVER_URL Especifica la URL del servidor de Axe Developer Hub (el predeterminado es https://axe.deque.com), equivalente a la opción de línea de comandos --axe-devhub-server-url. Establece esto si tu organización utiliza una instancia regional, nube privada o despliegue local de Axe Developer Hub.