Testando páginas com CLI

Ao usar o modo de entrada URI do CLI, várias opções adicionais estão disponíveis para alterar o escopo e o conjunto de regras de um teste. Por exemplo, o seguinte código excluirá o cabeçalho e o rodapé de um teste e desativará a regra de contraste de cores:

axe http://example.com --exclude footer,header --disable color-contrast

Opções

-a, --axe-source <path>

Caminho para um axe.js arquivo alternativo. A maioria dos usuários não precisa desta opção. Ela é destinada para casos de uso avançados, como testar com uma versão específica ou corrigida do axe-core.

--axe-devhub-api-key <your-API-key>

Especifique a chave da API da Conta Axe para usar no envio de resultados de acessibilidade para o Axe Developer Hub. Os resultados são enviados para o projeto associado ao ID do projeto especificado (especificado com a --axe-devhub-project-id opção da linha de comando) após a conclusão do teste. Ambos --axe-devhub-api-key e --axe-devhub-project-id são necessários para enviar resultados para o Axe Developer Hub. Veja Usando o CLI para Enviar Resultados de Acessibilidade para o Axe Developer Hub para mais informações.

--axe-devhub-project-id <your-project-ID>

Especifique o ID do projeto do Axe Developer Hub para receber os resultados dos testes de acessibilidade. Ambos --axe-devhub-api-key e --axe-devhub-project-id são necessários para enviar resultados para o Axe Developer Hub. Veja Usando o CLI para Enviar Resultados de Acessibilidade para o Axe Developer Hub para mais informações.

--axe-devhub-server-url <url>

Especifique a URL do servidor do Axe Developer Hub. O padrão é https://axe.deque.com. Equivalente à variável de ambiente AXE_DEVHUB_SERVER_URL . Veja Usando o CLI para Enviar Resultados de Acessibilidade para o Axe Developer Hub para mais informações.

-c, --custom <path>

Especifique um conjunto de regras personalizado para usar. Veja Regras Personalizadas para detalhes sobre como gerar um arquivo de conjunto de regras.

--chrome-options [options]

Lista separada por vírgulas de switches da linha de comando do Chrome para passar ao navegador. Por exemplo:

axe http://example.com --chrome-options="some-switch,some-other-switch"

--chrome-path <path>

Caminho absoluto para o executável do navegador Chrome. Use isso para apontar axe para uma instalação específica do Chrome quando o navegador padrão não pode ser encontrado ou se você precisar executar em uma versão específica.

--chromedriver-path <path>

Caminho absoluto para o executável ChromeDriver. O ChromeDriver é um binário separado do navegador Chrome em si; ele atua como uma ponte que traduz os comandos WebDriver de axeem instruções que o Chrome pode executar.

-d, --dir <path>

O diretório onde o arquivo de resultados em JSON é salvo. Sem esta bandeira (ou --save ou --report), nenhum arquivo é escrito, e os resultados são impressos no terminal como um resumo legível por humanos. Veja também -j, --stdout se precisar de saída legível por máquina sem gravar em disco.

-l, --disable <list>

Lista separada por vírgulas de IDs de regras para desativar. Veja as descrições das regras do axe-core para uma lista completa de IDs de regras.

axe http://example.com --disable color-contrast,duplicate-id

-e, --exclude <list>

Lista separada por vírgulas de seletores CSS para elementos a serem excluídos do teste. Por exemplo:

# Exclude by element type
axe http://example.com --exclude footer,header

# Exclude by class or ID
axe http://example.com --exclude ".ad-banner,#cookie-notice"

# Exclude by attribute
axe http://example.com --exclude "[aria-hidden=true]"

-f, --format <value>

Formato do relatório gerado. Requer -r, --report. Veja Criando e Filtrando Relatórios para detalhes sobre o que cada formato contém. Padrão: html.

axe http://example.com --report ./reports --format html+junit+csv

--filter <list>

Lista separada por vírgulas dos tipos de resultados a incluir na saída CSV. Apenas os tipos especificados aparecerão; todos os outros são excluídos. Valores válidos são passes, violations, incompletee inapplicable. Requer --format csv.

axe reporter ./axe-reports/json/ --format=csv --filter passes,inapplicable

-i, --include <list>

Lista separada por vírgulas de seletores CSS. Quando especificado, axe testa apenas os elementos correspondentes, e tudo o mais na página é ignorado. Isso é altamente restritivo, e a maioria dos usuários deve usar -e, --exclude em vez disso. Use --include apenas quando quiser isolar testes para um componente específico, como durante a depuração focada ou verificações de CI a nível de componente.

# Test only the main navigation
axe http://example.com --include nav

# Test only elements with a specific class or ID
axe http://example.com --include ".my-widget,#signup-form"

