Ihr API-Arbeitsbereich befindet sich in einer grafischen Benutzeroberfläche (GUI). Ihr Arbeitsalltag findet in einem Terminal statt. Jeder Kontextwechsel zwischen diesen beiden kostet Sekunden und Konzentration, und in einer CI-Pipeline oder einer KI-Agenten-Sitzung ist die GUI nicht einmal eine Option. Die Apidog CLI schließt diese Lücke: Sie bringt die gesamte Apidog-Plattform, Tests, Endpunkte, Schemas, Umgebungen, Mock-Erwartungen und Dokumente in die bereits geöffnete Shell-Eingabeaufforderung.
Zuerst eine ehrliche Definition. Die Apidog CLI ist kein weiteres curl. Wenn Sie einen einmaligen GET-Request absetzen und das JSON visuell überprüfen möchten, erledigen curl und HTTPie das bereits gut, und die Übersicht über die Terminal- und TUI-REST-Clients deckt die interaktive Seite ab. Die Apidog CLI ist ein Client für Ihren API-Arbeitsbereich selbst: Sie führt die von Ihnen erstellten Testszenarien aus, liest und aktualisiert den API-Vertrag und verschiebt Spezifikationen in und aus dem Projekt, alles über Befehle, die ein Skript oder ein Agent aufrufen kann.
Was „in Ihrem Terminal lebt“ hier bedeutet
Terminal-HTTP-Tools bearbeiten jeweils eine Anfrage. Die Apidog CLI arbeitet auf Projektebene. Ihre Befehlsoberfläche umfasst mehr als vierzig Gruppen, die sich in fünf Aufgabenbereiche gliedern:
| Aufgabe | Befehle |
|---|---|
| Tests ausführen | run, test-scenario, test-suite, test-case, test-data, test-report |
| Vertrag verwalten | endpoint, schema, folder, common-parameter, response-component, security-scheme |
| Dokumente und Mocks bereitstellen | doc, docs-site, shared-doc, mock |
| Konfigurieren und Verbinden | environment, variables, vault, database-connection, websocket, socketio |
| Als Team arbeiten | branch, merge-request, runner, scheduled-task, audit-log, import, export |
Jeder Befehl unterstützt `--help`, die Ausgabe ist strukturiertes JSON, und die meisten Antworten enthalten `agentHints.nextSteps`, die Ihnen (oder Ihrem Agenten) mitteilen, was als Nächstes auszuführen ist. Dieses letzte Detail klingt klein. Es ändert jedoch das Gefühl des Tools: Die CLI führt den Workflow, anstatt davon auszugehen, dass Sie ihn auswendig gelernt haben.
In einem einzigen Befehl installieren
Die CLI wird als npm-Paket (apidog-cli) ausgeliefert und läuft unter macOS, Linux und Windows. Es benötigt Node.js 16 oder neuer.
npm install -g apidog-cli
apidog --version
Melden Sie sich dann mit einem API-Zugriffstoken an. Holen Sie es sich aus der Apidog-App: Klicken Sie auf Ihr Avatar, öffnen Sie die Kontoeinstellungen und kopieren Sie das Token unter API Access Token.
apidog login --with-token <YOUR_TOKEN>
Das Token landet in `~/.apidog/config.toml`, bewahren Sie es also außerhalb Ihrer Repos und Logs auf; in CI übergeben Sie es stattdessen pro Lauf mit `--access-token` aus einem Geheimnis. Vier globale Flags decken die meisten Kontexte ab: `--project` wählt das Projekt, `--branch` wählt den Branch, `--access-token` überschreibt die gespeicherte Anmeldung, und `--api-base-url` verweist die CLI auf eine selbst gehostete Apidog-Bereitstellung. Der Apidog CLI Authentifizierungsleitfaden erläutert die Tokens für CI detailliert.
Führen Sie die visuell erstellten Tests aus
Hier ist der Workflow, um den die CLI entwickelt wurde. Sie erstellen ein Testszenario in Apidogs visuellem Editor: verkettete Anfragen, Variablen, die aus einer Antwort extrahiert und in die nächste injiziert werden, Zusicherungen für Status und Body. Dann führen Sie es überall aus, wo eine Shell vorhanden ist.
# Kopieren Sie diesen Befehl, inklusive IDs, aus dem CI/CD-Tab des Szenarios
apidog run -t <scenario_id> -e <env_id> -r cli
Der Befehl beendet sich mit `0`, wenn alle Zusicherungen erfolgreich sind, und mit einem anderen Wert als Null, wenn etwas fehlschlägt, sodass eine Pipeline ohne zusätzlichen Aufwand darauf aufbauen kann. Tauschen Sie `-e` aus, um dasselbe Szenario auf Entwicklungs-, Staging- oder Produktionsumgebungen zu richten. Füttern Sie es mit einer CSV- oder JSON-Datei, und es durchläuft das Szenario für jede Zeile, so funktioniert datengesteuertes Testen ohne Duplizierung von Schritten. Wenn Sie bei Null anfangen, führt Sie die Schritt-für-Schritt-Anleitung für die REST API von der Installation bis zum ersten erfolgreichen Lauf.
Berichte werden in vier Formaten ausgegeben: `cli` druckt Schritt-für-Schritt-Ergebnisse ins Terminal, während `html`, `json` und `junit` in `apidog-reports/` für Dashboards und CI-Artefakte landen. Kombinieren Sie sie beliebig, wie in `-r cli,junit`. Der Leitfaden für Testberichte zeigt, wie jedes Format aussieht.
Für Läufe, die nicht von Ihrem Laptop abhängen sollen, verwalten die Befehle `runner` und `scheduled-task` selbst gehostete Runner und zeitgesteuerte Ausführungen, dieselbe Maschinerie, die auch hinter geplanten API-Tests in Apidog steckt.
Den API-Vertrag verwalten, ohne die App zu öffnen
Dies ist der Teil, den kein anderes Terminal-Testtool bietet. Dieselbe CLI, die Ihre Tests ausführt, kann die API-Definition selbst lesen und schreiben:
apidog endpoint list --project <project_id>
apidog schema get <schema_id>
apidog environment list
apidog mock list
Endpunkte, Datenschemata, Ordner, Umgebungen, Variablen, Sicherheitsschemata und wiederverwendbare Komponenten sind alle abfragbar und bearbeitbar. Der Befehl `mock` verwaltet Mock-Erwartungen, die festen Anforderungs- und Antwortpaare, die Ihr Mock-Server zurückgibt. Die Befehle `doc` und `docs-site` betreffen die veröffentlichte Dokumentation. WebSocket- und Socket.IO-Endpunkte haben ihre eigenen Gruppen, und `database-connection` deckt die Datenbankkonfigurationen ab, die Ihre Testszenarien lesen.
Import und Export unterstützen die wichtigen Formate: OpenAPI 3.x und Swagger 2.0 (die Spezifikation, auf die sich die meisten Toolchains standardisieren), plus Postman Collections. Das macht die CLI zu einer Brücke in Migrationsskripten: Ziehen Sie eine Spezifikation aus einem System, verschieben Sie sie in Apidog und versionieren Sie den gesamten Austausch.
apidog import openapi.json --project <project_id>
apidog export --format openapi
So gebaut, dass KI-Agenten sie steuern können
Die 2026er-Versionen der CLI konzentrieren sich stark auf eine Idee: Ein KI-Code-Agent sollte in der Lage sein, Ihren API-Arbeitsbereich so sicher wie ein Mensch zu bedienen. Vier Punkte ermöglichen dies.
Erstens, strukturierte Ausgabe. Jeder Befehl gibt JSON zurück, das ein Agent parsen kann, und `agentHints.nextSteps` teilt ihm mit, was nach jedem Ergebnis zu tun ist, einschließlich der Wiederherstellung von Fehlern.
Zweitens, ein veröffentlichtes Eingabeschema. `apidog cli-schema list` und `apidog cli-schema get` legen die exakte JSON-Struktur offen, die jeder Schreibbefehl erwartet, und `apidog cli-schema validate` prüft eine Nutzlast, bevor etwas das Projekt berührt. Das sichere Schreibritual ist immer dasselbe: Schema abrufen, JSON generieren, validieren und erst dann `create` oder `update` ausführen.
Drittens, eine gebündelte Fähigkeit. Der `skill`-Befehl liefert das Betriebswissen der CLI in einer Form aus, die Agenten direkt laden können, was die Geschichte hinter der Entwicklung der Apidog CLI Skill ist. In unseren eigenen Messungen nutzten Agenten, die mit dem CLI-Schema arbeiteten, etwa 30 % weniger Tool-Aufrufe und 25 % weniger Tokens als Agenten, die Nutzlasten erraten haben; die Zahlen sind in dieser Analyse aufgeschlüsselt.
Viertens, Berechtigungsschranken. Standardmäßig sind von KI stammende Schreibzugriffe auf einen Branch blockiert, bis ein Mensch die "External AI Edit Permissions" (in Apidog Client 2.8.32 oder neuer, unter Projekt-Einstellungen, Feature-Einstellungen, KI-Feature-Einstellungen) aktiviert. Die Alternative ist ein KI-Branch: ein isolierter Branch, in dem ein Agent die benötigten Ressourcen importiert, seine Änderungen vornimmt und das Ergebnis als Merge-Request zur Überprüfung zurückgibt. Unberührte KI-Branches werden nach 24 Stunden automatisch archiviert, sodass sich Experimente nicht ansammeln. Ihr API-Vertrag bleibt überprüfbar, auch wenn ein Agent den ersten Entwurf schreibt.
Was die Apidog CLI nicht ist
Drei Einschränkungen, klar dargelegt, denn die Auswahl von Tools auf der Grundlage ehrlicher Informationen ist besser, als die Lücken später zu entdecken.
Es ist kein interaktiver Request-Client. Es gibt keinen Befehl, der einen Ad-hoc-POST-Request eingibt und die Antwort schön formatiert ausgibt; curl, HTTPie und die TUI-Clients übernehmen diese Aufgabe, und sie sind darin besser.
Es ist nicht Open Source. Das Paket ist proprietär, npm ist der einzige Installationskanal, und alles, was über `--help` hinausgeht, erfordert ein Apidog-Konto. Der kostenlose Tarif deckt den hier beschriebenen gesamten Workflow ab, aber wenn eine auditierbare Lizenz eine zwingende Anforderung ist, ist ein Open-Source-Runner die ehrliche Empfehlung.
Es ist nicht eigenständig. Die CLI ist der Terminal-Arm der Plattform: Szenarien, Endpunkte und Umgebungen leben in Ihrem Apidog-Projekt, nicht in lokalen Dateien. Das ist der Kompromiss, der Ihnen eine einzige Quelle der Wahrheit über Design, Tests, Mocking und Dokumentation hinweg sichert.
Wo es in die Terminal-Toolbox passt
Im Vergleich zu anderen Runnern liegt der Unterschied darin, wo die Erstellung stattfindet. Newman und die Postman CLI führen in Postman erstellte Collections aus; Hurl und Bruno führen als Textdateien erstellte Tests aus; die Apidog CLI führt Szenarien aus, die in einem visuellen Editor erstellt wurden, der auch Ihren Vertrag, Mocks und Dokumentationen enthält. Der Vergleich Apidog CLI vs. Newman geht tiefer, und das gesamte Feld ist in der Übersicht der Top-Terminal-basierten API-Testtools aufgeführt.
Ein funktionierendes Setup für die meisten Teams: Behalten Sie curl oder xh im Gedächtnis für schnelle Anfragen, und lassen Sie `apidog run` die Suiten in CI ausführen. Die GitHub Actions Anleitung bietet eine Copy-Paste-Pipeline zum Starten.
FAQ
Ist die Apidog CLI kostenlos nutzbar? Ja. Das Paket lässt sich kostenlos über npm installieren, und der kostenlose Tarif von Apidog deckt das Erstellen von Szenarien und deren Ausführung über die CLI ab. Kostenpflichtige Pläne bieten Funktionen für Teamgrößen, nicht den grundlegenden CLI-Zugriff.
Ersetzt es curl oder HTTPie? Nein, und das versucht es auch nicht. Diese Tools senden Ad-hoc-Anfragen; die Apidog CLI führt gespeicherte Testszenarien aus und verwaltet Projektressourcen. Die meisten Terminals verwenden letztendlich beides.
Kann es vollständig headless in CI ausgeführt werden? Ja. Authentifizieren Sie sich mit `--access-token` aus einem CI-Secret, führen Sie `apidog run` mit Ihrer Szenario-ID aus und steuern Sie den Build anhand des Exit-Codes. Auf dem Runner ist keine Desktop-App erforderlich.
Welche Formate kann es importieren und exportieren? OpenAPI 3.x, Swagger 2.0 und Postman Collections, in beide Richtungen. Das deckt Migrationen hinein und Integrationen heraus ab.
Wie nutzen KI-Agenten es sicher? Durch das Schema-Validierungs-Schreibritual und Berechtigungsschranken: `cli-schema validate` fängt fehlerhafte Nutzlasten ab, bevor sie landen, und KI-Branches halten Agenten-Bearbeitungen isoliert, bis ein Mensch sie zusammenführt. Sehen Sie es in Aktion innerhalb eines Agenten in wie man die Apidog CLI in Claude Code verwendet.
Das Terminal ist der Ort, an dem Ihre Tests bereits laufen und Ihre Agenten bereits arbeiten. Den API-Client auch dort zu platzieren, eliminiert den letzten Kontextwechsel. Laden Sie Apidog herunter, installieren Sie die CLI über npm und führen Sie ein Szenario Ende-zu-Ende aus; die Apidog CLI-Seite enthält die vollständige Befehlsreferenz, wenn Sie bereit sind, über `run` hinauszugehen.