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 toepassingen zoals testen tegen 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 het opgegeven project-ID (opgegeven met de --axe-devhub-project-id opdrachtregeloptie) 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 De CLI gebruiken om toegankelijkheidsresultaten naar Axe Developer Hub te sturen voor meer informatie.

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

Specificeer het project-ID van Axe Developer Hub 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 aangepaste set regels om te gebruiken. 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 het uitvoerbare bestand van de Chrome-browser. Gebruik dit om axe te wijzen op een specifieke Chrome-installatie wanneer de standaardbrowser niet kan worden gevonden of als u tegen een specifieke versie moet draaien.

--chromedriver-path <path>

Absoluut pad naar het uitvoerbare bestand van ChromeDriver. ChromeDriver is een afzonderlijk programma van de Chrome-browser zelf; het fungeert als een brug die axeWebDriver-commando's omzet in 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 resultaten als een voor mensen leesbare samenvatting naar de terminal gestuurd. Zie ook -j, --stdout als u machineleesbare uitvoer nodig heeft zonder naar de schijf te schrijven.

-l, --disable <list>

Komma-gescheiden lijst van regel-ID's om uit te schakelen. Zie de beschrijvingen van axe-core regels 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 opgegeven types worden getoond; 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 gespecificeerd, axe test alleen de overeenkomende elementen , en alles op de pagina wordt genegeerd. Dit is zeer restrictief en de meeste gebruikers zouden eerder -e, --exclude moeten gebruiken. Gebruik --include alleen wanneer je testen wilt isoleren tot een specifiek onderdeel, bijvoorbeeld tijdens gerichte debugging 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 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 (milliseconden) axe zal wachten na paginalaod 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 gebruiken om toegankelijkheidsresultaten naar Axe Developer Hub te sturen.

--no-reporter

Onderdrukt de uitvoer van de schendingssamenvatting (regel-ID's, aantallen, getroffen selectors en help-URL's) zonder alles stil te leggen. Voortgangsberichten en resultaten die naar schijf worden geschreven via --save, --dir, of --report worden niet beïnvloed. Vooral nuttig in CI-pijplijnen waar je resultaten naar een bestand opslaat en --exit gebruikt voor pass/fail-signalisatie en je geen gedetailleerde schendingsdetails in de buildlog wilt. Voor volledige stilte met JSON-resultaatuitvoer, gebruik -j, --stdout in plaats daarvan.

-q, --exit

Sluit af met 1 foutcode als een van de toegankelijkheidstests faalt.

-r, --report <output-dir>

De directory waarin het geformatteerde rapport wordt geschreven. Werkt met -f, --format om het uitvoerformaat te bepalen (HTML standaard). Gebruik dit wanneer je een mens- of machineleesbaar 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, gebruik -d, --dir in plaats daarvan.

--rules <list>

Komma-gescheiden lijst van regel-ID's om uit te voeren. Alleen de gespecificeerde regels worden gecontroleerd; alle anderen 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, krijgt het bestand de naam axe-result.json. Om op te slaan in een specifieke directory, gebruik -d, --dir.

--show-errors

Wanneer axe een runtime-fout tegenkomt (zoals een fout bij het initialiseren of een uitzondering die wordt opgeworpen tijdens de uitvoering), wordt normaal gesproken een korte foutmelding naar stderr afgedrukt. Deze vlag voegt de volledige stacktracē toe aan die uitvoer. Het heeft geen effect op de manier waarop toegankelijkheidsschendingen 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 opgegeven 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 de pagina erover deed om te laden in de browser
• axe-core uitvoeringstijd: hoe lang axe-core erover deed om de pagina te analyseren
• Totale testtijd: eind-tot-eind verstreken tijd voor de run

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

--universal-best-practices

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

--universal-ruleset <id>

Geeft de regels die moeten worden vastgelegd in de metadata van de universele formaatoutput. Standaardwaarde 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, breedte en hoogte van het viewport, en schermoriëntatie
• Test kunnen: de naam van de runner

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 beheersen het browsergedrag en de timing van tests. In tegenstelling tot de bovenstaande opties blijven deze tussen CLI-runs bestaan; door ze eenmalig in te stellen 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 Configuratieopties.