Referência de 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

Sintaxe de comando e referência completa de opções para todos os subcomandos do Axe DevTools CLI

Not for use with personal data

Uma referência rápida para cada subcomando do Axe DevTools CLI e suas opções. Para orientações de uso e exemplos, siga o link para o artigo de cada comando.

axe <url> — analisar páginas por URL
axe bulk-reports — enviar resultados para o Axe Reports
axe bulk-spec — executar um diretório de arquivos de especificação
axe config-selenium — configurar padrões persistentes do navegador
axe devhub — enviar resultados para o Axe Developer Hub
axe licenses — exibir licenças de dependências
axe reporter — gerar relatórios a partir de resultados JSON
axe ruleset — gerar conjuntos de regras personalizados
axe spec — executar um arquivo de especificação

`axe <url>`

Analisa uma ou mais páginas web para problemas de acessibilidade. Veja Testando Páginas para a documentação completa.

axe <url...> [options]

Algumas opções são salvas em um arquivo de preferências e persistem entre execuções do CLI. Veja Configuração para detalhes.

Opção	Descrição
`-a, --axe-source <path>`	Caminho para um `axe.js` arquivo alternativo.
`--accept-untrusted`	Aceitar certificados SSL não confiáveis. Persiste.
`--axe-devhub-api-key <api-key>`	Chave de API para o Axe Developer Hub.
`--axe-devhub-project-id <project-id>`	ID do projeto para o Axe Developer Hub.
`--axe-devhub-server-url <url>`	URL do servidor do Axe Developer Hub. Padrão: `https://axe.deque.com`.
`--axe-reports-api-key <api-key>`	Chave de API para o Axe Reports.
`--axe-reports-dimensions <dimensions>`	Dimensões JTBD separadas por vírgula para marcar esta varredura no Axe Reports.
`--axe-reports-url <url>`	URL para enviar resultados para o Axe Reports.
`--browser [name]`	Navegador a ser usado. Requer o WebDriver correspondente. Valores válidos: `firefox` (padrão), `chrome`, `safari`, `edge`, `ie`. Persiste.
`--chrome-options [options]`	Interruptores de linha de comando do Chrome separados por vírgula passados para o ChromeDriver. Persiste.
`--chrome-path <path>`	Caminho absoluto para o executável do navegador Chrome.
`--chromedriver-path <path>`	Caminho absoluto para o executável do ChromeDriver.
`-c, --custom <path>`	Caminho para um arquivo de conjunto de regras personalizado, substituindo o padrão.
`-d, --dir <path>`	Diretório onde os resultados JSON são salvos.
`-l, --disable <list>`	IDs de regras a desativar, separados por vírgula.
`-e, --exclude <list>`	Seletores CSS separados por vírgula para elementos a serem excluídos do teste.
`-q, --exit`	Saia com o código `1` se violações forem encontradas.
`--enable-tracking <state>`	Habilitar (`true`) ou desabilitar (`false`) o envio de dados de uso para a biblioteca de métricas. Persiste.
`-f, --format <value>`	Formato(s) de relatório: `html`, `junit`, `csv`, ou uma `+`combinação separada por hífen. Padrão: `html`. Requer `-r, --report`.
`--filter <list>`	Tipos de resultado separados por vírgula a incluir: `passes`, `violations`, `incomplete`, `inapplicable`. Requer `--format csv`.
`--headless`	Inicie o navegador no modo sem cabeça. Persiste.
`-i, --include <list>`	Seletores CSS separados por vírgula. Apenas elementos correspondentes são testados.
`--load-delay <n>`	Milissegundos para esperar após o carregamento da página antes de executar a auditoria. Padrão: `0`.
`--no-git-data`	Não envie dados de branch e commit do Git para o Axe Developer Hub.
`--no-reporter`	Suprimir a saída do resumo de violações.
`--page-timeout <ms>`	Máximo de milissegundos para esperar o carregamento de uma página. Padrão: `60000`. Persiste.
`--post-analyze-pause <ms>`	Milissegundos para pausar após a análise antes da próxima ação. Padrão: `2000`. Persiste.
`--post-get-pause <ms>`	Milissegundos para pausar após o carregamento da página e antes da varredura. Padrão: `2000`. Persiste.
`--post-script-pause <ms>`	Milissegundos para pausar após uma ação de script e antes da varredura. Padrão: `2000`. Persiste.
`-r, --report <output-dir>`	Diretório onde o relatório formatado é escrito. Use com `-f, --format`.
`--remote-proxy [proxy-server]`	Roteie o tráfego através de um proxy remoto (apenas ChromeDriver). Persiste.
`--remote-server [server-url]`	Conecte-se a um servidor WebDriver remoto (por exemplo, Selenium Grid, BrowserStack). Persiste.
`--rules <list>`	IDs de regra separados por vírgula para executar. Apenas as regras especificadas são verificadas.
`-s, --save [filename]`	Salve os resultados como um arquivo JSON. O nome do arquivo padrão é `axe-result.json`.
`--script-timeout <ms>`	Máximo de milissegundos para esperar por um script de fluxo de trabalho. Padrão: `60000`. Persiste.
`--send-axe-reports`	Envie os resultados da análise para o Axe Reports.
`--set-distinct-id <id>`	Substitua o ID distinto usado para rastreamento de uso. Persiste.
`--set-tracking-url <url>`	Substitua a URL para onde os dados de métricas são enviados. Persiste.
`--show-errors`	Exiba o rastreamento completo da pilha de erros em caso de erros.
`-j, --stdout`	Saída de resultados JSON para stdout; silencia toda a outra saída.
`-t, --tags <list>`	Tags separadas por vírgula para filtrar quais regras são executadas.
`--timer`	Imprima medições de tempo após cada execução de teste.
`-v, --verbose`	Inclua o nome da ferramenta, versão e metadados do ambiente na saída.
`-V, --version`	Mostre o número da versão.
`--window-size <width,height>`	Defina o tamanho da janela do navegador em pixels. Persiste.

