CLI

Dokumentversion: 20261024

Verfügbar in den Desktop-Apps für macOS und Windows. iOS und Android haben diesen Befehl nicht. Öffnen Sie ApiCatcher, bevor Sie ihn verwenden.

Die CLI lässt eine KI die vorhandenen Funktionen von ApiCatcher aufrufen, zum Beispiel HTTP-Anfragen suchen und auswerten sowie Skripte und Rewrite-Regeln verwalten.

Wo der Befehl liegt

Starten Sie ihn im Terminal des Systems. Unter macOS ist das Terminal, unter Windows die Eingabeaufforderung oder PowerShell.

Unter macOS liegt der Befehl in der installierten App:

/Applications/ApiCatcher.app/Contents/MacOS/apicatcher-cli tools

Liegt ApiCatcher nicht im Ordner Programme, ersetzen Sie /Applications/ApiCatcher.app durch den Ort Ihrer ApiCatcher.app.

Im aktuellen Terminalfenster können Sie einen kurzen Namen vergeben und danach apicatcher eingeben:

alias apicatcher="/Applications/ApiCatcher.app/Contents/MacOS/apicatcher-cli"

Unter Windows öffnen Sie den Ordner, in dem ApiCatcher installiert ist, und starten apicatcher-cli.exe. Üblicher Ort:

%LOCALAPPDATA%\Programs\ApiCatcher\apicatcher-cli.exe tools

Das ApiCatcher-Symbol auf dem Schreibtisch öffnet das Fenster. Das ist nicht dieser Befehl.

Die Beispiele schreiben apicatcher. Verwenden Sie den vollständigen Pfad auf Ihrem Computer.

Die App muss geöffnet sein und CLI eingeschaltet haben

CLI ist standardmäßig aus und belegt keinen Port. So wird der Befehl nutzbar:

1. ApiCatcher öffnen.
2. In der Seitenleiste CLI öffnen und den Schalter einschalten.
3. Beenden Sie die App vollständig und öffnen Sie sie erneut. Dieser Start nimmt Befehle auf diesem Computer an.

Nach dem Ausschalten endet das ebenfalls erst beim nächsten Start.

Der Befehl schlägt fehl, wenn die App geschlossen ist, der Schalter aus ist oder Sie seit der Änderung nicht neu gestartet haben.

Befehle

Werkzeuge und Parameter dieser Version anzeigen. Diese Ausgabe ist das Schema.

apicatcher tools

Ein Werkzeug aufrufen. --args ist ein JSON-Objekt.

apicatcher call search_requests --args '{"host":"api.example.com","limit":10}'

Das Objekt kann auch über die Standardeingabe kommen:

printf '%s' '{"host":"api.example.com"}' | apicatcher call search_requests

Ohne --args und mit einem Terminal als Standardeingabe sind die Argumente {}.

apicatcher call get_capture_status

Ausgabe

Die Standardausgabe ist ein einzelnes JSON-Objekt. ok zeigt, ob der Aufruf gelungen ist. Ist das Werkzeugergebnis JSON, steht es in result. Sonst bleibt result eine Zeichenkette.

{"ok":false,"error":"ApiCatcher is not running"}

Häufige Felder von search_requests: keyword, search_target (url, host, req_header, resp_header, req_body, resp_body), method, host, status_code, file_type, session_id, limit, skip.

Sicherheit

• Der Befehl gilt nur auf diesem Computer. Andere Geräte im Netzwerk erreichen ihn nicht.
• Die Ausgabe ist echter erfasster Traffic und kann Cookies, Tokens und Bodies enthalten. Veröffentlichen Sie sie nicht.