Pagina's testen met CLI

Bij gebruik van de URI-invoermodus van de CLI zijn er verschillende extra opties beschikbaar om de reikwijdte en regels van een test aan te passen. Bijvoorbeeld, de volgende code zal de header en footer uitsluiten van een test en de kleurcontrastsregel 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 hebben deze optie niet nodig. Het is bedoeld voor geavanceerde gebruiksscenario's, zoals testen met een specifieke of aangepaste versie van axe-core.

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

Specificeer de Axe Account API-sleutel om toegankelijkheidsresultaten naar Axe Developer Hub te sturen. Resultaten worden verzonden naar het project dat is gekoppeld aan de opgegeven project-ID (opgegeven met de --axe-devhub-project-id commandoregeloptie) nadat het testen is voltooid. Zowel --axe-devhub-api-key als --axe-devhub-project-id zijn vereist om resultaten naar Axe Developer Hub te sturen. Zie Het 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 voor het ontvangen van toegankelijkheidstestresultaten. Zowel --axe-devhub-api-key als --axe-devhub-project-id zijn vereist om resultaten naar Axe Developer Hub te sturen. Zie Het 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 Het CLI gebruiken om toegankelijkheidsresultaten naar Axe Developer Hub te sturen voor meer informatie.

-c, --custom <path>

Specificeer een aangepaste regels voor gebruik. Zie Aangepaste regelsets voor details over het genereren van een regelsbestand.

--chrome-options [options]

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

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

--chrome-path <path>

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

--chromedriver-path <path>

Absoluut pad naar de ChromeDriver-uitvoerbare. ChromeDriver is een aparte binaire van de Chrome-browser zelf; het fungeert als een brug die de WebDriver-opdrachten van axe 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 menselijk leesbare samenvatting naar de terminal afgedrukt. 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 tests 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 gespecificeerde types zullen verschijnen; alle andere zijn 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 gespecificeerd, test axe de overeenkomende elementen de overeenkomende elementen, en wordt al het andere op de pagina genegeerd. Dit is zeer restrictief, en de meeste gebruikers zouden -e, --exclude moeten gebruiken. Gebruik --include alleen wanneer u wilt beperken tot een specifieke component, zoals tijdens gefocuste debugging of component-niveau 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 machine-leesbare JSON naar stdout in plaats van de mens-leesbare terminal samenvatting. Alle andere uitvoer wordt stilgelegd. Gebruik dit wanneer resultaten naar een ander programma worden gepiped.

--load-delay <n>

Stel in hoeveel tijd (in 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 commit-informatie bij het verzenden van resultaten naar Axe Developer Hub. Zie Het CLI gebruiken om toegankelijkheidsresultaten naar Axe Developer Hub te sturen.

--no-reporter

Onderdrukt de samenvatting van de overtreding (regel-ID's, tellen, getroffen selectors en help-URL's) zonder alles te onderdrukken. Voortgangsberichten en resultaten geschreven naar schijf via --save, --dir, of --report worden niet beïnvloed. Voornamelijk nuttig in CI-pijplijnen waar u resultaten opslaat in een bestand en --exit gebruikt voor pass/fail-signalisatie en geen gedetailleerde overtredingsgegevens in het buildlogboek wilt. Voor volledige stilte met JSON-resultatenoutput gebruikt u in plaats daarvan -j, --stdout.

-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 met -f, --format om het uitvoerformaat te bepalen (standaard HTML). Gebruik dit wanneer u een voor mensen leesbaar of machinaal leesbaar rapport wilt in plaats van ruwe JSON, bijvoorbeeld een HTML-rapport om te delen met belanghebbenden of een JUnit XML-bestand voor CI-integratie. Voor ruwe JSON-uitvoer gebruikt u in plaats daarvan -d, --dir.

--rules <list>

Komma-gescheiden lijst met regel-ID's om uit te voeren. Alleen de gespecificeerde 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; indien weggelaten, krijgt het bestand de naam axe-result.json. Om in plaats daarvan in een specifieke directory op te slaan, gebruikt u -d, --dir.

--show-errors

Wanneer axe een runtime-fout tegenkomt (zoals het niet kunnen initialiseren of een uitzondering die tijdens de uitvoering wordt gegooid), wordt normaal gesproken een korte foutmelding naar stderr gedrukt. Deze vlag voegt de volledige stacktrace toe aan die output. 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 één van de gespecificeerde tags worden opgenomen. Zie de axe-core tagdocumentatie voor een volledige lijst van beschikbare tags.

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

--timer

Print drie tijduitmetingen naar de terminal na elke testrun:

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

Gebruik dit om trage 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 in de Axe-analyse, of om te onderzoeken waarom een run de --page-timeout of --script-timeout limieten bereikt.

--universal-best-practices

Registreert bestPracticesEnabled=true in de metadata van de universele formaatuitvoer. Vereist --format universal.

--universal-ruleset <id>

Specificeert de regels-ID die wordt geregistreerd in de metadata van de universele formaatuitvoer. Standaard is wcag2.1. Vereist --format universal.

-v, --verbose

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

• Testengine: de gebruikte axe-core versie
• Testomgeving: browser user agent, viewport breedte en hoogte, en schermoriëntatie
• Test kunnen: de runner-naam

Let op: deze output verschijnt alleen wanneer er overtredingen worden gedetecteerd. Als een pagina geen overtredingen heeft, wordt de metadata niet afgedrukt. Gebruik dit om exact te bevestigen welke axe-core versie is uitgevoerd, viewportinstellingen te verifiëren of om omgevingsdetails in een bugrapport op te nemen.

Configuratieopties

De volgende opties regelen het browsergedrag en de testtijd. In tegenstelling tot de bovenstaande opties blijven deze behouden tussen CLI-runs; het instellen ervan eenmaal slaat de waarde op 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 Configuratieopties.