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

Uma ferramenta de linha de comando para automatizar testes de acessibilidade na web sem escrever código de teste.

Not for use with personal data

O Axe DevTools for Web CLI é uma ferramenta de linha de comando que executa análises de acessibilidade em páginas da web e gera relatórios. Ele é projetado para equipes que desejam automatizar o teste de acessibilidade sem integrar o Axe DevTools em uma estrutura 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 análise axe produz arquivos de resultados JSON, um por estado de página analisado. Esses arquivos são produzidos durante o teste e você os utiliza ao relatar ou carregar resultados.

O fluxo de trabalho típico possui duas fases:

  1. Analisar páginas: execute uma ou mais URLs através de axe e salve os resultados em 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

  2. Fazer algo com os resultados: converta, carregue ou envie-os 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 as flags --format e --report para gerar relatórios em um único passo, sem uma invocação axe reporter separada.

Elementos Personalizados e ElementInternals

A partir da versão 4.13.0, as verificações leem as semânticas ARIA que os componentes da web declaram em JavaScript através de ElementInternals, em vez de apenas os atributos role e aria-* presentes na marcação. Nenhuma configuração ou opção de linha de comando é necessária. Seus componentes devem publicar seus internos para que isso tenha efeito, e um componente que os armazena em um campo de classe privado não pode ser lido. Veja Testando Elementos Personalizados Que Usam ElementInternals.

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 usa 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, aprovações, verificações incompletas e regras inaplicáveis, junto com metadados como a URL, navegador e marca temporal.

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>].json

Esses arquivos são consumidos por axe reporter, axe bulk-reports e axe devhub. Para detalhes sobre a nomenclatura dos arquivos e a estrutura dos diretórios, veja Gerar Relatórios.

O esquema de resultados JSON é definido pelo axe-core. Para uma referência completa, veja o documentação da API do axe-core.

Nesta seção

Is this page helpful?

Help us improve this page

Still need help?