DEV Community

Cover image for Wie man das Apidog CLI in OpenClaw verwendet
Emre Demir
Emre Demir

Posted on • Originally published at apidog.com

Wie man das Apidog CLI in OpenClaw verwendet

OpenClaw arbeitet in einer Schleife: Es liest deinen Workspace, führt Shell-Befehle über das exec-Tool aus, wertet die Ausgabe aus und entscheidet dann über den nächsten Schritt. API-Tests bleiben häufig außerhalb dieser Schleife, weil sie nur in der Apidog-GUI ausgeführt werden. Mit der Apidog CLI kann OpenClaw Testszenarien wie Unit-Tests behandeln: Befehl ausführen, Exit-Code prüfen und bei Fehlern gezielt nachbessern.

Apidog noch heute ausprobieren

Die technische Grundlage ist klein: apidog-cli ist ein npm-Paket, das in Apidog konfigurierte Testszenarien im Terminal ausführt. Sobald die CLI installiert ist und OpenClaw die Anweisung kennt, kann der Agent API-Tests in seine Bearbeiten-Test-Korrigieren-Schleife aufnehmen.

Dieser Leitfaden zeigt den OpenClaw-spezifischen Teil:

  • wo die Anweisung für den Agenten abgelegt wird,
  • wie OpenClaw apidog run über exec ausführt,
  • wie du Exit-Code und Reporter-Ausgabe als Test-Gate verwendest.

Falls die CLI noch nicht installiert ist, erledige das zuerst. Der Leitfaden Apidog CLI mit einem KI-Code-Agenten installieren behandelt Installation, Authentifizierung und den ersten Lauf. Dieser Artikel setzt voraus, dass der folgende Befehl eine Versionsnummer ausgibt und du angemeldet bist:

apidog --version
Enter fullscreen mode Exit fullscreen mode

Um welches OpenClaw es hier geht

OpenClaw ist ein lokaler Open-Source-KI-Agent mit Workspace, Fähigkeiten und einem exec-Tool für echte Shell-Befehle. Es ist weder ein Code-Vervollständigungs-Plugin noch ein gehosteter Chatbot.

Wenn du OpenClaw lokal ausführst und es Dateien bearbeiten sowie Befehle starten lässt, passt dieser Ablauf zu deinem Setup. Für die grundlegende Einrichtung lies vorher:

Der entscheidende Mechanismus ist AGENTS.md. OpenClaw lädt diese Workspace-Regeln in den Agentenkontext. Dadurch wird aus einer einmaligen Chat-Anweisung eine wiederverwendbare Projektregel.

Schritt 1: Apidog-Regeln in AGENTS.md hinterlegen

Lege die Regeln in der AGENTS.md des aktiven OpenClaw-Workspaces ab. Standardmäßig liegt der Workspace unter:

~/.openclaw/workspace
Enter fullscreen mode Exit fullscreen mode

Du kannst mit agents.list[].workspace aber auch direkt auf ein Projektverzeichnis zeigen. Außerdem unterstützt OpenClaw bereichsbezogene AGENTS.md-Dateien in Unterverzeichnissen. Details stehen in der OpenClaw-Referenz zu AGENTS.md.

Füge diesen Block in die passende AGENTS.md ein und ersetze die Platzhalter durch deine tatsächlichen IDs:

## API-Tests mit Apidog

- Führe API-Tests mit der Apidog CLI aus:
  `apidog run -t <scenario_id> -e <env_id> -r cli`.
- Exit-Code 0 bedeutet: Alle Assertions sind erfolgreich.
  Jeder Exit-Code ungleich 0 bedeutet: Der Test ist fehlgeschlagen.
  Behandle den Exit-Code als verbindliches Pass/Fail-Gate.
- Die Maschine ist bereits über `apidog login` authentifiziert.
  Füge niemals `--access-token` hinzu und speichere keine Tokens in dieser Datei.
- Wenn ein Flag unklar ist, führe `apidog run --help` aus, statt ein Flag zu erraten.
Enter fullscreen mode Exit fullscreen mode

Warum gehört das in AGENTS.md und nicht nur in den Chat?

  • Chat-Kontext kann nach einer Sitzung verschwinden.
  • AGENTS.md bleibt für künftige OpenClaw-Läufe erhalten.
  • Teammitglieder arbeiten mit derselben Testregel.
  • Der Agent kennt Szenario, Umgebung und Erfolgskriterium direkt beim Start.

Schritt 2: Den exakten Befehl aus Apidog kopieren

Schreibe Szenario- und Umgebungs-ID nicht manuell ab. Öffne das Testszenario in Apidog, wechsle zum Tab CI/CD und kopiere den generierten Befehl.

Er sieht beispielsweise so aus:

apidog run -t 1234567 -e 890123 -r cli
Enter fullscreen mode Exit fullscreen mode

Die Parameter bedeuten:

Flag Bedeutung
-t ID des Testszenarios
-e ID der Zielumgebung
-r cli Ausgabe als Terminal-Reporter

Übernimm den kopierten Befehl beziehungsweise die echten IDs in deine AGENTS.md. So führt OpenClaw immer das richtige Szenario gegen die gewünschte Umgebung aus.

Weitere Optionen findest du im vollständigen Apidog CLI-Leitfaden und in der Referenz für apidog run.

Schritt 3: OpenClaw den API-Test ausführen lassen

Starte OpenClaw im Projekt-Workspace und bearbeite Code, der die API betrifft. Du kannst den Agenten auch explizit auffordern, die API-Prüfung auszuführen.

Da die Anweisung bereits in AGENTS.md liegt, kann OpenClaw den Test über sein exec-Tool starten:

apidog run -t 1234567 -e 890123 -r cli
Enter fullscreen mode Exit fullscreen mode

Das exec-Tool unterliegt OpenClaw-Berechtigungen. Die verfügbaren Modi sind:

  • deny
  • allowlist
  • ask
  • auto
  • full

Sie sind auf der OpenClaw-Seite zu Berechtigungsmodi dokumentiert.

Für diesen Workflow ist auto in der Regel sinnvoll:

  • Befehle auf der Zulassungsliste laufen ohne Rückfrage.
  • Andere Befehle werden vor der Ausführung geprüft.
  • Ein schreibgeschützter Test gegen Staging kann automatisiert laufen.

Lege den Modus unter tools.exec in openclaw.json fest. Mit ask pausiert OpenClaw vor apidog run, bis du den Befehl genehmigst. Alternativ kannst du apidog zur Zulassungsliste hinzufügen.

Schritt 4: CLI-Ausgabe und Exit-Code auswerten

Der Reporter -r cli gibt die für OpenClaw relevante Ausgabe direkt im Terminal aus:

  • ausgeführte Requests,
  • Assertions,
  • erwartete und tatsächliche Werte,
  • fehlgeschlagene Prüfschritte.

Lass cli deshalb im Befehl stehen. Der Agent kann damit erkennen, welche Assertion fehlgeschlagen ist und welche Korrektur nötig sein könnte.

Für einen zusätzlich im Browser lesbaren Bericht verwende den HTML-Reporter zusammen mit cli:

apidog run -t 1234567 -e 890123 -r cli,html
Enter fullscreen mode Exit fullscreen mode

Der html-Reporter schreibt einen eigenständigen Bericht nach:

./apidog-reports
Enter fullscreen mode Exit fullscreen mode

cli bleibt wichtig, damit OpenClaw die direkte Terminalausgabe erhält. Informationen zu JUnit und weiteren Reportern findest du im Leitfaden zu Apidog CLI-Testberichten.

API-Tests in OpenClaws Arbeits-Schleife integrieren

Nach der Einrichtung kann die Schleife so aussehen:

  1. OpenClaw bearbeitet beispielsweise einen Checkout-Handler.
  2. OpenClaw führt das Apidog-Szenario gegen Staging aus.
  3. OpenClaw prüft Ausgabe und Exit-Code.
  4. Bei Exit-Code 0 arbeitet der Agent weiter.
  5. Bei einem Exit-Code ungleich 0 liest der Agent die fehlgeschlagene Assertion.
  6. OpenClaw korrigiert den Code und führt den Test erneut aus.

Damit wird der API-Test Teil derselben Bearbeiten-Test-Korrigieren-Schleife wie Unit-Tests.

Das ist ein Delegieren-und-Verifizieren-Modell:

  • Du erstellst und pflegst Testszenarien visuell in Apidog.
  • OpenClaw führt sie über die CLI aus.
  • Der Exit-Code entscheidet objektiv über Erfolg oder Fehler.
  • Du prüfst stichprobenartig, ob der Agent Befehle und Ergebnisse korrekt verarbeitet.

Weiterführend:

Prüfen, ob OpenClaw die CLI wirklich ausgeführt hat

Verlasse dich nicht ausschließlich auf die Zusammenfassung des Agenten. Prüfe diese drei Punkte.

1. Tatsächlich ausgeführten exec-Befehl prüfen

Das OpenClaw-Transkript zeigt die ausgeführten exec-Befehle samt Ausgabe. Suche nach einer Zeile wie:

apidog run -t 1234567 -e 890123 -r cli
Enter fullscreen mode Exit fullscreen mode

Darunter sollte die tatsächliche CLI-Ausgabe stehen.

Wenn OpenClaw behauptet, die Tests ausgeführt zu haben, der Befehl im Transkript aber fehlt, wurde der Lauf nicht verifiziert. Fordere den Agenten auf, den Test erneut zu starten und die Rohausgabe anzuzeigen.

2. Exit-Code direkt abfragen

Frage nach einem Lauf explizit:

What was the exit code of that apidog run command?
Enter fullscreen mode Exit fullscreen mode

apidog run beendet sich mit:

  • 0, wenn alle Assertions erfolgreich sind,
  • einem Wert ungleich 0, wenn mindestens eine Prüfung fehlschlägt.

Der Exit-Code ist das maßgebliche Test-Gate. Wenn eine Zusammenfassung „Tests bestanden“ meldet, der Exit-Code aber ungleich 0 ist, gilt der Exit-Code.

3. Szenario- und Umgebungs-ID kontrollieren

