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

> Tout votre espace de travail Famulor dans le terminal : chaque opération de l'API sous forme de commande

La CLI Famulor apporte toute l'API REST dans votre terminal. Créez des assistants, lancez des appels, exécutez des campagnes, gérez les leads et les numéros de téléphone, et consultez l'historique des appels avec un seul outil. Tout ce que vous pouvez faire via l'API, vous pouvez le scripter, l'exécuter dans votre CI ou le confier à un agent de code.

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

<Note>
  La CLI est en préversion publique (version 0.x). Les noms des commandes suivent l'API et peuvent encore changer avant la 1.0. Une commande renommée continue de fonctionner pendant au moins une version mineure.
</Note>

## Prérequis

* **Node.js 22** ou une version ultérieure.
* Un forfait d'espace de travail incluant **API Access**, la même exigence que pour l'[API REST](/fr/api-reference/introduction#accès-à-lapi).
* Une clé API créée sous **Settings → API & MCP**.

## Démarrage rapide

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

  <Step title="Se connecter">
    Créez une clé API sous **Settings → API & MCP**, puis exécutez :

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

    Collez la clé lorsqu'elle vous est demandée. La saisie reste masquée et la clé est enregistrée dans le trousseau de votre système.
  </Step>

  <Step title="Exécuter vos premières commandes">
    ```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>

## Fonctionnement des commandes

Chaque opération de la [référence API](/fr/api-reference/introduction) correspond à une commande. Le nom de la commande est l'identifiant de l'opération en kebab case : **Start an outbound call** (`createCall`) devient `famulor create-call`.

* Les **paramètres de chemin** sont des arguments : `famulor get-assistant <id>`.
* Les **paramètres de requête et les champs du corps** sont des options en kebab case : `assistant_id` devient `--assistant-id`.
* Les options sont **typées et validées** avant tout envoi : les nombres doivent être des nombres, les choix doivent faire partie des valeurs autorisées et les champs obligatoires doivent être présents.

```bash theme={null}
famulor --help               # domaines et commandes les plus utiles
famulor assistants           # toutes les commandes d'un domaine
famulor assistants create --name "Front desk"  # domaine et verbe fonctionnent aussi
famulor commands recording   # rechercher parmi toutes les commandes
famulor create-call --help   # arguments, options, champs obligatoires et exemple
```

## En savoir plus

<CardGroup cols={2}>
  <Card title="Connexion et espaces de travail" href="/fr/cli/authentication" icon="key">
    Stockage dans le trousseau, clés pour la CI, un profil par espace de travail et domaines en marque blanche.
  </Card>

  <Card title="Commandes et sortie" href="/fr/cli/commands" icon="terminal">
    Corps de requête, envoi de fichiers, tableaux, JSON Lines, pagination et téléchargements.
  </Card>

  <Card title="Scripts, CI et agents de code" href="/fr/cli/scripting" icon="robot">
    Automatisation sûre, codes de sortie, pipelines `jq` et schéma des commandes pour les agents.
  </Card>

  <Card title="Référence" href="/fr/cli/reference" icon="book">
    Options globales, variables d'environnement, codes de sortie et dépannage.
  </Card>
</CardGroup>

<Tip>
  Vous travaillez dans un assistant IA comme Claude ou ChatGPT plutôt que dans un terminal ? Connectez-le via le [serveur MCP](/fr/mcp/overview). Il propose les mêmes fonctionnalités sous forme d'outils.
</Tip>