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

# Référence

> Options globales, variables d'environnement, fichiers, complétion du shell et dépannage de la CLI Famulor

## Options globales

Ces options fonctionnent avec toutes les commandes de l'API.

| Option | Rôle |
| - | - |
| `-o, --output json\|table\|jsonl` | Format de sortie (par défaut `json`) |
| `-i, --input <file\|->` | Corps de requête JSON depuis un fichier, ou depuis stdin avec `-` |
| `-F, --field key=value` | Définir un champ du corps ; les nombres, `true`/`false`, `null` et le JSON sont reconnus |
| `-f, --raw-field key=value` | Définir un champ du corps sous forme de texte |
| `--all` | Récupérer toutes les pages d'une liste |
| `--columns a,b,c` | Colonnes de la sortie en tableau |
| `--output-file <path>` | Écrire la réponse dans un fichier |
| `--dry-run` | Afficher la requête sans l'envoyer |
| `-y, --yes` | Confirmer les suppressions et les autres actions irréversibles sans invite |
| `-p, --profile <name>` | Utiliser une connexion enregistrée |
| `--base-url <domain>` | Hôte de l'API, par exemple votre domaine en marque blanche |
| `--timeout <seconds>` | Délai maximal de toute la commande, nouvelles tentatives comprises |
| `-q, --quiet` | Aucun affichage de progression |
| `--debug` | Détails de la requête et de la réponse sur stderr |
| `--no-color` | Ni couleurs ni animation |
| `-h, --help` | Aide d'une commande |

Exécutez `famulor help options` pour afficher la même liste dans votre terminal.

## Commandes de la CLI

| Commande | Rôle |
| - | - |
| `famulor auth login` | Enregistrer une clé API pour un espace de travail (aussi `famulor login`) |
| `famulor auth status` | Afficher les connexions enregistrées et vérifier la connexion active |
| `famulor auth whoami` | Espace de travail, nom de la clé et portées de la connexion active (aussi `famulor whoami`) |
| `famulor auth switch <profile>` | Changer le profil par défaut |
| `famulor auth logout` | Supprimer une clé enregistrée de cet ordinateur (aussi `famulor logout`) |
| `famulor commands [search]` | Rechercher les commandes de l'API ; `--full` ajoute toutes les options |
| `famulor api <METHOD> <path>` | Envoyer n'importe quelle requête API |
| `famulor doctor` | Vérifier la configuration |
| `famulor completion bash\|zsh\|fish` | Complétion du shell |

## Variables d'environnement

| Variable | Rôle |
| - | - |
| `FAMULOR_API_KEY` | Clé API ; prioritaire sur les connexions enregistrées |
| `FAMULOR_BASE_URL` | Hôte de l'API, par exemple votre domaine en marque blanche |
| `FAMULOR_PROFILE` | Connexion enregistrée à utiliser |
| `FAMULOR_OUTPUT` | Format de sortie par défaut |
| `FAMULOR_TIMEOUT` | Délai maximal par défaut en secondes ; `--timeout` est prioritaire |
| `FAMULOR_MAX_RETRIES` | Nouvelles tentatives en cas de limite de requêtes ou d'erreur de passerelle, de 0 à 10 (3 par défaut) |
| `FAMULOR_CONFIG_DIR` | Emplacement où les connexions sont enregistrées |
| `FAMULOR_NO_KEYRING` | Enregistrer les clés dans un fichier accessible uniquement à son propriétaire plutôt que dans le trousseau du système |
| `FAMULOR_THEME` | `light` ou `dark`, si les couleurs sont difficiles à lire sur le fond de votre terminal |
| `NO_COLOR` | Sortie brute sans couleurs ni animation |

## Fichiers

Les connexions sont enregistrées dans `~/.config/famulor` (sous Windows dans `%APPDATA%\famulor`). `config.json` contient les profils, mais jamais la clé elle-même. La clé est conservée dans le trousseau du système, ou dans `credentials.json` avec des permissions réservées au propriétaire si aucun trousseau n'est disponible.

## Complétion du shell

```bash theme={null}
# zsh ou bash : à ajouter au profil de votre shell
eval "$(famulor completion zsh)"

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

La complétion couvre les commandes, les verbes des domaines, les options, les valeurs autorisées et les noms des profils enregistrés. Le script zsh fonctionne aussi lorsque `compinit` n'est pas encore configuré.

## Dépannage

Commencez par `famulor doctor`. Cette commande vérifie la version de Node.js, la connexion enregistrée, l'hôte, la connexion réseau et API Access.

| Message | Que faire |
| - | - |
| `You are not logged in.` | Exécutez `famulor auth login` ou définissez `FAMULOR_API_KEY`. |
| `403 api_access_required` | Le forfait de votre espace de travail n'inclut pas API Access. Ajoutez-le sous **Settings → Plan**. |
| `missing the required scope` | La clé ne dispose pas de cette autorisation. Utilisez une clé disposant de cette portée. |
| `429 rate_limited` | La CLI a réessayé lorsque l'API le permettait. Les limites d'utilisation, comme une limite quotidienne d'appels, ne sont pas retentées ; le message indique la limite concernée. |
| `Refusing to … without confirmation` | Ajoutez `--yes` pour supprimer ou exécuter une action irréversible depuis un script ou un agent de code. |

<Tip>
  Les limites de requêtes, le format des réponses et les codes d'erreur sont les mêmes que pour l'API REST. Consultez l'[introduction à l'API](/fr/api-reference/introduction) pour plus de détails.
</Tip>