Bei einer Meldung wie „Szenario nicht gefunden“ könnte OpenClaw eine ID falsch übernommen oder erfunden haben.

Vergleiche dann:

  1. die Werte hinter -t und -e in AGENTS.md,
  2. den im Apidog-CI/CD-Tab generierten Befehl,
  3. den tatsächlich im OpenClaw-Transkript ausgeführten Befehl.

Die IDs in deiner AGENTS.md sollten mit dem von Apidog generierten Befehl übereinstimmen.

Optional: Apidog MCP-Server anbinden

apidog run über exec reicht für die Testausführung aus. Mit dem Model Context Protocol (MCP) kann OpenClaw zusätzlich API-Spezifikationen während der Implementierung lesen.

OpenClaw unterstützt MCP-Server. Du kannst einen Server beispielsweise mit diesem Muster hinzufügen:

openclaw mcp add <name>
Enter fullscreen mode Exit fullscreen mode

Die Serverdefinition landet unter mcp.servers in:

~/.openclaw/openclaw.json
Enter fullscreen mode Exit fullscreen mode

Der Befehl unterstützt stdio-Optionen wie --command und --arg. Siehe dazu die OpenClaw-MCP-Dokumentation.

Der Apidog MCP-Server stellt API-Spezifikationen über MCP bereit. Die Aufgabenteilung bleibt klar:

  • Apidog CLI: führt Tests aus.
  • MCP: liefert dem Agenten Spezifikations- und Schema-Kontext.

Häufige Fehler beheben

OpenClaw ignoriert den AGENTS.md-Block

Wenn OpenClaw einen generischen Befehl verwendet oder gar keinen Test startet:

  1. Prüfe, ob die Regel in der AGENTS.md des aktiven Workspaces liegt.
  2. Prüfe bei Unterverzeichnissen, ob eine bereichsbezogene AGENTS.md die Regel überschreibt oder die falsche Datei geladen wird.
  3. Starte die OpenClaw-Sitzung neu, damit die Workspace-Dateien erneut eingelesen werden.

exec ist blockiert

Wenn OpenClaw den Befehl nicht ausführt, prüfe tools.exec in openclaw.json.

Mögliche Lösungen:

  • Berechtigungsmodus auf auto setzen.
  • apidog zur Zulassungsliste hinzufügen.
  • Den Befehl im Modus ask einmal explizit freigeben.

Der Leitfaden zur sicheren OpenClaw-Installation zeigt, wie du gezielt Befehle freigibst, ohne uneingeschränkte Berechtigungen zu vergeben.

OpenClaw fügt --access-token hinzu

Wenn der Agent ein Zugriffstoken als Flag übergeben möchte, orientiert er sich vermutlich an einem öffentlichen Beispiel. Deine AGENTS.md sollte ausdrücklich festlegen:

Die Maschine ist über `apidog login` authentifiziert.
Niemals `--access-token` verwenden.
Niemals Tokens in `AGENTS.md` speichern.
Enter fullscreen mode Exit fullscreen mode

Lege keinen echten Token in Projektregeln ab. Das korrekte Muster beschreibt der Leitfaden zur Apidog CLI-Authentifizierung.

OpenClaw erfindet ein Flag

Bei Fehlern wie „unbekannte Option“ soll der Agent nicht weiter raten. Führe stattdessen aus:

apidog run --help
Enter fullscreen mode Exit fullscreen mode

Übernimm das benötigte Flag aus der Hilfe deiner installierten CLI-Version.

OpenClaw meldet Erfolg trotz fehlgeschlagenem Lauf

Das ist der kritischste Fehler. Stelle sicher, dass diese Regel in AGENTS.md steht:

Ein Exit-Code ungleich 0 ist immer ein fehlgeschlagener Testlauf,
auch wenn eine textuelle Zusammenfassung etwas anderes behauptet.
Enter fullscreen mode Exit fullscreen mode

Dasselbe Prinzip gilt für andere Coding-Agenten. Vergleichbare Workflows findest du in Apidog CLI in Codex sowie im Vergleich Claude Code vs. OpenClaw.

Vom täglichen Agenten zur getesteten Schleife

Die Einrichtung besteht aus vier Schritten:

  1. apidog-cli gemäß Installationsleitfaden installieren.
  2. Den generierten apidog run-Befehl in die Workspace-AGENTS.md übernehmen.
  3. tools.exec so konfigurieren, dass OpenClaw den Befehl ausführen darf.
  4. Den Exit-Code als verbindliches Test-Gate behandeln.

Danach kann OpenClaw API-Tests während der Implementierung ausführen, statt Fehler erst nach dem Ausliefern zu entdecken.

Du erstellst Szenarien weiterhin visuell in Apidog. OpenClaw führt sie im Workspace aus, sobald die Projektregeln es verlangen. Lade Apidog herunter, erstelle ein Szenario, kopiere den Befehl in AGENTS.md und prüfe den nächsten Lauf im OpenClaw-Transkript.

Für dieselbe Exit-Code-Prüfung in einer CI-Pipeline ohne aktiven Agenten siehe Apidog CLI in GitHub Actions.

Top comments (0)