`axe bulk-reports`

Envia resultados JSON para o Axe Reports. Veja Enviar ao Axe Reports para a documentação completa.

axe bulk-reports <results-directory> [options]

Opção	Descrição
`--axe-reports-api-key <api-key>`	Chave da API para o Axe Reports.
`--axe-reports-dimensions <dimensions>`	Dimensões JTBD separadas por vírgulas para marcar esta varredura nos Relatórios Axe.
`--axe-reports-url <url>`	URL para enviar resultados para os Relatórios Axe.
`--send-axe-reports`	Enviar resultados de análise para os Relatórios Axe.
`--verbose`	Ativar registro detalhado.

`axe bulk-spec`

Processa um diretório de arquivos de especificação em uma única execução. Consulte Especificações de Fluxo de Trabalho para documentação completa.

axe bulk-spec <spec-files-directory> [output-directory] [options]

Opção	Descrição
`-a, --axe-source <path>`	Caminho para um `axe.js` arquivo alternativo.
`--accept-untrusted`	Aceitar certificados SSL não confiáveis. Persiste.
`--browser [name]`	Navegador a ser usado. Requer o WebDriver correspondente. Valores válidos: `firefox` (padrão), `chrome`, `safari`, `edge`, `ie`. Persiste.
`-c, --custom <path>`	Caminho para um arquivo de conjunto de regras personalizado, substituindo o padrão.
`--dismiss-alerts`	Dispensar diálogos do navegador `alert()`, `confirm()`, e `prompt()` antes da varredura.
`--enable-tracking <state>`	Ativar (`true`) ou desativar (`false`) o envio de dados de uso para a biblioteca de métricas. Persiste.
`-f, --format [value]`	Formato(s) do relatório: `html`, `junit`, `csv`, ou uma combinação separada por `+`hífen. Padrão: `html`.
`--headless`	Iniciar o navegador no modo sem cabeça. Persiste.
`--no-analyze`	Remover o requisito para uma `analyze` ação na lista de ações de cada página.
`--no-html`	Impedir a geração de relatório em HTML.
`--no-reports`	Impedir a geração de todos os arquivos de relatório.
`--no-wait`	Desativar pausas automáticas entre as ações do fluxo de trabalho.
`--page-timeout <ms>`	Milissegundos máximos para esperar o carregamento de uma página. Padrão: `60000`. Persiste.
`--post-analyze-pause <ms>`	Milissegundos para pausar após a análise antes da próxima ação. Padrão: `2000`. Persiste.
`--post-get-pause <ms>`	Milissegundos para pausar após o carregamento da página e antes da varredura. Padrão: `2000`. Persiste.
`--post-script-pause <ms>`	Milissegundos para pausar após uma ação de script e antes da varredura. Padrão: `2000`. Persiste.
`--remote-proxy [proxy-server]`	Roteia o tráfego através de um proxy remoto (apenas ChromeDriver). Persiste.
`--remote-server [server-url]`	Conectar a um servidor WebDriver remoto (por exemplo, Selenium Grid, BrowserStack). Persiste.
`--script-timeout <ms>`	Milissegundos máximos para esperar um script de fluxo de trabalho. Padrão: `60000`. Persiste.
`--set-distinct-id <id>`	Substitua o ID distinto usado para o rastreamento de uso. Persiste.
`--set-tracking-url <url>`	Substitua a URL para onde os dados de métricas são enviados. Persiste.
`-t, --tags [list]`	Tags separadas por vírgula para filtrar quais regras são executadas.
`--user-agent <agent>`	Defina uma string de agente de usuário personalizada. Persiste.
`--validate`	Valide os arquivos de especificação sem executá-los.
`--wait-network-idle-new-connections [number]`	Limite de novas conexões antes de considerar a rede ociosa.
`--wait-network-idle-open-connections [number]`	Limite de conexões abertas antes de considerar a rede ociosa.
`--wait-network-idle-timeout [ms]`	Tempo máximo em milissegundos para aguardar a rede ociosa antes de prosseguir.
`--window-size <width,height>`	Defina o tamanho da janela do navegador em pixels. Persiste.

