CLI-referentie
Opdrachtensyntaxis en volledige optie-referentie voor alle Axe DevTools CLI-subcommando's
Een snelle referentie voor elk Axe DevTools CLI-subcommando en de bijbehorende opties. Voor gebruiksinstructies en voorbeelden, volg de link naar het artikel van elke opdracht.
axe <url>— analyseer pagina's op URLaxe bulk-reports— stuur resultaten naar Axe Reportsaxe bulk-spec— voer een directory van spec-bestanden uitaxe config-selenium— configureer blijvende browser standaardinstellingenaxe devhub— stuur resultaten naar Axe Developer Hubaxe licenses— toon afhankelijkheidslicentiesaxe reporter— genereer rapporten van JSON-resultatenaxe ruleset— genereer aangepaste regelsetsaxe spec— voer een spec-bestand uit
axe <url>
Analyseert een of meer webpagina's op toegankelijkheidsproblemen. Zie Pagina's testen voor volledige documentatie.
axe <url...> [options]Sommige opties worden opgeslagen in een voorkeursbestand en blijven behouden bij CLI-sessies. Zie Configuratie voor details.
| Optie | Beschrijving |
|---|---|
-a, --axe-source <path> |
Pad naar een alternatief axe.js bestand. |
--accept-untrusted |
Accepteer niet-vertrouwde SSL-certificaten. Blijft gehandhaafd. |
--axe-devhub-api-key <api-key> |
API-sleutel voor Axe Developer Hub. |
--axe-devhub-project-id <project-id> |
Project-ID voor Axe Developer Hub. |
--axe-devhub-server-url <url> |
URL van de Axe Developer Hub-server. Standaard: https://axe.deque.com. |
--axe-reports-api-key <api-key> |
API-sleutel voor Axe Reports. |
--axe-reports-dimensions <dimensions> |
Door komma's gescheiden JTBD-dimensies om deze scan te taggen in Axe Reports. |
--axe-reports-url <url> |
URL om resultaten naar Axe Reports te verzenden. |
--browser [name] |
Browser om te gebruiken. Vereist de bijbehorende WebDriver. Geldige waarden: firefox (standaard), chrome, edge (of microsoftedge), safari, ie. Browser-specifieke opties zijn alleen van toepassing op Firefox, Chrome en Edge. Blijft bestaan. |
--chrome-options [options] |
Komma-gescheiden browseropdrachtregelparameters voor Chrome of Edge. Blijft bestaan. |
--chrome-path <path> |
Absoluut pad naar het Chrome- of Edge-browseruitvoerbestand. |
--chromedriver-path <path> |
Absoluut pad naar het ChromeDriver- of msedgedriver-uitvoerbestand. |
-c, --custom <path> |
Pad naar een aangepast regelsbestand dat de standaard overschrijft. |
-d, --dir <path> |
Directory waar JSON-resultaten worden opgeslagen. |
-l, --disable <list> |
Door komma's gescheiden regel-ID's om uit te schakelen. |
-e, --exclude <list> |
Door komma's gescheiden CSS-selectors voor elementen die niet getest hoeven te worden. |
-q, --exit |
Beëindig met code 1 als er overtredingen worden gevonden. |
--enable-tracking <state> |
Schakel het verzenden van gebruiksgegevens naar de metriekbibliotheek in (true) of uit (false). Blijft geldig. |
-f, --format <value> |
Rapportformaat/formats: html, junit, csv, universal, of een +-gescheiden combinatie. Standaard: html. Vereist -r, --report. |
--filter <list> |
Door komma's gescheiden resultaatstypen om op te nemen: passes, violations, incomplete, inapplicable. Vereist --format csv. |
--universal-best-practices |
Neem bestPracticesEnabled=true op in de metadata bij gebruik van --format universal. |
--universal-ruleset <id> |
Ruleset-ID om vast te leggen in de metadata bij gebruik van --format universal. Geldige waarden: wcag2, wcag2.1, wcag2.2, wcag2aaa, wcag2.1aaa, wcag2.2aaa, 508, en301549, ttv5, rgaav4. Standaard: wcag2.1. |
--headless |
Start de browser in headless-modus. Blijft behouden. |
-i, --include <list> |
Komma-gescheiden CSS-selectoren. Alleen overeenkomende elementen worden getest. |
--load-delay <n> |
Milliseconden om te wachten na paginalading voordat de audit wordt uitgevoerd. Standaard: 0. |
--no-git-data |
Stuur geen Git-branch- en commitgegevens naar Axe Developer Hub. |
--no-reporter |
Onderdruk de uitvoer van de overtredingssamenvatting. |
--page-timeout <ms> |
Maximale milliseconden om te wachten tot een pagina geladen is. Standaard: 60000. Blijft geldig. |
--post-analyze-pause <ms> |
Milliseconden om te pauzeren na analyse voordat de volgende actie plaatsvindt. Standaard: 2000. Blijft geldig. |
--post-get-pause <ms> |
Milliseconden om te pauzeren na het laden van de pagina en voordat wordt gescand. Standaard: 2000. Blijft geldig. |
--post-script-pause <ms> |
Milliseconden om te pauzeren na een scriptactie en voordat wordt gescand. Standaard: 2000. Blijft geldig. |
-r, --report <output-dir> |
Directory waar het opgemaakte rapport wordt opgeslagen. Gebruik met -f, --format. |
--remote-proxy [proxy-server] |
Verkeer omleiden via een externe proxy (alleen Chromium-gebaseerde browsers: Chrome en Edge). Blijft bestaan. |
--remote-server [server-url] |
Maak verbinding met een externe WebDriver-server (bijv. Selenium Grid, BrowserStack). Blijft behouden. |
--rules <list> |
Komma-gescheiden regel-ID's om uit te voeren. Alleen de gespecificeerde regels worden gecontroleerd. |
-s, --save [filename] |
Sla de resultaten op als een JSON-bestand. Bestandsnaam is standaard axe-result.json. |
--script-timeout <ms> |
Maximale milliseconden om te wachten op een workflowscript. Standaard: 60000. Blijft geldig. |
--send-axe-reports |
Stuur analyseresultaten naar Axe Reports. |
--set-distinct-id <id> |
Overschrijf de unieke ID die wordt gebruikt voor gebruiksregistratie. Blijft behouden. |
--set-tracking-url <url> |
Overschrijf de URL waarnaar metrische gegevens worden verzonden. Blijft bewaard. |
--show-errors |
Weergave van de volledige foutstack-trace bij fouten. |
-j, --stdout |
JSON-resultaten naar stdout uitvoeren; onderdrukt alle andere uitvoer. |
-t, --tags <list> |
Komma-gescheiden tags om te filteren welke regels worden uitgevoerd. |
--timer |
Print tijdsmetingen na elke testuitvoering. |
-v, --verbose |
Inclusief toolnaam, versie en omgevingsmetadata in de uitvoer. |
-V, --version |
Het versienummer uitvoeren. |
--window-size <width,height> |
Stel de grootte van het browservenster in pixels in. Blijft bewaard. |
axe bulk-reports
Stuurt JSON-resultaten naar Axe Reports. Zie Verzenden naar Axe Reports voor volledige documentatie.
axe bulk-reports <results-directory> [options]| Optie | Beschrijving |
|---|---|
--axe-reports-api-key <api-key> |
API-sleutel voor Axe Reports. |
--axe-reports-dimensions <dimensions> |
Door komma's gescheiden JTBD-dimensies om deze scan te taggen in Axe Reports. |
--axe-reports-url <url> |
URL om resultaten naar Axe Reports te verzenden. |
--send-axe-reports |
Stuur analyseresultaten naar Axe Reports. |
--verbose |
Schakel gedetailleerde logging in. |
axe bulk-spec
Verwerkt een directory van spec-bestanden in één keer. Zie Werkstroom specs voor volledige documentatie.
axe bulk-spec <spec-files-directory> [output-directory] [options]| Optie | Beschrijving |
|---|---|
-a, --axe-source <path> |
Pad naar een alternatief axe.js bestand. |
--accept-untrusted |
Accepteer niet-vertrouwde SSL-certificaten. Blijft gehandhaafd. |
--browser [name] |
Browser om te gebruiken. Vereist de bijbehorende WebDriver. Geldige waarden: firefox (standaard), chrome, edge (of microsoftedge), safari, ie. Browser-specifieke opties zijn alleen van toepassing op Firefox, Chrome en Edge. Blijft bestaan. |
-c, --custom <path> |
Pad naar een aangepast regelsbestand dat de standaard overschrijft. |
--dismiss-alerts |
Sluit browseralert()-, confirm()- en prompt()-dialogen voordat wordt gescand. |
--enable-tracking <state> |
Schakel het verzenden van gebruiksgegevens naar de metriekbibliotheek in (true) of uit (false). Blijft geldig. |
-f, --format [value] |
Rapportformaat/formats: html, junit, csv, of een +-gescheiden combinatie. Standaard: html. |
--headless |
Start de browser in headless-modus. Blijft behouden. |
--no-analyze |
Verwijder de vereiste voor een analyze-actie in de actielijst van elke pagina. |
--no-html |
Voorkom de generatie van HTML-rapporten. |
--no-reports |
Voorkom alle rapportbestandgeneratie. |
--no-wait |
Schakel automatische pauzes tussen workflowacties uit. |
--page-timeout <ms> |
Maximale milliseconden om te wachten tot een pagina geladen is. Standaard: 60000. Blijft geldig. |
--post-analyze-pause <ms> |
Milliseconden om te pauzeren na analyse voordat de volgende actie plaatsvindt. Standaard: 2000. Blijft geldig. |
--post-get-pause <ms> |
Milliseconden om te pauzeren na het laden van de pagina en voordat wordt gescand. Standaard: 2000. Blijft geldig. |
--post-script-pause <ms> |
Milliseconden om te pauzeren na een scriptactie en voordat wordt gescand. Standaard: 2000. Blijft geldig. |
--remote-proxy [proxy-server] |
Verkeer omleiden via een externe proxy (alleen Chromium-gebaseerde browsers: Chrome en Edge). Blijft bestaan. |
--remote-server [server-url] |
Maak verbinding met een externe WebDriver-server (bijv. Selenium Grid, BrowserStack). Blijft behouden. |
--script-timeout <ms> |
Maximale milliseconden om te wachten op een workflowscript. Standaard: 60000. Blijft geldig. |
--set-distinct-id <id> |
Overschrijf de unieke ID die wordt gebruikt voor gebruiksregistratie. Blijft behouden. |
--set-tracking-url <url> |
Overschrijf de URL waarnaar metrische gegevens worden verzonden. Blijft bewaard. |
-t, --tags [list] |
Komma-gescheiden tags om te filteren welke regels worden uitgevoerd. |
--user-agent <agent> |
Een aangepaste user-agent-string instellen (alleen Chromium-gebaseerde browsers: Chrome en Edge). Blijft bestaan. |
--validate |
Valideer de specificatiebestanden zonder ze uit te voeren. |
--wait-network-idle-new-connections [number] |
Nieuwe verbindingdrempel voordat het netwerk als inactief wordt beschouwd (alleen Chromium-gebaseerde browsers: Chrome en Edge). |
--wait-network-idle-open-connections [number] |
Open verbindingdrempel voordat het netwerk als inactief wordt beschouwd (alleen Chromium-gebaseerde browsers: Chrome en Edge). |
--wait-network-idle-timeout [ms] |
Maximaal aantal milliseconden wachten voordat het netwerk als inactief wordt beschouwd (alleen Chromium-gebaseerde browsers: Chrome en Edge). |
--window-size <width,height> |
Stel de grootte van het browservenster in pixels in. Blijft bewaard. |
axe config-selenium
Configureert interactief blijvende browser- en timingstandaarden. Zie Configuratie voor volledige documentatie.
axe config-selenium [options]| Optie | Beschrijving |
|---|---|
-s, --show |
Toon huidige opgeslagen instellingen zonder de interactieve prompt in te voeren. |
axe devhub
Stuurt JSON-resultaten naar Axe Developer Hub. Zie Verzenden naar Axe Developer Hub voor volledige documentatie.
axe devhub <results-directory|file> [options]| Optie | Beschrijving |
|---|---|
--axe-devhub-api-key <api-key> |
API-sleutel voor Axe Developer Hub. Overschrijft de AXE_DEVHUB_API_KEY-omgevingsvariabele. |
--axe-devhub-project-id <project-id> |
Project-ID voor Axe Developer Hub. |
--axe-devhub-server-url <url> |
URL van de Axe Developer Hub-server. Standaard: https://axe.deque.com. |
--no-git-data |
Stuur geen Git-branch- en commitgegevens naar Axe Developer Hub. |
axe licenses
Geeft de open-source licenties weer en slaat deze op voor alle CLI-afhankelijkheden.
axe licenses [options]axe reporter
Zet JSON-resultaten om in HTML-, JUnit XML- of CSV-rapporten. Zie Rapporten genereren voor volledige documentatie.
axe reporter <results-dir> [dest-dir] [options]| Optie | Beschrijving |
|---|---|
-b, --browser [name] |
Wanneer de resultatenmap resultaten van meerdere browsers bevat, genereer het rapport dan alleen van de resultaten van één browser. |
-d, --dest [path] |
Outputmap voor gegenereerde rapporten. Kan ook als het tweede positionele argument worden gespecificeerd. |
--filter <list> |
Door komma's gescheiden resultaatstypen om op te nemen: passes, violations, incomplete, inapplicable. Vereist --format csv. |
-f, --format [type(s)] |
Uitvoerformaat/formats: html, junit, csv, universal, of een combinatie. Standaard: html. |
--universal-best-practices |
Neem bestPracticesEnabled=true op in de metadata bij gebruik van --format universal. |
--universal-ruleset <id> |
Ruleset-ID om vast te leggen in de metadata bij gebruik van --format universal. Geldige waarden: wcag2, wcag2.1, wcag2.2, wcag2aaa, wcag2.1aaa, wcag2.2aaa, 508, en301549, ttv5, rgaav4. Standaard: wcag2.1. |
axe ruleset
Genereert aangepaste regelsbestanden. Zie Aangepaste Regels voor de volledige documentatie.
axe ruleset [options]| Optie | Beschrijving |
|---|---|
--508 [filename] |
Genereer een standaardconfiguratie voor Section 508-regels. |
--all [filename] |
Genereer een standaardconfiguratie voor alle ondersteunde richtlijnen. |
-a, --axe-source <path> |
Pad naar een aangepaste axe-bron. |
-c, --custom [dir] |
Genereer een aangepaste regelsset vanuit een directory met een changes.json bestand. |
-d, --destination [dir] |
Uitvoermap. Standaard: huidige werkmap. |
-x, --disable-other-rules |
Schakel alle regels uit die niet zijn opgenomen in de rules eigenschap. Standaard: true. |
--en301549 [filename] |
Genereer een standaardconfiguratie voor EN 301 549-regels. |
-f, --format [format] |
Uitvoerformaat. |
-l, --log |
Genereer ook een lijst van alle regels die zijn opgenomen in de gegenereerde set. |
--only-changes |
Genereer alleen de wijzigingen en toevoegingen aan de set regels. |
--rgaav4 [filename] |
Genereer een standaardconfiguratie voor RGAA v4-regels. |
-t, --tags [list] |
Door komma's gescheiden tags om de standaard set regels te filteren. |
--ttv5 [filename] |
Genereer een standaardconfiguratie voor Trusted Tester v5-regels. |
--wcag2 [filename] |
Genereer een standaardconfiguratie voor WCAG 2.0 AA-regels. |
--wcag21 [filename] |
Genereer een standaardconfiguratie voor WCAG 2.1 AA-regels. |
--wcag21aaa [filename] |
Genereer een standaardconfiguratie voor WCAG 2.1 AAA-regels. |
--wcag22 [filename] |
Genereer een standaardconfiguratie voor WCAG 2.2 AA-regels. |
--wcag22aaa [filename] |
Genereer een standaardconfiguratie voor WCAG 2.2 AAA-regels. |
--wcag2aaa [filename] |
Genereer een standaardconfiguratie voor WCAG 2.0 AAA-regels. |
axe spec
Analyseert pagina's gedefinieerd in een JSON- of YAML-specificatiebestand. Zie Werkstroom specs voor de volledige documentatie.
axe spec <spec-file> [output-directory] [options]| Optie | Beschrijving |
|---|---|
-a, --axe-source <path> |
Pad naar een alternatief axe.js bestand. |
--accept-untrusted |
Accepteer niet-vertrouwde SSL-certificaten. Blijft gehandhaafd. |
--axe-devhub-api-key <api-key> |
API-sleutel voor Axe Developer Hub. |
--axe-devhub-project-id <project-id> |
Project-ID voor Axe Developer Hub. |
--axe-devhub-server-url <url> |
URL van de Axe Developer Hub-server. Standaard: https://axe.deque.com. |
--axe-reports-api-key <api-key> |
API-sleutel voor Axe Reports. |
--axe-reports-dimensions <dimensions> |
Door komma's gescheiden JTBD-dimensies om deze scan te taggen in Axe Reports. |
--axe-reports-url <url> |
URL om resultaten naar Axe Reports te verzenden. |
--browser [name] |
Browser om te gebruiken. Vereist de bijbehorende WebDriver. Geldige waarden: firefox (standaard), chrome, edge (of microsoftedge), safari, ie. Browser-specifieke opties zijn alleen van toepassing op Firefox, Chrome en Edge. Blijft bestaan. |
--chrome-options [options] |
Komma-gescheiden browseropdrachtregelparameters voor Chrome of Edge. Blijft bestaan. |
-c, --custom <path> |
Pad naar een aangepast regelsbestand dat de standaard overschrijft. |
--descendant-links |
Verzamel links op elke pagina en voeg ze toe aan de resultaten. Vereist --verbose. |
--dismiss-alerts |
Sluit browseralert()-, confirm()- en prompt()-dialogen voordat wordt gescand. |
--download-path <path> |
Instellen waar de browser downloads opslaat (alleen Chromium-gebaseerde browsers: Chrome en Edge). |
--enable-tracking <state> |
Schakel het verzenden van gebruiksgegevens naar de metriekbibliotheek in (true) of uit (false). Blijft geldig. |
-f, --format [value] |
Rapportformaat/formaten: html, junit, csv, universal, of een combinatie gescheiden door +. Standaard: html. |
--filter <list> |
Door komma's gescheiden resultaatstypen om op te nemen: passes, violations, incomplete, inapplicable. Vereist --format csv. |
--headless |
Start de browser in headless-modus. Blijft behouden. |
--interactive-mode |
Begin met het uitvoeren van acties zodra de HTML van de pagina is geladen, zonder te wachten tot afbeeldingen, stylesheets en andere bronnen zijn geladen. Gebruik dit voor pagina's waarmee je vóór het scannen moet interageren, of die lang duren om te laden. |
--no-analyze |
Verwijder de vereiste voor een analyze-actie in de actielijst van elke pagina. |
--no-exit |
Forceer exitcode 0, zelfs wanneer er inbreuken worden gevonden. |
--no-git-data |
Stuur geen Git-branch- en commitgegevens naar Axe Developer Hub. |
--no-html |
Voorkom de generatie van HTML-rapporten. |
--no-reports |
Voorkom alle rapportbestandgeneratie. |
--no-wait |
Schakel automatische pauzes tussen workflowacties uit. |
--page-name <name> |
Voer alleen de pagina met de opgegeven naam uit het specificatiebestand uit. |
--page-source |
Voeg de gescande HTML-bron toe aan de resultaten. Vereist --verbose. |
--page-timeout <ms> |
Maximale milliseconden om te wachten tot een pagina geladen is. Standaard: 60000. Blijft geldig. |
--page-title |
Voeg de paginatitel toe aan de resultaten. Vereist --verbose. |
--post-analyze-pause <ms> |
Milliseconden om te pauzeren na analyse voordat de volgende actie plaatsvindt. Standaard: 2000. Blijft geldig. |
--post-get-pause <ms> |
Milliseconden om te pauzeren na het laden van de pagina en voordat wordt gescand. Standaard: 2000. Blijft geldig. |
--post-script-pause <ms> |
Milliseconden om te pauzeren na een scriptactie en voordat wordt gescand. Standaard: 2000. Blijft geldig. |
--remote-proxy [proxy-server] |
Verkeer omleiden via een externe proxy (alleen Chromium-gebaseerde browsers: Chrome en Edge). Blijft bestaan. |
--remote-server [server-url] |
Maak verbinding met een externe WebDriver-server (bijv. Selenium Grid, BrowserStack). Blijft behouden. |
--resume-from <name> |
Sla alle pagina's over vóór de genoemde pagina in het specificatiebestand. |
--scanned-url |
Voeg de basis-URL en scan-URL toe aan gedetailleerde resultaten. Alleen Chrome. Vereist --verbose. |
--script-timeout <ms> |
Maximale milliseconden om te wachten op een workflowscript. Standaard: 60000. Blijft geldig. |
--send-axe-reports |
Stuur analyseresultaten naar Axe Reports. |
--set-distinct-id <id> |
Overschrijf de unieke ID die wordt gebruikt voor gebruiksregistratie. Blijft behouden. |
--set-legacy-mode |
Schakel de oude scanmodus in. Verouderd — zal worden verwijderd in v5.0. |
--set-tracking-url <url> |
Overschrijf de URL waarnaar metrische gegevens worden verzonden. Blijft bewaard. |
--silent-mode |
Onderdruk alle decoratieve uitvoer; resultaten worden alleen weergegeven wanneer --verbose ook actief is. |
-t, --tags [list] |
Komma-gescheiden tags om te filteren welke regels worden uitgevoerd. |
--universal-best-practices |
Neem bestPracticesEnabled=true op in de metadata bij gebruik van --format universal. |
--universal-ruleset <id> |
Ruleset-ID om vast te leggen in de metadata bij gebruik van --format universal. Geldige waarden: wcag2, wcag2.1, wcag2.2, wcag2aaa, wcag2.1aaa, wcag2.2aaa, 508, en301549, ttv5, rgaav4. Standaard: wcag2.1. |
--user-agent <agent> |
Een aangepaste user-agent-string instellen (alleen Chromium-gebaseerde browsers: Chrome en Edge). Blijft bestaan. |
--validate |
Valideer het spec-bestand zonder het uit te voeren. |
-v, --verbose |
Inclusief toolnaam, versie en omgevingsmetadata in de uitvoer. |
--wait-network-idle-new-connections [number] |
Nieuwe verbindingdrempel voordat het netwerk als inactief wordt beschouwd (alleen Chromium-gebaseerde browsers: Chrome en Edge). |
--wait-network-idle-open-connections [number] |
Open verbindingdrempel voordat het netwerk als inactief wordt beschouwd (alleen Chromium-gebaseerde browsers: Chrome en Edge). |
--wait-network-idle-polling-every [ms] |
Pollfrequentie in milliseconden voor netwerk-inactiefdetectie (alleen Chromium-gebaseerde browsers: Chrome en Edge). |
--wait-network-idle-timeout [ms] |
Maximaal aantal milliseconden wachten voordat het netwerk als inactief wordt beschouwd (alleen Chromium-gebaseerde browsers: Chrome en Edge). |
--window-size <width,height> |
Stel de grootte van het browservenster in pixels in. Blijft bewaard. |
