Entwicklerdokumentation

CLI-Befehle und Konfiguration

Nutze die CLI für API-Schemas, JSON-Anfragen, Browseranmeldung und MCP-Konfiguration.

Vom SosoAPI-Team geprüft · 2026-10-21

Befehle

Prüfe unter --help die von deiner Version unterstützten Optionen. Ohne Argumente startet sosoapi den MCP-stdio-Server. Führe die folgenden Befehle einzeln aus; sie sind keine Shell-Pipeline.

npx sosoapi --help
npx sosoapi auth login
npx sosoapi auth login --no-open
npx sosoapi auth status
npx sosoapi auth refresh
npx sosoapi auth logout

npx sosoapi connect threads
npx sosoapi connect instagram --no-open

npx sosoapi api contract --summary
npx sosoapi api contract --route /studio-api/scheduled-posts/
npx sosoapi api contract

Authentifizierung und Berechtigungen

API-Route mit JSON-stdin aufrufen

Nutze api post für Routen der öffentlichen CLI-Freigabeliste, auch für Lesezugriffe per HTTP POST. Speichere den Anfrageinhalt mit einem Dateieditor in request.json, damit die Shell Kundentext nicht interpretiert. Prüfe http_status und Antwortinhalt; Exit-Code null allein belegt keinen API-Erfolg.

Dieses Beispiel liest Workspace-Kontext. Prüfe vor einem Schreibvorgang das Operationsschema und bestätige das autorisierte Ziel. Speichere die zurückgegebene ID und prüfe das Ergebnis, bevor du eine Anfrage nach Timeout wiederholst.

{}

npx sosoapi api post /identity-api/workspace/list < request.json

Vollständige API-Referenz

Umgebungsvariablen

Setze diese Variablen für den Prozess, der deinen MCP-Server ausführt. Optionale Telemetrie enthält keine Argumente, Prompts, Ergebnisse oder Dateipfade; setze SOSOAPI_TELEMETRY=0 zum Deaktivieren. Eine eigene API-Adresse erfordert ausdrückliche Zustimmung; die CLI sendet VICKY_API_KEY nicht an diese Adresse.

CLI-Umgebung
Variable	Wirkung
SOSOAPI_TOOL_PROFILE=core	Alltagstools; Standard ist full. Erteilt keine Berechtigungen.
SOSOAPI_OUTPUT_SCHEMAS=1	Ausgabeschemas in tools/list einfügen; Ergebnisse sind in beiden Fällen strukturiert.
SOSOAPI_UPLOAD_ROOTS	Zusätzliche lokale Medienverzeichnisse, getrennt durch : (; unter Windows).
SOSOAPI_TELEMETRY=0	Optionale Nutzungsberichte deaktivieren.
SOSOAPI_DEBUG=1	CLI-Fehler-Stacktraces ausgeben; vor dem Teilen prüfen und redigieren.
VICKY_API_KEY	Persönliches Zugriffstoken für Skripte/CI; für Agenten bevorzugt OAuth.
VICKY_API_BASE_URL	Eigene HTTPS-API-Basis (localhost darf HTTP nutzen); benötigt auch SOSOAPI_ALLOW_CUSTOM_BASE_URL=1.

Nicht vertrauenswürdige Inhalte behandeln

Kommentare und Nutzernamen können Anweisungen anderer Personen enthalten. Bei erfassten Antworten ergänzt die CLI die Kennzeichnungen untrusted_content und untrusted_notice sowie eine Warnung auf stderr. Sie bereinigt und kürzt Inhalte ebenfalls; dein Agent muss sie dennoch als Daten behandeln, nicht als Handlungsbefugnis.