Utilizzare la CLI per inviare i risultati di accessibilità a 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

Discussa i diversi modi per caricare i tuoi risultati di accessibilità su axe Developer Hub utilizzando la CLI

Not for use with personal data

La CLI ti consente di inviare i tuoi risultati di accessibilità a axe Developer Hub. Puoi:

Caricare risultati dai test precedenti a axe Developer Hub. Questa opzione utilizza il sottocomando della CLI devhub e ti permette di caricare risultati dall'analisi di pagine web utilizzando le web API o dai precedenti esecuzione della CLI (dove hai analizzato singole pagine o eseguito file spec e salvato i risultati).
Analizzare singole pagine e inviare i risultati direttamente a axe Developer Hub (senza salvare prima i file dei risultati).
Eseguire file spec e inviare i risultati direttamente a axe Developer Hub (senza salvare prima i file dei risultati).

Requisiti

Per utilizzare la CLI con axe Developer Hub, avrai bisogno di:

Un account axe ed un abbonamento a axe Developer Hub. Consulta Inizia con axe Developer Hub per ulteriori informazioni.
Un progetto axe Developer Hub dove caricare i risultati. Consulta Crea un nuovo progetto axe Developer Hub per informazioni su come creare un nuovo progetto. Quando crei un progetto, specifichi che il progetto utilizzerà la CLI come input o fonte di dati. Avrai bisogno di questi valori per caricare i risultati:
- La tua chiave API personale (visualizzata nel tuo account axe sotto chiavi API)
- Il tuo ID progetto (visualizzato nelle istruzioni quando crei un nuovo progetto axe Developer Hub)
(Opzionale) Se hai test che utilizzano le API web, dovrai modificare i tuoi test per produrre uno o più file di risultati. Un file di risultati è un file .json che contiene i risultati dell'esecuzione del tuo test, e la procedura per la creazione di file di risultati è diversa a seconda dell'API che utilizzi. Per ulteriori dettagli, consulta Creazione di file di risultati. Utilizzi il sottocomando devhub per caricare i file dei risultati.

Invio dei risultati a axe Developer Hub

