Riferimento CLI
Sintassi dei comandi e riferimento completo delle opzioni per tutti i sottocomandi di Axe DevTools CLI
Un riferimento rapido per ogni sottocomando di Axe DevTools CLI e le sue opzioni. Per indicazioni sull'uso e esempi, seguire il link all'articolo di ciascun comando.
axe <url>— analizzare pagine tramite URLaxe bulk-reports— inviare i risultati a Axe Reportsaxe bulk-spec— eseguire una directory di file specaxe config-selenium— configurare impostazioni predefinite del browser persistentiaxe devhub— inviare i risultati a Axe Developer Hubaxe licenses— mostrare le licenze delle dipendenzeaxe reporter— generare report dai risultati JSONaxe ruleset— generare set di regole personalizzateaxe spec— eseguire un file spec
axe <url>
Analizza una o più pagine web per individuare problemi di accessibilità. Vedi Testing Pages per la documentazione completa.
axe <url...> [options]Alcune opzioni vengono salvate in un file delle preferenze e persistono tra le esecuzioni della CLI. Vedi Configurazione per i dettagli.
| Opzione | Descrizione |
|---|---|
-a, --axe-source <path> |
Percorso per un axe.js file alternativo. |
--accept-untrusted |
Accetta certificati SSL non affidabili. Persiste. |
--axe-devhub-api-key <api-key> |
Chiave API per Axe Developer Hub. |
--axe-devhub-project-id <project-id> |
ID progetto per Axe Developer Hub. |
--axe-devhub-server-url <url> |
URL del server Axe Developer Hub. Default: https://axe.deque.com. |
--axe-reports-api-key <api-key> |
Chiave API per Axe Reports. |
--axe-reports-dimensions <dimensions> |
Dimensioni JTBD separate da virgole per etichettare questa scansione in Axe Reports. |
--axe-reports-url <url> |
URL a cui inviare i risultati a Axe Reports. |
--browser [name] |
Browser da usare. Richiede il WebDriver corrispondente. Valori validi: firefox (default), chrome, safari, edge, ie. Persistente. |
--chrome-options [options] |
Opzioni della riga di comando di Chrome separate da virgole passate a ChromeDriver. Persiste. |
--chrome-path <path> |
Percorso assoluto al file eseguibile del browser Chrome. |
--chromedriver-path <path> |
Percorso assoluto al file eseguibile di ChromeDriver. |
-c, --custom <path> |
Percorso per un file di set di regole personalizzato, che sostituisce il predefinito. |
-d, --dir <path> |
Directory in cui vengono salvati i risultati JSON. |
-l, --disable <list> |
ID regole da disabilitare, separati da virgole. |
-e, --exclude <list> |
Selettori CSS separati da virgole per elementi da escludere dal test. |
-q, --exit |
Esci con codice 1 se vengono trovate violazioni. |
--enable-tracking <state> |
Abilita (true) o disabilita (false) l'invio dei dati di utilizzo alla libreria di metriche. Persistente. |
-f, --format <value> |
Formato del/i rapporto/i: html, junit, csv, universalo una combinazione separata da +-. Predefinito: html. Richiede -r, --report. |
--filter <list> |
Tipi di risultati inclusi separati da virgole: passes, violations, incomplete, inapplicable. Richiede --format csv. |
--universal-best-practices |
Registra bestPracticesEnabled=true nei metadati quando si utilizza --format universal. |
--universal-ruleset <id> |
ID del set di regole da registrare nei metadati quando si utilizza --format universal. Valori validi: wcag2, wcag2.1, wcag2.2, wcag2aaa, wcag2.1aaa, wcag2.2aaa, 508, en301549, ttv5, rgaav4. Predefinito: wcag2.1. |
--headless |
Lancia il browser in modalità headless. Persistente. |
-i, --include <list> |
Millisecondi da attendere dopo il caricamento della pagina prima di eseguire l'audit. Predefinito: |
--load-delay <n> |
. 0. |
--no-git-data |
Non inviare i dati del ramo Git e del commit a Axe Developer Hub. |
--no-reporter |
Massimo tempo in millisecondi di attesa per il caricamento di una pagina. Predefinito: |
--page-timeout <ms> |
Tempo massimo in millisecondi per aspettare il caricamento di una pagina. Predefinito: 60000. Persistente. |
--post-analyze-pause <ms> |
Millisecondi di pausa dopo l'analisi prima dell'azione successiva. Predefinito: 2000. Persistente. |
--post-get-pause <ms> |
Millisecondi di pausa dopo il caricamento della pagina e prima della scansione. Predefinito: 2000. Persistente. |
--post-script-pause <ms> |
Millisecondi di pausa dopo un'azione di script e prima della scansione. Predefinito: 2000. Persistente. |
-r, --report <output-dir> |
. -f, --format. |
--remote-proxy [proxy-server] |
Instrada il traffico attraverso un proxy remoto (solo ChromeDriver). Persistente. |
--remote-server [server-url] |
Collegati a un server WebDriver remoto (ad es. Selenium Grid, BrowserStack). Persistente. |
--rules <list> |
Salva i risultati come file JSON. Il nome di file predefinito è |
-s, --save [filename] |
. axe-result.json. |
--script-timeout <ms> |
Tempo massimo in millisecondi per aspettare uno script del workflow. Predefinito: 60000. Persistente. |
--send-axe-reports |
Invia i risultati dell'analisi a Axe Reports. |
--set-distinct-id <id> |
Sovrascrivi l'ID distinto utilizzato per il tracciamento dell'uso. Persistente. |
--set-tracking-url <url> |
Sostituisci l'URL a cui vengono inviati i dati delle metriche. Persistente. |
--show-errors |
Output dei risultati JSON su stdout; silenzia tutto l'altro output. |
-j, --stdout |
Tag separati da virgole per filtrare quali regole eseguire. |
-t, --tags <list> |
Tag separati da virgola per filtrare quali regole vengono eseguite. |
--timer |
Includi il nome dello strumento, la versione e i metadati dell'ambiente nell'output. |
-v, --verbose |
Includi nello output il nome dello strumento, la versione e i metadati dell'ambiente. |
-V, --version |
Imposta la dimensione della finestra del browser in pixel. Persiste. |
--window-size <width,height> |
Imposta la dimensione della finestra del browser in pixel. Persistente. |
axe bulk-reports
Invia a Axe Reports per la documentazione completa. per la documentazione completa.
axe bulk-reports <results-directory> [options]| Opzione | Descrizione |
|---|---|
--axe-reports-api-key <api-key> |
Chiave API per Axe Reports. |
--axe-reports-dimensions <dimensions> |
Dimensioni JTBD separate da virgole per etichettare questa scansione in Axe Reports. |
--axe-reports-url <url> |
URL a cui inviare i risultati a Axe Reports. |
--send-axe-reports |
Invia i risultati dell'analisi a Axe Reports. |
--verbose |
Abilita la registrazione dettagliata. |
axe bulk-spec
Elabora una directory di file di specifiche in un'unica esecuzione. Vedi Spec di workflow per la documentazione completa.
axe bulk-spec <spec-files-directory> [output-directory] [options]| Opzione | Descrizione |
|---|---|
-a, --axe-source <path> |
Percorso per un axe.js file alternativo. |
--accept-untrusted |
Accetta certificati SSL non affidabili. Persiste. |
--browser [name] |
Browser da usare. Richiede il WebDriver corrispondente. Valori validi: firefox (default), chrome, safari, edge, ie. Persistente. |
-c, --custom <path> |
Percorso per un file di set di regole personalizzato, che sostituisce il predefinito. |
--dismiss-alerts |
Chiudere il browser alert(), confirm(), e prompt() finestre di dialogo prima della scansione. |
--enable-tracking <state> |
Abilita (true) o disabilita (false) l'invio dei dati di utilizzo alla libreria di metriche. Persistente. |
-f, --format [value] |
Formato del/i rapporto/i: html, junit, csvo una combinazione separata da +-. Predefinito: html. |
--headless |
Lancia il browser in modalità headless. Persistente. |
--no-analyze |
Rimuovi il requisito di un analyze nel elenco delle azioni di ogni pagina. |
--no-html |
Impedisci la generazione del rapporto HTML. |
--no-reports |
Impedisci la generazione di tutti i file di rapporto. |
--no-wait |
Disabilita le pause automatiche tra le azioni del workflow. |
--page-timeout <ms> |
Tempo massimo in millisecondi per aspettare il caricamento di una pagina. Predefinito: 60000. Persistente. |
--post-analyze-pause <ms> |
Millisecondi di pausa dopo l'analisi prima dell'azione successiva. Predefinito: 2000. Persistente. |
--post-get-pause <ms> |
Millisecondi di pausa dopo il caricamento della pagina e prima della scansione. Predefinito: 2000. Persistente. |
--post-script-pause <ms> |
Millisecondi di pausa dopo un'azione di script e prima della scansione. Predefinito: 2000. Persistente. |
--remote-proxy [proxy-server] |
Instrada il traffico attraverso un proxy remoto (solo ChromeDriver). Persistente. |
--remote-server [server-url] |
Collegati a un server WebDriver remoto (ad es. Selenium Grid, BrowserStack). Persistente. |
--script-timeout <ms> |
Tempo massimo in millisecondi per aspettare uno script del workflow. Predefinito: 60000. Persistente. |
--set-distinct-id <id> |
Sovrascrivi l'ID distinto utilizzato per il tracciamento dell'uso. Persistente. |
--set-tracking-url <url> |
Sostituisci l'URL a cui vengono inviati i dati delle metriche. Persistente. |
-t, --tags [list] |
Tag separati da virgola per filtrare quali regole vengono eseguite. |
--user-agent <agent> |
Imposta una stringa custom dell'utente agente. Persistente. |
--validate |
Convalida i file di specifica senza eseguirli. |
--wait-network-idle-new-connections [number] |
Nuova soglia di connessione prima che la rete sia considerata inattiva. |
--wait-network-idle-open-connections [number] |
Soglia di connessione aperta prima che la rete sia considerata inattiva. |
--wait-network-idle-timeout [ms] |
Millisecondi massimi da attendere per la rete inattiva prima di procedere. |
--window-size <width,height> |
Imposta la dimensione della finestra del browser in pixel. Persistente. |
axe config-selenium
Configura interattivamente le impostazioni predefinite permanenti del browser e del timing. Vedi Configurazione per la documentazione completa.
axe config-selenium [options]| Opzione | Descrizione |
|---|---|
-s, --show |
Visualizza le impostazioni salvate correnti senza entrare nel prompt interattivo. |
axe devhub
Invia i risultati JSON ad Axe Developer Hub. Vedi Invia ad Axe Developer Hub per la documentazione completa.
axe devhub <results-directory|file> [options]| Opzione | Descrizione |
|---|---|
--axe-devhub-api-key <api-key> |
Chiave API per Axe Developer Hub. Sovrascrive la AXE_DEVHUB_API_KEY variabile d'ambiente. |
--axe-devhub-project-id <project-id> |
ID progetto per Axe Developer Hub. |
--axe-devhub-server-url <url> |
URL del server Axe Developer Hub. Default: https://axe.deque.com. |
--no-git-data |
Non inviare i dati del ramo Git e del commit a Axe Developer Hub. |
axe licenses
Visualizza e salva le licenze open-source per tutte le dipendenze CLI.
axe licenses [options]axe reporter
Converte i risultati JSON in report HTML, JUnit XML o CSV. Vedi Genera Report per la documentazione completa.
axe reporter <results-dir> [dest-dir] [options]| Opzione | Descrizione |
|---|---|
-b, --browser [name] |
Quando la directory dei risultati contiene risultati da più browser, genera il report solo dai risultati di un browser. |
-d, --dest [path] |
Directory di output per i report generati. Può essere specificato anche come secondo argomento posizionale. |
--filter <list> |
Tipi di risultati inclusi separati da virgole: passes, violations, incomplete, inapplicable. Richiede --format csv. |
-f, --format [type(s)] |
Formato(i) di output: html, junit, csv, universal, o una combinazione. Predefinito: html. |
--universal-best-practices |
Registra bestPracticesEnabled=true nei metadati quando si utilizza --format universal. |
--universal-ruleset <id> |
ID del set di regole da registrare nei metadati quando si utilizza --format universal. Valori validi: wcag2, wcag2.1, wcag2.2, wcag2aaa, wcag2.1aaa, wcag2.2aaa, 508, en301549, ttv5, rgaav4. Predefinito: wcag2.1. |
axe ruleset
Genera file di set di regole personalizzati. Vedi Set di Regole Personalizzati per la documentazione completa.
axe ruleset [options]| Opzione | Descrizione |
|---|---|
--508 [filename] |
Generare un config standard per le regole della Sezione 508. |
--all [filename] |
Generare un config standard per tutte le linee guida supportate. |
-a, --axe-source <path> |
Percorso per una fonte personalizzata di axe. |
-c, --custom [dir] |
Generare un set di regole personalizzato da una directory contenente un changes.json file alternativo. |
-d, --destination [dir] |
Directory di output. Default: directory di lavoro corrente. |
-x, --disable-other-rules |
Disabilitare tutte le regole non incluse nella rules proprietà. Default: true. |
--en301549 [filename] |
Generare un config standard per le regole EN 301 549. |
-f, --format [format] |
Formato di output. |
-l, --log |
Generare anche un elenco di tutte le regole incluse nel set di regole generato. |
--only-changes |
Generare solo le modifiche e le aggiunte al set di regole. |
--rgaav4 [filename] |
Generare un config standard per le regole RGAA v4. |
-t, --tags [list] |
Tag separati da virgole per filtrare il set di regole standard. |
--ttv5 [filename] |
Generare un config standard per le regole Trusted Tester v5. |
--wcag2 [filename] |
Generare un config standard per le regole WCAG 2.0 AA. |
--wcag21 [filename] |
Generare un config standard per le regole WCAG 2.1 AA. |
--wcag21aaa [filename] |
Generare un config standard per le regole WCAG 2.1 AAA. |
--wcag22 [filename] |
Generare un config standard per le regole WCAG 2.2 AA. |
--wcag22aaa [filename] |
Generare un config standard per le regole WCAG 2.2 AAA. |
--wcag2aaa [filename] |
Generare un config standard per le regole WCAG 2.0 AAA. |
axe spec
Analizza le pagine definite in un file spec JSON o YAML. Vedi Spec di workflow per la documentazione completa.
axe spec <spec-file> [output-directory] [options]| Opzione | Descrizione |
|---|---|
-a, --axe-source <path> |
Percorso per un axe.js file alternativo. |
--accept-untrusted |
Accetta certificati SSL non affidabili. Persiste. |
--axe-devhub-api-key <api-key> |
Chiave API per Axe Developer Hub. |
--axe-devhub-project-id <project-id> |
ID progetto per Axe Developer Hub. |
--axe-devhub-server-url <url> |
URL del server Axe Developer Hub. Default: https://axe.deque.com. |
--axe-reports-api-key <api-key> |
Chiave API per Axe Reports. |
--axe-reports-dimensions <dimensions> |
Dimensioni JTBD separate da virgole per etichettare questa scansione in Axe Reports. |
--axe-reports-url <url> |
URL a cui inviare i risultati a Axe Reports. |
--browser [name] |
Browser da usare. Richiede il WebDriver corrispondente. Valori validi: firefox (default), chrome, safari, edge, ie. Persistente. |
--chrome-options [options] |
Opzioni della riga di comando di Chrome separate da virgole passate a ChromeDriver. Persiste. |
-c, --custom <path> |
Percorso per un file di set di regole personalizzato, che sostituisce il predefinito. |
--descendant-links |
Raccogliere collegamenti su ogni pagina e aggiungerli ai risultati. Richiede --verbose. |
--dismiss-alerts |
Chiudere il browser alert(), confirm(), e prompt() finestre di dialogo prima della scansione. |
--download-path <path> |
Imposta dove il browser salva i download (solo Chrome). |
--enable-tracking <state> |
Abilita (true) o disabilita (false) l'invio dei dati di utilizzo alla libreria di metriche. Persistente. |
-f, --format [value] |
Formato del/i rapporto/i: html, junit, csv, universalo una combinazione separata da +-. Predefinito: html. |
--filter <list> |
Tipi di risultati inclusi separati da virgole: passes, violations, incomplete, inapplicable. Richiede --format csv. |
--headless |
Lancia il browser in modalità headless. Persistente. |
--interactive-mode |
Consenti al CLI di funzionare su pagine che utilizzano la modalità interattiva (solo Chrome). |
--no-analyze |
Rimuovi il requisito di un analyze nel elenco delle azioni di ogni pagina. |
--no-exit |
Forza il codice di uscita 0 anche quando vengono trovate violazioni. |
--no-git-data |
Non inviare i dati del ramo Git e del commit a Axe Developer Hub. |
--no-html |
Impedisci la generazione del rapporto HTML. |
--no-reports |
Impedisci la generazione di tutti i file di rapporto. |
--no-wait |
Disabilita le pause automatiche tra le azioni del workflow. |
--page-name <name> |
Esegui solo la pagina con il nome specificato dal file di specifica. |
--page-source |
Aggiungi il sorgente HTML scansionato ai risultati. Richiede --verbose. |
--page-timeout <ms> |
Tempo massimo in millisecondi per aspettare il caricamento di una pagina. Predefinito: 60000. Persistente. |
--page-title |
Aggiungi il titolo della pagina ai risultati. Richiede --verbose. |
--post-analyze-pause <ms> |
Millisecondi di pausa dopo l'analisi prima dell'azione successiva. Predefinito: 2000. Persistente. |
--post-get-pause <ms> |
Millisecondi di pausa dopo il caricamento della pagina e prima della scansione. Predefinito: 2000. Persistente. |
--post-script-pause <ms> |
Millisecondi di pausa dopo un'azione di script e prima della scansione. Predefinito: 2000. Persistente. |
--remote-proxy [proxy-server] |
Instrada il traffico attraverso un proxy remoto (solo ChromeDriver). Persistente. |
--remote-server [server-url] |
Collegati a un server WebDriver remoto (ad es. Selenium Grid, BrowserStack). Persistente. |
--resume-from <name> |
Salta tutte le pagine prima della pagina nominata nel file di specifica. |
--scanned-url |
Aggiungi l'URL di base e l'URL di scansione ai risultati verbosi. Solo Chrome. Richiede --verbose. |
--script-timeout <ms> |
Tempo massimo in millisecondi per aspettare uno script del workflow. Predefinito: 60000. Persistente. |
--send-axe-reports |
Invia i risultati dell'analisi a Axe Reports. |
--set-distinct-id <id> |
Sovrascrivi l'ID distinto utilizzato per il tracciamento dell'uso. Persistente. |
--set-legacy-mode |
Abilita la modalità di scansione legacy. Obsoleto — sarà rimosso nella versione 5.0. |
--set-tracking-url <url> |
Sostituisci l'URL a cui vengono inviati i dati delle metriche. Persistente. |
--silent-mode |
Sopprimi tutto l'output decorativo; i risultati sono mostrati solo quando --verbose è anche attivo. |
-t, --tags [list] |
Tag separati da virgola per filtrare quali regole vengono eseguite. |
--universal-best-practices |
Registra bestPracticesEnabled=true nei metadati quando si utilizza --format universal. |
--universal-ruleset <id> |
ID del set di regole da registrare nei metadati quando si utilizza --format universal. Valori validi: wcag2, wcag2.1, wcag2.2, wcag2aaa, wcag2.1aaa, wcag2.2aaa, 508, en301549, ttv5, rgaav4. Predefinito: wcag2.1. |
--user-agent <agent> |
Imposta una stringa custom dell'utente agente. Persistente. |
--validate |
Convalida il file spec senza eseguirlo. |
-v, --verbose |
Includi nello output il nome dello strumento, la versione e i metadati dell'ambiente. |
--wait-network-idle-new-connections [number] |
Nuova soglia di connessione prima che la rete sia considerata inattiva. |
--wait-network-idle-open-connections [number] |
Soglia di connessione aperta prima che la rete sia considerata inattiva. |
--wait-network-idle-polling-every [ms] |
Intervallo di polling in millisecondi per il rilevamento dell'inerzia della rete. |
--wait-network-idle-timeout [ms] |
Millisecondi massimi da attendere per la rete inattiva prima di procedere. |
--window-size <width,height> |
Imposta la dimensione della finestra del browser in pixel. Persistente. |