`axe config-selenium`

Configura interativamente padrões persistentes de navegador e tempo. Veja Configuração para a documentação completa.

axe config-selenium [options]

Opção	Descrição
`-s, --show`	Exibe as configurações salvas atuais sem entrar no prompt interativo.

`axe devhub`

Envia os resultados JSON para o Axe Developer Hub. Veja Enviar para Axe Developer Hub para a documentação completa.

axe devhub <results-directory|file> [options]

Opção	Descrição
`--axe-devhub-api-key <api-key>`	Chave de API para o Axe Developer Hub. Substitui a variável de ambiente `AXE_DEVHUB_API_KEY` .
`--axe-devhub-project-id <project-id>`	ID do projeto para o Axe Developer Hub.
`--axe-devhub-server-url <url>`	URL do servidor do Axe Developer Hub. Padrão: `https://axe.deque.com`.
`--no-git-data`	Não envie os dados de branch e commit do Git para o Axe Developer Hub.

`axe licenses`

Exibe e salva as licenças de código aberto para todas as dependências do CLI.

axe licenses [options]

`axe reporter`

Converte resultados JSON em relatórios HTML, JUnit XML ou CSV. Veja Gerar Relatórios para a documentação completa.

axe reporter <results-dir> [dest-dir] [options]

Opção	Descrição
`-b, --browser [name]`	Quando o diretório de resultados contém resultados de vários navegadores, gere o relatório apenas a partir dos resultados de um navegador.
`-d, --dest [path]`	Diretório de saída para relatórios gerados. Também pode ser especificado como o segundo argumento posicional.
`--filter <list>`	Tipos de resultados separados por vírgula para incluir: `passes`, `violations`, `incomplete`, `inapplicable`. Requer `--format csv`.
`-f, --format [type(s)]`	Formato(s) de saída: `html`, `junit`, `csv`, ou uma combinação. Padrão: `html`.

