Pagina's testen met CLI

Wanneer u de URI-invoermodus van de CLI gebruikt, zijn er verschillende extra opties beschikbaar om de scope en het regelsysteem van een test aan te passen. Bijvoorbeeld, de volgende code zal de header en footer van een test uitsluiten en de regel voor kleurcontrast uitschakelen:

axe http://example.com --exclude footer,header --disable color-contrast

Opties

-a, --axe-source <path>

Pad naar een alternatief axe.js bestand. De meeste gebruikers hoeven deze optie niet te gebruiken. Het is bedoeld voor geavanceerde gevallen zoals testen tegen een specifieke of aangepaste versie van axe-core.

--axe-devhub-api-key <your-API-key>

Geef de Axe Account API-sleutel op om toegankelijkheidsresultaten naar Axe Developer Hub te sturen. Resultaten worden verzonden naar het project dat is gekoppeld aan de opgegeven project-ID (gespecificeerd met de --axe-devhub-project-id opdrachtregeloptie) nadat de test is voltooid. Zowel --axe-devhub-api-key als --axe-devhub-project-id zijn vereist om resultaten naar Axe Developer Hub te sturen. Zie De CLI gebruiken om toegankelijkheidsresultaten naar Axe Developer Hub te sturen voor meer informatie.

--axe-devhub-project-id <your-project-ID>

Specificeer de Axe Developer Hub project-ID om toegankelijkheidstestresultaten te ontvangen. Zowel --axe-devhub-api-key als --axe-devhub-project-id zijn vereist om resultaten naar Axe Developer Hub te sturen. Zie De CLI gebruiken om toegankelijkheidsresultaten naar Axe Developer Hub te sturen voor meer informatie.

--axe-devhub-server-url <url>

Specificeer de URL van de Axe Developer Hub server. Standaard is https://axe.deque.com. Equivalent aan de AXE_DEVHUB_SERVER_URL omgevingsvariabele. Zie De CLI gebruiken om toegankelijkheidsresultaten naar Axe Developer Hub te sturen voor meer informatie.

-c, --custom <path>

Specificeer een aangepast regelsysteem om te gebruiken. Zie Aangepaste Regelsystemen voor details over het genereren van een regelsysteembestand.

--chrome-options [options]

Komma-gescheiden lijst van Chrome-opdrachtregel schakelaars om aan de browser door te geven. Bijvoorbeeld:

axe http://example.com --chrome-options="some-switch,some-other-switch"

--chrome-path <path>

Absoluut pad naar het uitvoerbare bestand van de Chrome-browser. Gebruik dit om axe te wijzen naar een specifieke Chrome-installatie wanneer de standaardbrowser niet kan worden gevonden, of u moet werken met een specifieke versie.

--chromedriver-path <path>

Absoluut pad naar het uitvoerbare bestand van ChromeDriver. ChromeDriver is een aparte binaire bestand van de browser zelf; het fungeert als een brug die axede WebDriver-opdrachten vertaalt naar instructies die Chrome kan uitvoeren.

-d, --dir <path>

De directory waar het JSON-resultatenbestand wordt opgeslagen. Zonder deze vlag (of --save of --report), wordt er geen bestand geschreven en worden de resultaten als een leesbare samenvatting naar de terminal geprint. Zie ook -j, --stdout als u machineleesbare output nodig heeft zonder naar schijf te schrijven.

-l, --disable <list>

Komma-gescheiden lijst van regel-ID's om uit te schakelen. Zie de axe-core regelbeschrijvingen voor een volledige lijst van regel-ID's.

axe http://example.com --disable color-contrast,duplicate-id

-e, --exclude <list>

Komma-gescheiden lijst van CSS-selectoren voor elementen die uit de test moeten worden uitgesloten. Bijvoorbeeld:

# Exclude by element type
axe http://example.com --exclude footer,header

# Exclude by class or ID
axe http://example.com --exclude ".ad-banner,#cookie-notice"

# Exclude by attribute
axe http://example.com --exclude "[aria-hidden=true]"

-f, --format <value>

Formaat van het gegenereerde rapport. Vereist -r, --report. Zie Rapporten Maken en Filteren voor details over wat elk formaat bevat. Standaard: html.

axe http://example.com --report ./reports --format html+junit+csv

--filter <list>

Komma-gescheiden lijst van resultaattypes om op te nemen in de CSV-uitvoer. Alleen de opgegeven types zullen verschijnen; alle andere worden uitgesloten. Geldige waarden zijn passes, violations, incomplete, en inapplicable. Vereist --format csv.

axe reporter ./axe-reports/json/ --format=csv --filter passes,inapplicable

-i, --include <list>

Komma-gescheiden lijst van CSS-selectors. Wanneer opgegeven, axe test alleen de overeenkomende elementen , en wordt al het andere op de pagina genegeerd. Dit is zeer restrictief en de meeste gebruikers zouden in plaats daarvan -e, --exclude moeten gebruiken. Gebruik --include alleen wanneer je het testen wilt isoleren tot een specifieke component, zoals tijdens gerichte foutopsporing of componentniveau CI-controles.

# Test only the main navigation
axe http://example.com --include nav

# Test only elements with a specific class or ID
axe http://example.com --include ".my-widget,#signup-form"

# Test only elements with a specific attribute
axe http://example.com --include "[data-testid=checkout]"

