Começar com o Axe DevTools 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

Guia rápido cobrindo as tarefas mais comuns do Axe DevTools CLI

Not for use with personal data

Antes de começar, instale o Axe DevTools CLI.

O Axe DevTools CLI funciona através do comando axe . Este guia cobre as três tarefas mais comuns.

Analisar uma Página da Web

Passe um ou mais URLs diretamente para o comando axe . Por padrão, o CLI usa o Firefox e executa o conjunto de regras WCAG 2.1 AA , imprimindo os resultados no stdout:

axe https://example.com/

Analise múltiplas páginas de uma vez:

axe https://example.com/ https://example.com/about.html

Salve os resultados como um arquivo JSON para uso posterior:

axe https://example.com/ --save=./axe-results.json

Gere um relatório HTML diretamente:

axe https://example.com/ --report=./axe-reports/

Para todas as opções, veja Analisar Páginas.

Analisar Páginas Usando um Arquivo de Especificação

Para cenários mais complexos como navegação através de um aplicativo de página única, logins, fechamento de diálogos, ou análise de uma página em múltiplos pontos de um fluxo de trabalho, use o comando axe spec com um arquivo de especificação.

Um arquivo de especificação (JSON ou YAML) define uma lista de páginas a serem analisadas e as ações a serem realizadas em cada página antes da análise. Um exemplo mínimo (axe-workflow.yaml):

projects:
  - name: example
    id: example
    pageList:
      - name: Homepage
        url: https://example.com/
      - name: Search Results
        url: https://example.com/
        actions:
          - type "axe" into element "#searchform input"
          - click element "#searchform button[type=submit]"
          - wait for element ".search-results" to be found
          - analyze

Execute-o com axe spec, especificando o arquivo de especificação e um diretório de saída para os resultados:

axe spec ./axe-workflow.yaml ./axe-results

Para uma referência completa da estrutura do arquivo de especificação, ações e opções, veja Analisar Páginas Usando um Arquivo de Especificação.

Gerar um Relatório a Partir dos Resultados Salvos

Use o comando axe reporter para converter os resultados JSON salvos em HTML, JUnit XML ou CSV:

axe reporter ./axe-results --format=html

Gere um relatório JUnit XML (útil em pipelines CI):

axe reporter ./axe-results --format=junit

Gere um relatório CSV:

axe reporter ./axe-results --format=csv

Para filtragem e outras opções, veja Gerar Relatórios.

Próximos Passos