`axe ruleset`

Gera arquivos de conjunto de regras personalizadas. Veja Conjuntos de Regras Personalizados para a documentação completa.

axe ruleset [options]

Opção	Descrição
`--508 [filename]`	Gerar uma configuração padrão para as regras da Seção 508.
`--all [filename]`	Gerar uma configuração padrão para todas as diretrizes suportadas.
`-a, --axe-source <path>`	Caminho para uma fonte personalizada do axe.
`-c, --custom [dir]`	Gerar um conjunto de regras personalizado a partir de um diretório contendo um `changes.json` arquivo.
`-d, --destination [dir]`	Diretório de saída. Padrão: diretório de trabalho atual.
`-x, --disable-other-rules`	Desativar todas as regras não incluídas na `rules` propriedade. Padrão: `true`.
`--en301549 [filename]`	Gerar uma configuração padrão para as regras da EN 301 549.
`-f, --format [format]`	Formato de saída.
`-l, --log`	Também gerar uma lista de todas as regras incluídas no conjunto de regras gerado.
`--only-changes`	Gerar apenas as alterações e adições ao conjunto de regras.
`--rgaav4 [filename]`	Gerar uma configuração padrão para as regras da RGAA v4.
`-t, --tags [list]`	Tags separadas por vírgulas para filtrar o conjunto de regras padrão.
`--ttv5 [filename]`	Gerar uma configuração padrão para as regras da Trusted Tester v5.
`--wcag2 [filename]`	Gerar uma configuração padrão para as regras da WCAG 2.0 AA.
`--wcag21 [filename]`	Gerar uma configuração padrão para as regras da WCAG 2.1 AA.
`--wcag21aaa [filename]`	Gerar uma configuração padrão para as regras da WCAG 2.1 AAA.
`--wcag22 [filename]`	Gerar uma configuração padrão para as regras da WCAG 2.2 AA.
`--wcag22aaa [filename]`	Gerar uma configuração padrão para as regras da WCAG 2.2 AAA.
`--wcag2aaa [filename]`	Gerar uma configuração padrão para as regras da WCAG 2.0 AAA.

`axe spec`

Analisa páginas definidas em um arquivo de especificações JSON ou YAML. Consulte Especificações de Fluxo de Trabalho para documentação completa.

axe spec <spec-file> [output-directory] [options]

