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 arquivo axe.js alternativo. A maioria dos usuários não precisa desta opção. Ela é destinada para casos de uso avançados, como testes contra uma versão específica ou corrigida do axe-core.

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

Especifique a chave da API do Axe Account para uso ao enviar resultados de acessibilidade ao 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 --axe-devhub-project-id) após a conclusão do teste. Tanto --axe-devhub-api-key quanto --axe-devhub-project-id são necessários para enviar resultados ao Axe Developer Hub. Consulte Usando a 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. Tanto --axe-devhub-api-key quanto --axe-devhub-project-id são necessários para enviar resultados ao Axe Developer Hub. Consulte Usando a CLI para enviar resultados de acessibilidade para o Axe Developer Hub para mais informações.

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

Especifique o URL do servidor do Axe Developer Hub. O padrão é https://axe.deque.com. Equivalente à variável de ambiente AXE_DEVHUB_SERVER_URL. Consulte Usando a 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. Consulte 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 puder ser encontrado, ou você precisar executar contra uma versão específica.

--chromedriver-path <path>

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

-d, --dir <path>

O diretório onde o arquivo de resultados JSON é salvo. Sem esta flag (ou --save ou --report), nenhum arquivo é gravado, e os resultados são impressos no terminal como um resumo legível para humanos. Consulte também -j, --stdout se você precisar de uma saída legível por máquina sem escrever para o disco.

-l, --disable <list>

Lista de IDs de regras separadas por vírgula para desativar. Consulte o descrições das regras 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. Consulte 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 de tipos de resultados separados por vírgulas para incluir na saída CSV. Apenas os tipos especificados aparecerão; todos os outros são excluídos. Os valores válidos são passes, violations, incomplete e inapplicable. Requer --format csv.

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

-i, --include <list>

Lista de seletores CSS separados por vírgulas. 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 você quiser isolar testes a um componente específico, como durante depuração focada ou verificações de CI no 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 ramo e commit do Git ao enviar resultados ao Axe Developer Hub. Consulte 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 gravados 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 passar/falhar e não quer detalhes extensos de violações no log de construção. Para um 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 parseável por máquina, em vez de JSON bruto, por exemplo, um relatório HTML para compartilhar com as partes interessadas ou um arquivo XML JUnit para integração em CI. Para saída JSON bruta, use -d, --dir em vez disso.

--rules <list>

Lista de IDs de regras separadas por vírgulas para executar. Apenas as regras especificadas são verificadas; todas as outras são ignoradas. Consulte o 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 é nomeado axe-result.json. Para salvar em um diretório específico, use -d, --dir.

--show-errors

Quando axe encontra um erro de 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 rastreamento completo àquela saída. Isso não afeta como as violações de acessibilidade são relatadas. Use isso ao depurar um arquivo --axe-source personalizado, diagnosticar falhas inesperadas em CI ou coletar informações para um relatório de bug.

-t, --tags <list>

Lista de tags separadas por vírgulas para filtrar quais regras serão executadas. Apenas as regras que correspondem a pelo menos uma das tags especificadas são incluídas. Consulte o documentação de tags do axe-core para uma lista completa das 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 isto para diagnosticar testes lentos. Por exemplo, use esta opção para determinar se o tempo está sendo gasto esperando o carregamento da página ou na análise do Axe, ou para investigar por que uma execução está atingindo os limites --page-timeout ou --script-timeout.

--universal-best-practices

Registra bestPracticesEnabled=true nos metadados da saída de formato universal. Requer --format universal.

--universal-ruleset <id>

Especifica o ID do conjunto de regras para registrar nos metadados da saída de 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 utilizada
• Ambiente de Teste: agente de usuário do navegador, largura e altura da janela de visualização e orientação da tela
• Runner de Teste: o nome do executor

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 opções a seguir controlam o comportamento do navegador e o tempo dos testes. Ao contrário das opções acima, essas 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 detalhes completos, consulte Opções de Configuração.