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 dessa opção. É destinada a casos de uso avançados, como testar uma versão específica ou corrigida do axe-core.

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

Especifique a chave API da Conta Axe para usar ao enviar 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 opção de linha de comando) após a conclusão dos testes. Tanto --axe-devhub-project-id quanto --axe-devhub-api-key são necessários para enviar resultados ao Axe Developer Hub. Veja --axe-devhub-project-id Usando o CLI para Enviar Resultados de Acessibilidade para o Axe Developer Hub para mais informações. Especifique o ID do projeto do Axe Developer Hub para receber resultados de testes de acessibilidade. Tanto

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

quanto --axe-devhub-api-key são necessários para enviar resultados ao Axe Developer Hub. Veja --axe-devhub-project-id Usando o CLI para Enviar Resultados de Acessibilidade para o Axe Developer Hub para mais informações. Especifique a URL do servidor do Axe Developer Hub. O padrão é

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

. Equivalente à variável de ambiente https://axe.deque.com. Veja AXE_DEVHUB_SERVER_URL Usando o CLI para Enviar Resultados de Acessibilidade para o Axe Developer Hub para mais informações. Especifique um conjunto de regras personalizado para usar. Veja

-c, --custom <path>

Conjuntos de Regras Personalizados para detalhes sobre como gerar um arquivo de conjunto de regras. Lista de switches de linha de comando do Chrome, separados por vírgula, para passar para o navegador. Por exemplo:

--chrome-options [options]

Caminho absoluto para o executável do navegador Chrome. Use isso para apontar

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

--chrome-path <path>

para uma instalação específica do Chrome quando o navegador padrão não puder ser encontrado, ou você precisar executar contra uma versão específica. axe Caminho absoluto para o executável do ChromeDriver. O ChromeDriver é um binário separado do próprio navegador Chrome; ele funciona como uma ponte que traduz os comandos WebDriver do

--chromedriver-path <path>

em instruções que o Chrome pode executar. axeO diretório onde o arquivo de resultados JSON é salvo. Sem esta flag (ou

-d, --dir <path>

ou --save ), nenhum arquivo é escrito e os resultados são impressos no terminal como um resumo legível por humanos. Veja também --reportse você precisar de uma saída legível por máquina sem escrever no disco. -j, --stdout Lista de IDs de regras separadas por vírgula para desativar. Veja as

-l, --disable <list>

descrições das regras do axe-core para uma lista completa de IDs de regras. Lista de seletores CSS separados por vírgula para elementos a serem excluídos dos testes. Por exemplo:

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

-e, --exclude <list>

Formato do relatório gerado. Requer

# 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>

. Veja -r, --reportCriando e Filtrando Relatórios para detalhes sobre o que cada formato contém. Padrão: . htmlValor

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

--filter <list>

Comma-separated list of result types to include in the CSV output. Only the specified types will appear; all others are excluded. Valid values are passes, violations, incomplete, e 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 somente os elementos correspondentes, e todo o resto 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 o teste 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

Escreva os resultados completos como JSON legível por máquina no stdout em vez do resumo legível por humanos no terminal. Todo o outro resultado é silenciado. Use isso ao direcionar os 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 relate 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 do resumo de violações (IDs de regras, contagens, seletores afetados e URLs de ajuda) sem silenciar tudo. Mensagens de progresso e resultados escritos no disco via --save, --dir, ou --report não são afetados. Principalmente útil em pipelines de CI onde você está salvando resultados em um arquivo e usando --exit para sinalização de passagem/falha e não deseja detalhes verbosos de violações no log de build. Para silêncio completo com saída de resultados 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 quiser um relatório legível por humanos ou analisável por máquinas ao invés de JSON bruto, por exemplo, um relatório HTML para compartilhar com partes interessadas ou um arquivo JUnit XML para integração 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. Somente as regras especificadas são verificadas; todas as outras são ignoradas. Veja as descrições de regras do 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 é nomeado axe-result.json. Para salvar em um diretório específico, use -d, --dir.

--show-errors

Quando axe encontra um erro em tempo de execução (como uma falha ao inicializar ou uma exceção lançada durante a execução), normalmente imprime uma breve mensagem de erro para stderr. Este sinalizador adiciona o stack trace completo a essa saída. Não afeta como as violações de acessibilidade são relatadas. Use isso ao depurar um arquivo --axe-source personalizado, diagnosticando falhas inesperadas em CI ou coletando 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 as regras correspondentes a pelo menos uma das tags especificadas são incluídas. Veja 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 da página pelo 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 do 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.

-v, --verbose

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

• **Motor de Teste**: a versão do axe-core utilizada
• **Ambiente de Teste**: agente do usuário do navegador, largura e altura da área de visualização e orientação da tela
• **Executador de Teste**: o nome do executador

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

Opções de configuração

As opções a seguir controlam o comportamento do navegador e o tempo dos testes. Ao contrário das opções acima, estas persistem entre execuções do CLI; defini-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 obter detalhes completos, consulte Opções de Configuração.