> ## Documentation Index
> Fetch the complete documentation index at: https://docs.famulor.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Famulor CLI

> Dein gesamter Famulor-Workspace im Terminal: jede API-Operation als Befehl

Die Famulor CLI bringt die gesamte REST-API in dein Terminal. Erstelle Assistenten, starte Anrufe, führe Kampagnen aus, verwalte Leads und Telefonnummern und lies die Anrufhistorie, alles mit einem Tool. Alles, was du über die API erledigen kannst, lässt sich skripten, in CI ausführen oder einem Coding-Agenten überlassen.

```bash theme={null}
npm install --global famulor
famulor auth login
famulor list-assistants --output table
```

<Note>
  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.
</Note>

## Voraussetzungen

* **Node.js 22** oder neuer.
* Ein Workspace-Plan mit **API Access**. Das ist dieselbe Voraussetzung wie für die [REST-API](/de/api-reference/introduction#api-access).
* Ein API-Key aus **Settings → API & MCP**.

## Schnellstart

<Steps>
  <Step title="Installieren">
    ```bash theme={null}
    npm install --global famulor
    ```
  </Step>

  <Step title="Anmelden">
    Erstelle unter **Settings → API & MCP** einen API-Key und führe dann Folgendes aus:

    ```bash theme={null}
    famulor auth login
    ```

    Füge den Key ein, sobald du danach gefragt wirst. Die Eingabe bleibt verborgen, und der Key wird im Schlüsselbund deines Systems gespeichert.
  </Step>

  <Step title="Erste Befehle ausführen">
    ```bash theme={null}
    famulor list-assistants --output table
    famulor list-calls --status completed --limit 10 --output table
    famulor create-call --assistant-id <assistant-id> --to-number +4930123456
    ```
  </Step>
</Steps>

## So funktionieren Befehle

Jede Operation in der [API-Referenz](/de/api-reference/introduction) 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_id` wird `--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.

```bash theme={null}
famulor --help               # Bereiche und die wichtigsten Befehle
famulor assistants           # alle Befehle eines Bereichs
famulor assistants create --name "Front desk"  # Bereich und Verb funktionieren auch
famulor commands recording   # alle Befehle durchsuchen
famulor create-call --help   # Argumente, Optionen, Pflichtfelder und ein Beispiel
```

## Mehr erfahren

<CardGroup cols={2}>
  <Card title="Anmeldung und Workspaces" href="/de/cli/authentication" icon="key">
    Speicherung im Schlüsselbund, Keys für CI, ein Profil pro Workspace und White-Label-Domains.
  </Card>

  <Card title="Befehle und Ausgabe" href="/de/cli/commands" icon="terminal">
    Request-Bodys, Datei-Uploads, Tabellen, JSON Lines, Pagination und Downloads.
  </Card>

  <Card title="Skripte, CI und Coding-Agenten" href="/de/cli/scripting" icon="robot">
    Sichere Automatisierung, Exit-Codes, `jq`-Pipelines und das Befehlsschema für Agenten.
  </Card>

  <Card title="Referenz" href="/de/cli/reference" icon="book">
    Globale Optionen, Umgebungsvariablen, Exit-Codes und Fehlerbehebung.
  </Card>
</CardGroup>

<Tip>
  Du arbeitest lieber in einem KI-Assistenten wie Claude oder ChatGPT statt im Terminal? Verbinde ihn über den [MCP-Server](/de/mcp/overview). Er bietet dieselben Funktionen als Tools an.
</Tip>
