Skip to main content
Die CLI signiert Anfragen mit einem Workspace-API-Key, also denselben Zugangsdaten, die auch die REST-API verwendet. Erstelle einen Key im Dashboard unter Settings → API & MCP. Der vollständige Key wird nur einmal angezeigt.

​
Anmelden

Die CLI bietet an, die Einstellungsseite in deinem Browser zu öffnen, und fragt dann nach dem Key. Die Eingabe bleibt verborgen. Bevor etwas gespeichert wird, prüft die CLI den Key bei der API. Ein vertippter oder widerrufener Key wird also nie gespeichert. Nach einer erfolgreichen Anmeldung siehst du den Workspace, den Key-Namen und seine Scopes. Der Key wird im Schlüsselbund deines Systems gespeichert: Ist kein Schlüsselbund verfügbar, verwendet die CLI eine Datei in ~/.config/famulor, auf die nur dein Benutzerkonto zugreifen kann, und weist darauf hin.
Die Abmeldung entfernt den Key nur von deinem Computer. Um den Key selbst ungültig zu machen, widerrufe ihn unter Settings → API & MCP.

​
CI und Skripte

Setze in Pipelines FAMULOR_API_KEY aus deinem Secret-Speicher. Die Variable hat Vorrang vor jeder gespeicherten Anmeldung, und es wird nichts auf die Festplatte geschrieben:
Um einen Key ohne interaktive Abfrage und ohne Eintrag in deiner Shell-History zu speichern, übergib ihn per Pipe:

​
Mehrere Workspaces

Ein API-Key gehört zu genau einem Workspace. Speichere für jeden Workspace ein Profil und wechsle zwischen ihnen:
FAMULOR_PROFILE wählt ein Profil für eine ganze Shell-Sitzung aus.

​
White-Label-Domains

Nutzt du Famulor unter deiner eigenen Domain, meldest du dich einmal über diese Domain an. Das Profil merkt sie sich, und jeder Befehl verwendet sie ab dann:
API-Pfade, Keys und Scopes sind auf jeder Domain dieselben.

​
Einrichtung prüfen

famulor doctor prüft deine Node.js-Version, die gespeicherte Anmeldung, den Host, die Netzwerkverbindung und API Access in einem Durchgang und sagt dir, was zu beheben ist: