> ## 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.

# Referenz

> Globale Optionen, Umgebungsvariablen, Dateien, Shell-Vervollständigung und Fehlerbehebung für die Famulor CLI

## Globale Optionen

Diese Optionen funktionieren mit jedem API-Befehl.

| Option | Zweck |
| - | - |
| `-o, --output json\|table\|jsonl` | Ausgabeformat (Standard `json`) |
| `-i, --input <file\|->` | JSON-Request-Body aus einer Datei oder mit `-` aus stdin |
| `-F, --field key=value` | Body-Feld setzen; Zahlen, `true`/`false`, `null` und JSON werden erkannt |
| `-f, --raw-field key=value` | Body-Feld als Text setzen |
| `--all` | Alle Seiten einer Liste abrufen |
| `--columns a,b,c` | Spalten für die Tabellenausgabe |
| `--output-file <path>` | Antwort in eine Datei schreiben |
| `--dry-run` | Anfrage anzeigen, ohne sie zu senden |
| `-y, --yes` | Löschvorgänge und andere unumkehrbare Aktionen ohne Rückfrage bestätigen |
| `-p, --profile <name>` | Gespeicherte Anmeldung verwenden |
| `--base-url <domain>` | API-Host, zum Beispiel deine White-Label-Domain |
| `--timeout <seconds>` | Frist für den gesamten Befehl, Wiederholungen eingeschlossen |
| `-q, --quiet` | Keine Fortschrittsausgabe |
| `--debug` | Details zu Anfrage und Antwort auf stderr |
| `--no-color` | Keine Farben oder Animationen |
| `-h, --help` | Hilfe zu einem Befehl |

Mit `famulor help options` erhältst du dieselbe Liste im Terminal.

## CLI-Befehle

| Befehl | Zweck |
| - | - |
| `famulor auth login` | API-Key für einen Workspace speichern (auch `famulor login`) |
| `famulor auth status` | Gespeicherte Anmeldungen anzeigen und die aktive prüfen |
| `famulor auth whoami` | Workspace, Key-Name und Scopes der aktiven Anmeldung (auch `famulor whoami`) |
| `famulor auth switch <profile>` | Standardprofil wechseln |
| `famulor auth logout` | Gespeicherten Key von diesem Computer entfernen (auch `famulor logout`) |
| `famulor commands [search]` | API-Befehle durchsuchen; `--full` ergänzt alle Optionen |
| `famulor api <METHOD> <path>` | Beliebige API-Anfrage senden |
| `famulor doctor` | Einrichtung prüfen |
| `famulor completion bash\|zsh\|fish` | Shell-Vervollständigung |

## Umgebungsvariablen

| Variable | Zweck |
| - | - |
| `FAMULOR_API_KEY` | API-Key; hat Vorrang vor gespeicherten Anmeldungen |
| `FAMULOR_BASE_URL` | API-Host, zum Beispiel deine White-Label-Domain |
| `FAMULOR_PROFILE` | Zu verwendende gespeicherte Anmeldung |
| `FAMULOR_OUTPUT` | Standard-Ausgabeformat |
| `FAMULOR_TIMEOUT` | Standardfrist in Sekunden; `--timeout` hat Vorrang |
| `FAMULOR_MAX_RETRIES` | Wiederholungen bei Anfragelimits und Gateway-Fehlern, 0 bis 10 (Standard 3) |
| `FAMULOR_CONFIG_DIR` | Speicherort der Anmeldungen |
| `FAMULOR_NO_KEYRING` | Keys statt im Schlüsselbund des Systems in einer Datei speichern, auf die nur dein Benutzerkonto zugreifen kann |
| `FAMULOR_THEME` | `light` oder `dark`, falls Farben auf dem Hintergrund deines Terminals schwer lesbar sind |
| `NO_COLOR` | Einfache Ausgabe ohne Farben oder Animationen |

## Dateien

Anmeldungen werden in `~/.config/famulor` gespeichert (unter Windows in `%APPDATA%\famulor`). `config.json` enthält die Profile, aber nie den Key selbst. Der Key liegt im Schlüsselbund des Systems oder, falls kein Schlüsselbund verfügbar ist, in `credentials.json`, auf die nur dein Benutzerkonto zugreifen kann.

## Shell-Vervollständigung

```bash theme={null}
# zsh oder bash: in dein Shell-Profil eintragen
eval "$(famulor completion zsh)"

# fish
famulor completion fish > ~/.config/fish/completions/famulor.fish
```

Die Vervollständigung umfasst Befehle, Verben der Bereiche, Optionen, erlaubte Werte und die Namen gespeicherter Profile. Das zsh-Skript funktioniert auch, wenn `compinit` noch nicht eingerichtet ist.

## Fehlerbehebung

Beginne mit `famulor doctor`. Der Befehl prüft die Node.js-Version, die gespeicherte Anmeldung, den Host, die Netzwerkverbindung und API Access.

| Meldung | Was zu tun ist |
| - | - |
| `You are not logged in.` | Führe `famulor auth login` aus oder setze `FAMULOR_API_KEY`. |
| `403 api_access_required` | API Access ist nicht in deinem Workspace-Plan enthalten. Buche die Funktion unter **Settings → Plan** hinzu. |
| `missing the required scope` | Dem Key fehlt diese Berechtigung. Verwende einen Key mit dem passenden Scope. |
| `429 rate_limited` | Die CLI hat die Anfrage wiederholt, wo die API das erlaubt hat. Nutzungslimits wie ein tägliches Anruflimit werden nicht wiederholt; die Meldung nennt das Limit. |
| `Refusing to … without confirmation` | Ergänze `--yes`, um aus einem Skript oder Coding-Agenten etwas zu löschen oder eine unumkehrbare Aktion auszuführen. |

<Tip>
  Anfragelimits, Antwortformat und Fehlercodes sind dieselben wie bei der REST-API. Details findest du in der [API-Einführung](/de/api-reference/introduction).
</Tip>