# Test only elements with a specific attribute
axe http://example.com --include "[data-testid=checkout]"

-j, --stdout

Grave os resultados completos como JSON legível por máquina no stdout em vez do resumo legível por humanos no terminal. Toda a outra saída é silenciada. Use isso ao canalizar resultados para outro programa.

--load-delay <n>

Defina quanto tempo (milissegundos) axe aguardará após o carregamento da página antes de executar a auditoria (padrão: 0).

--no-git-data

Não reporte informações de branch e commit do Git ao enviar resultados para o Axe Developer Hub. Veja Usando a CLI para enviar resultados de acessibilidade para o Axe Developer Hub.

--no-reporter

Suprime a saída de resumo de violações (IDs de regras, contagens, seletores afetados e URLs de ajuda) sem silenciar tudo. Mensagens de progresso e resultados escritos em disco via --save, --dir, ou --report não são afetadas. Principalmente útil em pipelines de CI onde você está salvando resultados em um arquivo e usando --exit para sinalização de aprovação/reprovação e não quer detalhes verbosos de violações no log de compilação. Para silêncio completo com saída de resultados em JSON, use -j, --stdout em vez disso.

-q, --exit

Saia com o código de falha 1 se algum teste de acessibilidade falhar.

-r, --report <output-dir>

O diretório onde o relatório formatado é escrito. Funciona com -f, --format para controlar o formato de saída (HTML por padrão). Use isso quando desejar um relatório legível por humanos ou analisável por máquina em vez de JSON bruto, por exemplo, um relatório HTML para compartilhar com partes interessadas ou um arquivo XML JUnit para integração de CI. Para saída de JSON bruto, use -d, --dir em vez disso.

--rules <list>

Lista separada por vírgulas de IDs de regras a serem executadas. Apenas as regras especificadas são verificadas; todas as outras são ignoradas. Veja as descrições das regras axe-core para uma lista completa de IDs de regras.

axe http://example.com --rules color-contrast,duplicate-id

-s, --save [filename]

Salve os resultados como um arquivo JSON no diretório atual. O nome do arquivo é opcional; se omitido, o arquivo será nomeado axe-result.json. Para salvar em um diretório específico, use -d, --dir.

--show-errors

Quando axe encontra um erro de execução (como uma falha ao inicializar ou uma exceção lançada durante a execução), normalmente imprime uma mensagem de erro breve no stderr. Esta flag adiciona o rastreamento completo da pilha a essa saída. Não afeta como as violações de acessibilidade são relatadas. Use isso ao depurar um --axe-source arquivo personalizado, diagnosticando falhas inesperadas em CI, ou reunindo informações para um relatório de bug.

-t, --tags <list>

Lista separada por vírgulas de tags para filtrar quais regras são executadas. Apenas regras que correspondem a pelo menos uma das tags especificadas são incluídas. Consulte a documentação de tags do axe-core para uma lista completa de tags disponíveis.

axe http://example.com --tags wcag2a,wcag2aa

--timer

Imprime três medições de tempo no terminal após cada execução de teste:

• Tempo de carregamento de página do Axe: quanto tempo a página levou para carregar no navegador
• Tempo de execução do axe-core: quanto tempo o axe-core levou para analisar a página
• Tempo total de teste: tempo decorrido de ponta a ponta para a execução

Use isso para diagnosticar testes lentos. Por exemplo, use esta opção para determinar se o tempo é gasto esperando o carregamento da página ou na análise do Axe, ou para investigar por que uma execução está atingindo --page-timeout ou --script-timeout limites.

--universal-best-practices

Registros bestPracticesEnabled=true no metadado da saída do formato universal. Requer --format universal.

--universal-ruleset <id>

Especifica o ID do conjunto de regras a ser registrado no metadado da saída do formato universal. O padrão é wcag2.1. Requer --format universal.

-v, --verbose

Quando violações são encontradas, imprime um bloco JSON após o resumo da violação contendo:

• Motor de Teste: a versão do axe-core usada
• Ambiente de Teste: agente do usuário do navegador, largura e altura do visor, e orientação da tela
• Runner de Teste: o nome do runner

Note que esta saída só aparece quando violações são detectadas. Se uma página não tiver violações, o metadado não é impresso. Use isso quando precisar confirmar exatamente qual versão do axe-core foi executada, verificar configurações de visor ou incluir detalhes do ambiente em um relatório de erros.

Opções de Configuração

As seguintes opções controlam o comportamento do navegador e o tempo de teste. Ao contrário das opções acima, estas persistem entre execuções do CLI; configurá-las uma vez salva o valor em um arquivo de preferências usado para todas as execuções futuras. Elas também podem ser configuradas interativamente usando axe config-selenium.

Para mais detalhes, veja Opções de Configuração.