Axe DevTools para Web CLI
Uma ferramenta de linha de comando para automatizar testes de acessibilidade na web sem escrever código de teste.
O Axe DevTools para Web CLI é uma ferramenta de linha de comando que executa análises de acessibilidade em páginas da web e gera relatórios. Foi projetado para equipes que desejam automatizar testes de acessibilidade sem integrar o axe em um framework de teste existente, por exemplo, como uma etapa em um pipeline de CI/CD, ou quando as APIs do Axe DevTools não estão disponíveis para o seu idioma.
Como Funciona
Cada axe análise produz arquivos de resultados JSON, um para cada estado de página analisado. Esses arquivos são produzidos durante o teste, e você os utiliza ao relatar ou enviar os resultados.
O fluxo de trabalho típico possui duas fases:
-
Analisar páginas: executar uma ou mais URLs através do
axee salvar os resultados JSON:axe <url> → test a URL directly axe spec <spec-file> → test pages and workflows defined in a YAML/JSON file axe bulk-spec <dir> → test using all spec files in a directory -
Fazer algo com os resultados: converter, enviar ou encaminhá-los para outro lugar:
axe reporter <results> → generate HTML, JUnit XML, or CSV reports axe bulk-reports <results> → upload to the Axe Reports service axe devhub <results> → send to Axe Developer Hub
Os comandos axe e axe spec também suportam --format e --report flags para gerar relatórios em um único passo, sem uma axe reporter invocação separada.
Comandos
| Comando | Propósito |
|---|---|
axe <url...> |
Analisar uma ou mais URLs diretamente. Navegador padrão: Firefox. Conjunto de regras padrão: WCAG 2.1 AA. |
axe spec <spec-file> |
Analisar páginas definidas em um arquivo de especificação YAML ou JSON, incluindo fluxos de trabalho de múltiplas etapas. |
axe bulk-spec <dir> |
Executar todos os arquivos de especificação encontrados em um diretório e seus subdiretórios. |
axe reporter <results-dir> |
Converter resultados JSON em relatórios HTML, JUnit XML ou CSV. |
axe bulk-reports <results-dir> |
Enviar resultados JSON para o serviço Axe Reports. |
axe devhub <results-dir> |
Enviar resultados JSON para o Axe Developer Hub. |
axe ruleset |
Listar, validar ou gerenciar conjuntos de regras personalizados. |
axe config-selenium |
Ver ou atualizar configurações padrão de navegador/Selenium. |
Resultados JSON
Quando você executa axe spec ou utiliza axe <url> --save, os resultados são gravados como arquivos JSON no diretório de saída. Cada arquivo captura a análise completa axe para um único estado de página: violações, passagens, verificações incompletas e regras inaplicáveis, junto com metadados como URL, navegador e carimbo de data/hora.
Os arquivos de resultados são organizados por projeto e nomeados conforme a página sendo testada:
<output-dir>/<project-id>/<project-id>-<page-id>[-<analyze-title>].jsonEsses arquivos são utilizados por axe reporter, axe bulk-reports, e axe devhub. Para obter detalhes sobre nomes de arquivos e estrutura de diretórios, veja Gerar Relatórios.
O esquema de resultados JSON é definido pelo axe-core. Para uma referência completa, veja a documentação da API do axe-core.
Nesta seção
- Iniciar: tarefas comuns com exemplos de trabalho
- Instalar: opções de instalação (executável ou pacote Node.js)
- Analisar Páginas: todas as opções para
axe <url> - Analisar Páginas Usando um Arquivo Spec: estrutura do arquivo spec, ações e processamento em lote
- Gerar Relatórios: formatos de relatório, filtragem e estrutura do resultado em JSON
- Enviar para Axe Reports: carregar resultados para o serviço Axe Reports
- Enviar para Axe Developer Hub: integrar resultados com o Axe Developer Hub
- Configurar: seleção de navegador, timeouts e configurações persistentes
- Conjuntos de Regras Personalizadas: WCAG 2.x, Seção 508, e conjuntos de regras personalizadas