Opção	Descrição
`-a, --axe-source <path>`	Caminho para um `axe.js` arquivo alternativo.
`--accept-untrusted`	Aceitar certificados SSL não confiáveis. Persiste.
`--axe-devhub-api-key <api-key>`	Chave de API para o Axe Developer Hub.
`--axe-devhub-project-id <project-id>`	ID do projeto para o Axe Developer Hub.
`--axe-devhub-server-url <url>`	URL do servidor Axe Developer Hub. Padrão: `https://axe.deque.com`.
`--axe-reports-api-key <api-key>`	Chave de API para Relatórios Axe.
`--axe-reports-dimensions <dimensions>`	Dimensões JTBD separadas por vírgulas para marcar esta análise nos Relatórios Axe.
`--axe-reports-url <url>`	URL para enviar resultados aos Relatórios Axe.
`--browser [name]`	Navegador a ser usado. Requer o WebDriver correspondente. Valores válidos: `firefox` (padrão), `chrome`, `safari`, `edge`, `ie`. Persiste.
`--chrome-options [options]`	Comandos de linha separados por vírgulas passados para o ChromeDriver. Persiste.
`-c, --custom <path>`	Caminho para um arquivo de conjunto de regras personalizado, substituindo o padrão.
`--descendant-links`	Coletar links em cada página e anexá-los aos resultados. Requer `--verbose`.
`--dismiss-alerts`	Fechar navegador `alert()`, `confirm()`, e `prompt()` diálogos antes da varredura.
`--download-path <path>`	Definir onde o navegador salva os downloads (somente Chrome).
`--enable-tracking <state>`	Ativar (`true`) ou desativar (`false`) o envio de dados de uso para a biblioteca de métricas. Persistente.
`-f, --format [value]`	Formato(s) de relatório: `html`, `junit`, `csv`, ou uma combinação separada por `+`hífen. Padrão: `html`.
`--filter <list>`	Tipos de resultado separados por vírgula a incluir: `passes`, `violations`, `incomplete`, `inapplicable`. Requer `--format csv`.
`--headless`	Iniciar o navegador em modo headless. Persistente.
`--interactive-mode`	Permitir que a CLI execute em páginas que usam modo interativo (somente Chrome).
`--no-analyze`	Remover a exigência de uma `analyze` ação na lista de ações de cada página.
`--no-exit`	Forçar código de saída `0` mesmo quando violações são encontradas.
`--no-git-data`	Não enviar dados de branch e commit do Git para o Axe Developer Hub.
`--no-html`	Impedir a geração de relatórios HTML.
`--no-reports`	Impedir a geração de todos os arquivos de relatório.
`--no-wait`	Desativar pausas automáticas entre ações do fluxo de trabalho.
`--page-name <name>`	Executar apenas a página com o nome especificado no arquivo de especificação.
`--page-source`	Anexar o código-fonte HTML analisado aos resultados. Requer `--verbose`.
`--page-timeout <ms>`	Máximo de milissegundos para esperar o carregamento de uma página. Padrão: `60000`. Persistente.
`--page-title`	Anexar o título da página aos resultados. Requer `--verbose`.
`--post-analyze-pause <ms>`	Milissegundos para pausar após a análise antes da próxima ação. Padrão: `2000`. Persistente.
`--post-get-pause <ms>`	Milissegundos para pausar após o carregamento da página e antes da varredura. Padrão: `2000`. Persistente.
`--post-script-pause <ms>`	Milissegundos para pausar após uma ação de script e antes da varredura. Padrão: `2000`. Persistente.
`--remote-proxy [proxy-server]`	Passar o tráfego por um proxy remoto (somente ChromeDriver). Persistente.
`--remote-server [server-url]`	Conectar-se a um servidor WebDriver remoto (por exemplo, Selenium Grid, BrowserStack). Persistente.
`--resume-from <name>`	Pular todas as páginas antes da página nomeada no arquivo de especificação.
`--scanned-url`	Adicionar a URL base e a URL de varredura aos resultados detalhados. Somente Chrome. Requer `--verbose`.
`--script-timeout <ms>`	Máximo de milissegundos para esperar um script do fluxo de trabalho. Padrão: `60000`. Persistente.
`--send-axe-reports`	Enviar resultados de análise para o Axe Reports.
`--set-distinct-id <id>`	Substituir o ID distinto usado para rastreamento de uso. Persistente.
`--set-legacy-mode`	Ativar o modo de varredura legado. Obsoleto — será removido na versão 5.0.
`--set-tracking-url <url>`	Substitua o URL para onde os dados de métricas são enviados. Persiste.
`--silent-mode`	Suprimir toda saída decorativa; os resultados são mostrados apenas quando `--verbose` também está ativo.
`-t, --tags [list]`	Tags separadas por vírgula para filtrar quais regras são executadas.
`--user-agent <agent>`	Defina uma string de agente de usuário personalizada. Persiste.
`--validate`	Validar o arquivo de especificação sem executá-lo.
`-v, --verbose`	Incluir nome da ferramenta, versão e metadados do ambiente na saída.
`--wait-network-idle-new-connections [number]`	Novo limite de conexões antes de a rede ser considerada ociosa.
`--wait-network-idle-open-connections [number]`	Limite de conexões abertas antes de a rede ser considerada ociosa.
`--wait-network-idle-polling-every [ms]`	Intervalo de sondagem em milissegundos para detecção de rede ociosa.
`--wait-network-idle-timeout [ms]`	Máximo de milissegundos para esperar pela rede ociosa antes de prosseguir.
`--window-size <width,height>`	Defina o tamanho da janela do navegador em pixels. Persiste.