Normalmente, la CLI testa i siti web e produce risultati solo quando utilizzi l'opzione -s per salvare i risultati (che sono file .json contenenti informazioni sugli errori di accessibilità nei siti testati). Puoi inviare i tuoi risultati a axe Developer Hub specificando una chiave API sulla riga di comando con l'opzione --axe-devhub-api-key (o impostando la variabile d'ambiente AXE_DEVHUB_API_KEY) e un ID progetto con l'opzione --axe-devhub-project-id (o impostando la variabile d'ambiente AXE_DEVHUB_PROJECT_ID).

Per impostazione predefinita, la CLI carica anche informazioni Git se la directory in cui esegui la CLI è parte di un repository Git. Consulta Modalità Git versus Gitless per informazioni su come funziona il caricamento delle informazioni Git.

La CLI associerà il ramo Git corrente e la cronologia dei commit ai tuoi risultati di accessibilità.

important

Quando esegui la CLI all'interno di una directory in un repository Git, i risultati che invii a axe Developer Hub sovrascriveranno tutti i risultati precedenti dello stesso commit (determinato dal suo SHA). (Solo un set di risultati può essere associato a ciascun commit.) È necessario creare un nuovo commit ogni volta che esegui la CLI o evitare di segnalare i risultati Git utilizzando l'opzione --no-git-data. Consulta Modalità Git versus Gitless per ulteriori informazioni.

Carica Risultati

Se hai eseguito test in precedenza e hai file dei risultati (file .json tipicamente con nomi come axe-result-2025-09-03T14 02 32-0700.json), puoi caricare questi risultati su axe Developer Hub con il sottocomando devhub. Puoi salvare i risultati utilizzando l'opzione della riga di comando -s quando testi pagine o esegui file spec:

axe https://example.com -s

tip

Quando analizzi una pagina o esegui un file spec, non è necessario salvare prima i risultati e poi caricarli. Specificando una chiave API e un ID progetto, la CLI caricherà i risultati quando l'analisi della tua pagina sarà completata o quando il tuo file spec avrà terminato l'esecuzione. Consulta Analizza Singole Pagine e Esegui File Spec.

L'esempio precedente crea un file di risultati che puoi poi caricare su axe Developer Hub, come mostrato di seguito:

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

Puoi usare . (punto) come dir-risultati-o-file-det-risultati per caricare tutti i file di risultati .json nella directory corrente. Puoi anche specificare più directory o file da caricare.

Creazione di file di risultati con le API Web

Se stai utilizzando le web API, dovrai modificare i tuoi test API per scrivere file dei risultati che puoi poi caricare su axe Developer Hub utilizzando il sottocomando devhub. La seguente tabella contiene link a informazioni su come creare file di risultati, e queste API utilizzano le API di reporting o logging fornite per scrivere i risultati come file .json su disco.

API	Nome del Link
Node.js	axe DevTools Logger
C#	Creazione di JSON compatibile con reporter
Java	Generare Report con Java
Python	Creazione di JSON compatibile con reporter
Ruby	Opzioni di report

Analizza Singole Pagine

Puoi scansionare singole pagine web e inviare i risultati a axe Developer Hub specificando una chiave API e l'ID del progetto che deve ricevere i risultati:

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

In questo esempio, il CLI esegue test di accessibilità sul sito di Google e poi invia i risultati al progetto axe Developer Hub indicato dall'ID di progetto specificato.

Puoi anche elencare più pagine sulla riga di comando da testare:

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>

Visita il progetto su axe Developer Hub per vedere i tuoi risultati. Vedi Panoramica della visualizzazione delle problematiche di accessibilità.

Esecuzione dei file spec

Puoi inviare i risultati dall'esecuzione dei tuoi file spec utilizzando le opzioni da riga di 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>

Questo esempio esegue il file spec YAML my-spec-file.yml e carica i suoi risultati di accessibilità su axe Developer Hub. Vedi Specifiche del flusso di lavoro e Azioni del flusso di lavoro per ulteriori informazioni sui file spec.

tip

Se hai bisogno di avanzare nel tuo file spec saltando il test delle pagine, puoi utilizzare l'opzione da riga di comando --resume-from <page> per riprendere il test da una pagina specifica nel tuo file spec. Vedi Riprendi da per ulteriori informazioni.

Modalità Git versus Gitless

Per impostazione predefinita, axe Developer Hub associa i tuoi risultati di accessibilità all'ultimo commit Git sul ramo corrente quando esegui il CLI da una directory all'interno di un repository Git, consentendoti di collegare facilmente gli errori di accessibilità ai commit di Git. Un effetto collaterale di questo comportamento è che ogni volta che riporti i risultati a axe Developer Hub, i nuovi risultati sovrascrivono qualsiasi altra esecuzione sullo stesso commit (basato sul suo SHA). Inoltre, se passi a un altro ramo, qualsiasi risultato inviato a axe Developer Hub sarà associato all'ultimo commit su quel ramo.

Se il comportamento predefinito di axe Developer Hub non è quello che preferisci:

Puoi utilizzare il CLI in una directory al di fuori di un repository Git.
Puoi utilizzare l'opzione da riga di comando --no-git-data per evitare di riportare le informazioni di Git al server, operando in quella che viene chiamata modalità Gitless dove ogni volta che riporti i risultati al server, viene creato un nuovo run di test identificato dall'ora e dalla data dell'esecuzione piuttosto che dal ramo e dal commit come quando si esegue in modalità Git.

Vedi Le pagine del tuo progetto e La pagina delle esecuzioni di test per informazioni su come i risultati Git e Gitless sono organizzati e presentati in axe Developer Hub.

Opzioni da riga di comando

Il CLI accetta queste opzioni da riga di comando:

--axe-devhub-api-key Ti consente di impostare la tua chiave API personale, equivalente alla variabile d'ambiente AXE_DEVHUB_API_KEY. Obbligatorio
--axe-devhub-project-id Imposta l'ID del progetto per il tuo progetto axe Developer Hub, equivalente alla variabile d'ambiente AXE_DEVHUB_PROJECT_ID. Obbligatorio
--axe-devhub-server-url Ti permette di utilizzare un server diverso da quello predefinito (https://axe.deque.com), equivalente alla variabile d'ambiente AXE_DEVHUB_SERVER_URL. Imposta questo se la tua organizzazione utilizza un'istanza regionale, cloud privato o distribuzione on-premises di Axe Developer Hub. Opzionale
--no-git-data Evita di riportare le informazioni di Git al server. Vedi Modalità Git versus Gitless per ulteriori informazioni. Non ha un'equivalente variabile d'ambiente. Opzionale

Variabili d'ambiente

Puoi impostare variabili d'ambiente per evitare di specificare la chiave API, l'ID del progetto o l'URL del server sulla riga di comando, cosa consigliata quando si utilizza la chiave API in integrazione continua per mantenerla segreta.

tip

Impostando AXE_DEVHUB_API_KEY e AXE_DEVHUB_PROJECT_ID, sempre invierai risultati a axe Developer Hub ogni volta che analizzi una pagina o esegui un file spec. Ad esempio, se hai impostato queste variabili d'ambiente e analizzi una pagina con:

axe https://somewebsite.com

I risultati verranno inviati a axe Developer Hub. Questo comportamento si applica quando utilizzi il CLI per analizzare una pagina o eseguire un file spec.

AXE_DEVHUB_API_KEY Specifica la tua chiave API personale, equivalente all'opzione da riga di comando --axe-devhub-api-key.
AXE_DEVHUB_PROJECT_ID Specifica l'ID del progetto per il tuo progetto axe Developer Hub, equivalente all'opzione da riga di comando --axe-devhub-project-id.
AXE_DEVHUB_SERVER_URL Specifica l'URL del server di Axe Developer Hub (il predefinito è https://axe.deque.com), equivalente all'opzione da riga di comando --axe-devhub-server-url. Imposta questo se la tua organizzazione utilizza un'istanza regionale, cloud privato o distribuzione on-premises di Axe Developer Hub.