Die CLI ist eine öffentliche Vorschau (Version 0.x). Die Befehlsnamen folgen der API und können sich vor 1.0 noch ändern. Ein umbenannter Befehl funktioniert noch mindestens eine Minor-Version lang weiter.
Voraussetzungen
- Node.js 22 oder neuer.
- Ein Workspace-Plan mit API Access. Das ist dieselbe Voraussetzung wie für die REST-API.
- Ein API-Key aus Settings → API & MCP.
Schnellstart
1
Installieren
2
Anmelden
Erstelle unter Settings → API & MCP einen API-Key und führe dann Folgendes aus:Füge den Key ein, sobald du danach gefragt wirst. Die Eingabe bleibt verborgen, und der Key wird im Schlüsselbund deines Systems gespeichert.
3
Erste Befehle ausführen
So funktionieren Befehle
Jede Operation in der API-Referenz ist ein Befehl. Der Befehlsname ist die Operation-ID in Kebab-Case: Aus Start an outbound call (createCall) wird famulor create-call.
- Pfadparameter sind Argumente:
famulor get-assistant <id>. - Query-Parameter und Felder des Request-Bodys sind Optionen in Kebab-Case: Aus
assistant_idwird--assistant-id. - Optionen sind typisiert und werden geprüft, bevor etwas gesendet wird: Zahlen müssen Zahlen sein, Auswahlwerte müssen zu den erlaubten Werten gehören, und Pflichtfelder müssen vorhanden sein.
Mehr erfahren
Anmeldung und Workspaces
Speicherung im Schlüsselbund, Keys für CI, ein Profil pro Workspace und White-Label-Domains.
Befehle und Ausgabe
Request-Bodys, Datei-Uploads, Tabellen, JSON Lines, Pagination und Downloads.
Skripte, CI und Coding-Agenten
Sichere Automatisierung, Exit-Codes,
jq-Pipelines und das Befehlsschema für Agenten.Referenz
Globale Optionen, Umgebungsvariablen, Exit-Codes und Fehlerbehebung.