Usando o CLI para Enviar Resultados de Acessibilidade para o Axe Developer Hub

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

Discute as diferentes maneiras de enviar seus resultados de acessibilidade para o Axe Developer Hub usando o CLI

Not for use with personal data

O CLI permite que você envie seus resultados de acessibilidade para o Axe Developer Hub. Você pode:

Carregar resultados de testes anteriores para o Axe Developer Hub. Esta opção usa o subcomando devhub do CLI e permite que você envie resultados da análise de páginas da web usando as APIs da web ou de execuções anteriores do CLI (onde você analisou páginas individuais ou executou arquivos de especificação e salvou os resultados).
Analisar páginas individuais e enviar resultados diretamente para o Axe Developer Hub (sem primeiro salvar arquivos de resultados).
Executar arquivos de especificação e enviar resultados diretamente para o Axe Developer Hub (sem primeiro salvar arquivos de resultados).

Requisitos

Para usar o CLI com o Axe Developer Hub, você precisará:

Uma conta Axe e uma assinatura para o Axe Developer Hub. Veja Comece a Usar o Axe Developer Hub para mais informações.
Um projeto no Axe Developer Hub onde você enviará os resultados. Veja Criar um Novo Projeto no Axe Developer Hub para informações sobre como criar um novo projeto. Quando você cria um projeto, especifica que o projeto usará o CLI como sua fonte de dados. Você precisará destes valores para enviar resultados:
- Sua chave API pessoal (exibida na sua conta Axe em chaves API)
- O ID do seu projeto (exibido nas instruções quando você cria um novo projeto no Axe Developer Hub)
(Opcional) Se você tem testes que usam as APIs web, precisará modificar seus testes para produzir um arquivo ou arquivos de resultados. Um arquivo de resultados é um arquivo .json contendo os resultados de sua execução de teste, e o procedimento para criar arquivos de resultados é diferente dependendo da API que você usa. Para mais detalhes, veja Criando Arquivos de Resultados. Você usa o subcomando devhub para carregar arquivos de resultados.

Enviando Resultados para o Axe Developer Hub

Normalmente, o CLI testa sites e produz resultados somente quando você usa a opção -s para salvar os resultados (que são arquivos .json contendo informações sobre erros de acessibilidade nos sites testados). Você pode enviar seus resultados para o Axe Developer Hub especificando uma chave API na linha de comando com a opção --axe-devhub-api-key (ou configurando a variável de ambiente AXE_DEVHUB_API_KEY) e um ID de projeto com a --axe-devhub-project-id (ou configurando a variável de ambiente AXE_DEVHUB_PROJECT_ID).

Por padrão, o CLI também carrega informações do Git se o diretório onde você está executando o CLI fizer parte de um repositório Git. Veja Modo Git versus Sem Git para informações sobre como o envio de informações do Git funciona.

O CLI associará o ramo atual do Git e o histórico de commits com seus resultados de acessibilidade.

important

Ao executar o CLI a partir de um diretório dentro de um repositório Git, os resultados que você enviar para o Axe Developer Hub substituirão quaisquer resultados anteriores do mesmo commit (determinado pelo seu SHA). (Somente um conjunto de resultados pode ser associado a cada commit.) Você precisará criar um novo commit toda vez que executar o CLI ou optar por não relatar resultados do Git usando a opção --no-git-data. Veja Modo Git versus Sem Git para mais informações.

Carregar Resultados

Se você já executou testes anteriormente e possui arquivos de resultados (arquivos .json geralmente com nomes como axe-result-2025-09-03T14 02 32-0700.json), você pode enviar esses resultados para o Axe Developer Hub com o subcomando devhub. Você pode salvar resultados usando a opção de linha de comando -s ao testar páginas ou executar arquivos de especificação:

axe https://example.com -s

tip

Ao analisar uma página ou executar um arquivo de especificação, você não precisa salvar os resultados primeiro e depois carregá-los. Ao especificar uma chave de API e um ID de projeto, o CLI carregará os resultados quando a análise da página estiver concluída ou quando seu arquivo de especificação terminar de executar. Veja Analisar Páginas Individuais e Executar Arquivos de Especificação.

O exemplo anterior cria um arquivo de resultados que você pode então enviar para o Axe Developer Hub, conforme mostrado abaixo:

axe devhub <results-dir(s)-or-file(s)> --axe-devhub-api-key <your-API-key> --axe-devhub-project-id <your-project-ID>

Você pode usar . (ponto) como o diretórios-de-resultados-ou-arquivos para carregar todos os arquivos de resultados .json no diretório atual. Você também pode especificar múltiplos diretórios ou arquivos para carregar.

Criando Arquivos de Resultados com as APIs Web

Se você estiver usando as APIs web, precisará modificar seus testes de API para escrever arquivos de resultados que você possa então enviar para o Axe Developer Hub usando o subcomando devhub. A tabela a seguir contém links para informações sobre como criar arquivos de resultados, e essas APIs usam os APIs de relatório ou registro fornecidos para gravar resultados como arquivos .json no disco.

API	Nome do Link
Node.js	Axe DevTools Logger
C#	Criando JSON Compatível com Relatórios
Java	Gerar Relatórios com Java
Python	Criando JSON Compatível com Relatórios
Ruby	Opções de Relatório

Analisar Páginas Individuais

Você pode escanear páginas da web individuais e enviar os resultados para o Axe Developer Hub especificando uma chave API e o ID do projeto para o qual enviar os resultados:

axe https://google.com --axe-devhub-api-key <your-API-key> --axe-devhub-project-id <your-project-ID>

Neste exemplo, o CLI executa testes de acessibilidade no site do Google e, em seguida, envia os resultados para o projeto do Axe Developer Hub referenciado pelo ID de projeto especificado.

Você também pode listar várias páginas na linha de comando para testar:

axe https://example.com/page1.html https://example.com/page2.html --axe-devhub-api-key <your-API-key> --axe-devhub-project-id <your-project-ID>

Visite o projeto no Axe Developer Hub para ver seus resultados. Veja Visão Geral dos Problemas de Acessibilidade.

Executar Arquivos de Especificação

Você pode enviar os resultados da execução dos seus arquivos de especificação usando as opções de linha de comando --axe-devhub-api-key e --axe-devhub-project-id.

axe spec my-spec-file.yml --axe-devhub-api-key <your-API-key> --axe-devhub-project-id <your-project-ID>

Este exemplo executa o arquivo de especificação YAML my-spec-file.yml e envia seus resultados de acessibilidade para o Axe Developer Hub. Veja Especificações de Fluxo de Trabalho e Ações de Fluxo de Trabalho para mais informações sobre arquivos de especificação.

tip

Se você precisar avançar no seu arquivo de especificação, pulando o teste de páginas, pode usar a opção de linha de comando --resume-from <page> para retomar o teste a partir de uma página específica no seu arquivo de especificação. Veja Retomar de para mais informações.

Modo Git versus Sem Git

Por padrão, o Axe Developer Hub associa seus resultados de acessibilidade ao commit Git mais recente no ramo atual quando você executa o CLI a partir de um diretório dentro de um repositório Git, permitindo que você vincule facilmente erros de acessibilidade a commits Git. Um efeito colateral desse comportamento, no entanto, é que sempre que você relatar resultados para o Axe Developer Hub, novos resultados substituirão qualquer outra execução no mesmo commit (com base no seu SHA). Além disso, se você mudar para um ramo diferente, quaisquer resultados que enviar para o Axe Developer Hub estarão associados ao commit mais recente nesse ramo.

Se o comportamento padrão do Axe Developer Hub não for o que você prefere:

Você pode usar o CLI em um diretório fora de um repositório Git.
Você pode usar a opção de linha de comando --no-git-data para evitar o reporte de informações do Git para o servidor, operando no que é chamado de modo Sem Git, onde cada vez que você reporta resultados para o servidor, uma nova execução de teste é criada e identificada pela data e hora da execução ao invés do branch e commit, como quando no modo Git.

Veja Páginas do Seu Projeto e Página de Execuções de Teste para informações sobre como resultados Git e Gitless são organizados e apresentados no Axe Developer Hub.

Opções de Linha de Comando

O CLI aceita estas opções de linha de comando:

--axe-devhub-api-key Permite que você defina a sua chave de API pessoal, equivalente à variável de ambiente AXE_DEVHUB_API_KEY. Obrigatório
--axe-devhub-project-id Define o ID do projeto para o seu projeto no Axe Developer Hub, equivalente à variável de ambiente AXE_DEVHUB_PROJECT_ID. Obrigatório
--axe-devhub-server-url Permite que você use um servidor diferente do padrão (https://axe.deque.com), equivalente à variável de ambiente AXE_DEVHUB_SERVER_URL. Defina isso se sua organização usar uma instância regional, nuvem privada ou implantação local do Axe Developer Hub. Opcional
--no-git-data Evita reportar informações do Git para o servidor. Veja Modo Git versus Sem Git para mais informações. Não possui uma variável de ambiente equivalente. Opcional

Variáveis de Ambiente

Você pode definir variáveis de ambiente para evitar especificar a chave de API, ID do projeto ou URL do servidor na linha de comando, o que é recomendado ao usar a chave de API em integração contínua para mantê-la em segredo.

tip

Definir AXE_DEVHUB_API_KEY e AXE_DEVHUB_PROJECT_ID irá sempre enviar resultados para o Axe Developer Hub sempre que você analisar uma página ou executar um arquivo de especificação. Por exemplo, se você já definiu essas variáveis de ambiente e analisar uma página com:

axe https://somewebsite.com

Os resultados serão enviados para o Axe Developer Hub. Esse comportamento se aplica quando você usa o CLI para analisar uma página ou executar um arquivo de especificação.

AXE_DEVHUB_API_KEY Especifica sua chave de API pessoal, equivalente à opção de linha de comando --axe-devhub-api-key.
AXE_DEVHUB_PROJECT_ID Especifica o ID do projeto para seu projeto no Axe Developer Hub, equivalente à opção de linha de comando --axe-devhub-project-id.
AXE_DEVHUB_SERVER_URL Especifica o URL do servidor do Axe Developer Hub (o padrão é https://axe.deque.com), equivalente à opção de linha de comando --axe-devhub-server-url. Defina isso se sua organização usar uma instância regional, nuvem privada ou implantação local do Axe Developer Hub.