-j, --stdout

Schrijf de volledige resultaten als machineleesbare JSON naar stdout in plaats van de mensleesbare terminalweergave. Alle andere output wordt stilgezet. Gebruik dit wanneer je resultaten naar een ander programma doorstuurt.

--load-delay <n>

Stel in hoeveel tijd (milliseconden) axe zal wachten na het laden van de pagina voordat de audit wordt uitgevoerd (standaard: 0).

--no-git-data

Rapporteer geen Git-branch- en commitinformatie bij het verzenden van resultaten naar Axe Developer Hub. Zie Het CLI-gebruik om toegankelijkheidsresultaten naar Axe Developer Hub te verzenden.

--no-reporter

Onderdrukt de schendingsoverzichtuitvoer (regel-ID's, aantallen, beïnvloede selectors en help-URL's) zonder alles stil te zetten. Voortgangsberichten en resultaten die via --save, --dir, of --report op schijf worden geschreven, worden niet beïnvloed. Voornamelijk nuttig in CI-pijplijnen waar je resultaten opslaat in een bestand en gebruik maakt van --exit voor controle op slaag- en faalsignalen en je geen uitgebreide schendingdetails in het bouwlogboek wilt. Voor volledige stilte met JSON-resultaatuitvoer, gebruik -j, --stdout in plaats daarvan.

-q, --exit

Verlaat met 1 foutcode als een van de toegankelijkheidstests mislukt.

-r, --report <output-dir>

De directory waar het geformatteerde rapport wordt geschreven. Werkt samen met -f, --format om het uitvoerformaat te bepalen (standaard HTML). Gebruik dit wanneer je een menselijk-leesbaar of machine-leesbaar rapport wilt in plaats van ruwe JSON, bijvoorbeeld een HTML-rapport voor het delen met belanghebbenden of een JUnit XML-bestand voor CI-integratie. Voor ruwe JSON-uitvoer, gebruik -d, --dir in plaats daarvan.

--rules <list>

Komma-gescheiden lijst van regel-ID's om uit te voeren. Alleen de opgegeven regels worden gecontroleerd; alle andere worden overgeslagen. Zie de axe-core regelbeschrijvingen voor een volledige lijst van regel-ID's.

axe http://example.com --rules color-contrast,duplicate-id

-s, --save [filename]

Sla de resultaten op als een JSON-bestand in de huidige directory. De bestandsnaam is optioneel; als deze wordt weggelaten, wordt het bestand genoemd axe-result.json. Om in een specifieke directory op te slaan, gebruik -d, --dir.

--show-errors

Wanneer axe een runtime-fout tegenkomt (zoals een fout bij het initialiseren of een uitzondering die tijdens de uitvoering wordt gegooid), geeft het normaal gesproken een korte foutmelding naar stderr. Deze vlag voegt de volledige stack-trace toe aan die uitvoer. Het beïnvloedt niet hoe toegankelijkheidsovertredingen worden gerapporteerd. Gebruik dit bij het debuggen van een aangepast --axe-source bestand, het diagnosticeren van onverwachte fouten in CI, of het verzamelen van informatie voor een bugrapport.

-t, --tags <list>

Komma-gescheiden lijst van tags om te filteren welke regels worden uitgevoerd. Alleen regels die overeenkomen met ten minste een van de opgegeven tags worden opgenomen. Zie de axe-core tags documentatie voor een volledige lijst van beschikbare tags.

axe http://example.com --tags wcag2a,wcag2aa

--timer

Druk drie tijdsmetingen af naar de terminal na elke testrun:

• axe paginalaadtijd: hoe lang de pagina in de browser nodig had om te laden
• axe-core uitvoeringstijd: hoe lang axe-core nodig had om de pagina te analyseren
• Totale testtijd: de totale verstreken tijd voor de run

Gebruik dit om langzame tests te diagnosticeren. Gebruik bijvoorbeeld deze optie om te bepalen of de tijd wordt besteed aan het wachten op het laden van de pagina of aan Axe-analyse, of om te onderzoeken waarom een run --page-timeout of --script-timeout limieten bereikt.

-v, --verbose

Wanneer er overtredingen worden gevonden, wordt een JSON-blok afgedrukt na de samenvatting van de overtredingen met daarin:

• **Test Engine**: de gebruikte axe-core versie
• **Testomgeving**: browser user agent, breedte en hoogte van het viewport en schermoriëntatie
• **Test Runner**: de naam van de runner

Merk op dat deze output alleen verschijnt wanneer er overtredingen worden gedetecteerd. Als een pagina geen overtredingen heeft, wordt de metadata niet afgedrukt. Gebruik dit wanneer je precies wilt bevestigen welke axe-core versie is uitgevoerd, de viewport-instellingen wilt verifiëren of omgevingsdetails wilt opnemen in een bugrapport.

Configuratie-opties

De volgende opties bepalen het gedrag van de browser en de timing van de tests. In tegenstelling tot de bovenstaande opties blijven deze bewaard tussen CLI-runs; als je ze één keer instelt, wordt de waarde opgeslagen in een voorkeursbestand dat voor alle toekomstige runs wordt gebruikt. Ze kunnen ook interactief worden ingesteld met behulp van axe config-selenium.

Voor volledige details, zie Configuratie-opties.