De CLI gebruiken om toegankelijkheidsresultaten te verzenden naar axe Developer Hub

This page is not available in the language you requested. You have been redirected to the English version of the page.

Link to this page copied to clipboard

Bespreekt de verschillende manieren waarop u uw toegankelijkheidsresultaten naar axe Developer Hub kunt uploaden met behulp van de CLI

Not for use with personal data

De CLI stelt u in staat om uw toegankelijkheidsresultaten naar axe Developer Hub te sturen. U kunt:

Resultaten uploaden van eerdere testruns naar axe Developer Hub. Deze optie gebruikt de devhub CLI-subcommand en stelt u in staat resultaten te uploaden van het analyseren van webpagina's met behulp van de web-API's of van eerdere CLI-runs (waar u individuele pagina's analyseerde of specificatiebestanden uitvoerde en de resultaten opsloeg).
Individuele pagina's analyseren en resultaten direct naar axe Developer Hub sturen (zonder eerst resultatenbestanden op te slaan).
Specificatiebestanden uitvoeren en resultaten direct naar axe Developer Hub sturen (zonder eerst resultatenbestanden op te slaan).

Vereisten

Om de CLI met axe Developer Hub te gebruiken, heeft u nodig:

Een axe-account en een abonnement voor axe Developer Hub. Zie Aan de slag met axe Developer Hub voor meer informatie.
Een axe Developer Hub-project waarin u resultaten uploadt. Zie Een nieuw axe Developer Hub-project aanmaken voor informatie over het aanmaken van een nieuw project. Wanneer u een project aanmaakt, specificeert u dat het project de CLI als invoer- of gegevensbron zal gebruiken. U heeft deze waarden nodig om resultaten te uploaden:
- Uw persoonlijke API-sleutel (weergegeven in uw axe-account onder API-sleutels)
- Uw project-ID (weergegeven in de instructies wanneer u een nieuw axe Developer Hub-project aanmaakt)
(Optioneel) Als u tests heeft die de web-API's gebruiken, moet u uw tests aanpassen om een resultatenbestand of bestanden te produceren. Een resultatenbestand is een .json-bestand met de resultaten van uw testrun, en de procedure voor het maken van resultatenbestanden verschilt afhankelijk van de API die u gebruikt. Voor meer details, zie Resultatenbestanden maken. U gebruikt het devhub subcommand om resultatenbestanden te uploaden.

Resultaten verzenden naar axe Developer Hub

Normaal gesproken test de CLI websites en produceert alleen resultaten wanneer u de -s optie gebruikt om resultaten op te slaan (wat .json-bestanden zijn die informatie bevatten over toegankelijkheidsfouten in de geteste websites). U kunt uw resultaten naar axe Developer Hub sturen door een API-sleutel op te geven op de opdrachtregel met de --axe-devhub-api-key opdrachtregeloptie (of door de AXE_DEVHUB_API_KEY omgevingsvariabele in te stellen) en een project-ID met de --axe-devhub-project-id (of door de AXE_DEVHUB_PROJECT_ID omgevingsvariabele in te stellen).

Standaard uploadt de CLI ook Git-informatie als de directory waarin u de CLI uitvoert deel uitmaakt van een Git-repository. Zie Git versus Gitless-modus voor informatie over hoe het uploaden van Git-informatie werkt.

De CLI koppelt de huidige Git-branch en commitgeschiedenis aan uw toegankelijkheidsresultaten.

important

Wanneer u de CLI uitvoert vanuit een directory binnen een Git-repository, worden de resultaten die u naar axe Developer Hub stuurt, eerdere resultaten van dezelfde commit (bepaald door de SHA) overschrijven. (Slechts één set resultaten kan worden geassocieerd met elke commit.) U moet elke keer dat u de CLI uitvoert een nieuwe commit maken of het rapporteren van Git-resultaten achterwege laten door de --no-git-data optie te gebruiken. Zie Git versus Gitless-modus voor meer informatie.

Resultaten uploaden

Als u eerder tests heeft uitgevoerd en resultatenbestanden heeft (.json-bestanden gewoonlijk met namen zoals axe-result-2025-09-03T14 02 32-0700.json), kunt u deze resultaten uploaden naar axe Developer Hub met het devhub subcommand. U kunt resultaten opslaan door de -s opdrachtregeloptie te gebruiken bij het testen van pagina's of uitvoeren van specificatiebestanden:

axe https://example.com -s

tip

Bij het analyseren van een pagina of het uitvoeren van een specificatiebestand, hoeft u de resultaten niet eerst op te slaan en vervolgens te uploaden. Door een API-sleutel en project-ID op te geven, zal de CLI de resultaten uploaden zodra uw paginanalyse is voltooid of wanneer uw specificatiebestand klaar is met uitvoeren. Zie Individuele pagina's analyseren en Specificatiebestanden uitvoeren.

Het vorige voorbeeld maakt een resultatenbestand dat u vervolgens kunt uploaden naar axe Developer Hub, zoals hieronder getoond:

axe devhub <results-dir(s)-or-file(s)> --axe-devhub-api-key <your-API-key> --axe-devhub-project-id <your-project-ID>

U kunt . (punt) gebruiken als de resultaten-dir(s)-of-bestand(en) om alle .json resultatenbestanden in de huidige directory te uploaden. U kunt ook meerdere directories of bestanden specificeren om te uploaden.

Resultatenbestanden maken met de web-API's

Als u de web-API's gebruikt, moet u uw API-tests aanpassen om resultatenbestanden te schrijven die u vervolgens kunt uploaden naar axe Developer Hub met behulp van het devhub subcommand. De volgende tabel bevat links naar informatie over het maken van resultatenbestanden, en deze API's gebruiken de rapportage- of log-API's om resultaten als .json-bestanden naar de schijf te schrijven.

API	Linknaam
Node.js	axe DevTools Logger
C#	JSON-compatibele rapporten maken
Java	Rapporten genereren met Java
Python	JSON-compatibele rapporten maken
Ruby	Rapporteeropties

Individuele pagina's analyseren

Je kunt individuele webpagina's scannen en de resultaten naar axe Developer Hub sturen door een API-sleutel en het project-ID op te geven voor het project dat de resultaten moet ontvangen:

axe https://google.com --axe-devhub-api-key <your-API-key> --axe-devhub-project-id <your-project-ID>

In dit voorbeeld voert de CLI toegankelijkheidstests uit op de site van Google en stuurt vervolgens de resultaten naar het axe Developer Hub-project dat wordt verwezen door het opgegeven project-ID.

Je kunt ook meerdere pagina's op de commandoregel opgeven om te testen:

axe https://example.com/page1.html https://example.com/page2.html --axe-devhub-api-key <your-API-key> --axe-devhub-project-id <your-project-ID>

Bezoek het project op axe Developer Hub om je resultaten te bekijken. Zie Overzicht van het bekijken van toegankelijkheidsproblemen.

Spec-bestanden uitvoeren

Je kunt de resultaten van het uitvoeren van je spec-bestanden verzenden met behulp van de --axe-devhub-api-key en --axe-devhub-project-id commandoregelopties.

axe spec my-spec-file.yml --axe-devhub-api-key <your-API-key> --axe-devhub-project-id <your-project-ID>

Dit voorbeeld voert het YAML-spec-bestand my-spec-file.yml uit en uploadt de toegankelijkheidsresultaten naar axe Developer Hub. Zie Workflow Specificaties en Workflow Acties voor meer informatie over spec-bestanden.

tip

Als je in je spec-bestand moet overslaan door testen van pagina's over te slaan, kun je de --resume-from <page> commandoregeloptie gebruiken om je tests te hervatten vanaf een specifieke pagina in je spec-bestand. Zie Hervatten van voor meer informatie.

Git versus Gitless-modus

Standaard koppelt axe Developer Hub je toegankelijkheidsresultaten aan de laatste Git-commit op de huidige branch wanneer je de CLI uitvoert vanuit een directory binnen een Git-repository, waardoor je toegankelijkheidsfouten eenvoudig kunt koppelen aan Git-commits. Een neveneffect van dit gedrag is echter dat wanneer je resultaten rapporteert aan axe Developer Hub, nieuwe resultaten eerdere uitvoeringen overschrijven op dezelfde commit (op basis van de SHA). Bovendien, als je naar een andere branch overschakelt, worden eventuele resultaten die je naar axe Developer Hub stuurt gekoppeld aan de laatste commit op die branch.

Als het standaardgedrag van axe Developer Hub niet is wat je wilt:

Je kunt de CLI in een directory buiten een Git-repository gebruiken.
Je kunt de --no-git-data commandoregeloptie gebruiken om het rapporteren van Git-informatie aan de server over te slaan, werkend in wat wordt genoemd Gitless modus waarin elke keer dat je resultaten naar de server rapporteert, een nieuwe testrun wordt aangemaakt en geïdentificeerd door tijd en datum van de uitvoering in plaats van de branch en commit zoals bij het uitvoeren in Git modus.

Zie De pagina's van je project en De Test Uitvoeringen-pagina voor informatie over hoe Git en Gitless resultaten zijn georganiseerd en gepresenteerd in axe Developer Hub.

Commandoregelopties

De CLI accepteert deze commandoregelopties:

--axe-devhub-api-key Hiermee kun je je persoonlijke API-sleutel instellen, gelijk aan de AXE_DEVHUB_API_KEY omgevingsvariabele. Vereist
--axe-devhub-project-id Stelt het project-ID in voor je axe Developer Hub-project, gelijk aan de AXE_DEVHUB_PROJECT_ID omgevingsvariabele. Vereist
--axe-devhub-server-url Hiermee kun je een andere server dan de standaard gebruiken (https://axe.deque.com), gelijk aan de AXE_DEVHUB_SERVER_URL omgevingsvariabele. Stel dit in als je organisatie een regionale instantie, private cloud of on-premise implementatie van Axe Developer Hub gebruikt. Optioneel
--no-git-data Voorkomt het rapporteren van Git-informatie aan de server. Zie Git versus Gitless-modus voor meer informatie. Heeft geen overeenkomstige omgevingsvariabele. Optioneel

Omgevingsvariabelen

Je kunt omgevingsvariabelen instellen om te voorkomen dat je de API-sleutel, het project-ID of de server-URL op de commandoregel hoeft op te geven, wat wordt aanbevolen bij gebruik van de API-sleutel in continue integratie om deze geheim te houden.

tip

Als je AXE_DEVHUB_API_KEY en AXE_DEVHUB_PROJECT_ID instelt, zullen altijd resultaten naar axe Developer Hub sturen wanneer je een pagina analyseert of een spec-bestand uitvoert. Bijvoorbeeld als je deze omgevingsvariabelen hebt ingesteld en een pagina analyseert met:

axe https://somewebsite.com

De resultaten worden naar axe Developer Hub gestuurd. Dit gedrag is van toepassing wanneer je de CLI gebruikt om een pagina analyseren of een spec-bestand uitvoeren.

AXE_DEVHUB_API_KEY Geeft je persoonlijke API-sleutel aan, gelijk aan de --axe-devhub-api-key commandoregeloptie.
AXE_DEVHUB_PROJECT_ID Geeft het project-ID aan voor je axe Developer Hub-project, gelijk aan de --axe-devhub-project-id commandoregeloptie.
AXE_DEVHUB_SERVER_URL Geeft de Axe Developer Hub server-URL aan (standaard is https://axe.deque.com), gelijk aan de --axe-devhub-server-url commandoregeloptie. Stel dit in als je organisatie een regionale instantie, private cloud of on-premise implementatie van Axe Developer Hub gebruikt.