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.
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.
- Une clé API créée sous Settings → API & MCP.
Démarrage rapide
1
Installer
2
Se connecter
Créez une clé API sous Settings → API & MCP, puis exécutez :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.
3
Exécuter vos premières commandes
Fonctionnement des commandes
Chaque opération de la référence API 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_iddevient--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.
En savoir plus
Connexion et espaces de travail
Stockage dans le trousseau, clés pour la CI, un profil par espace de travail et domaines en marque blanche.
Commandes et sortie
Corps de requête, envoi de fichiers, tableaux, JSON Lines, pagination et téléchargements.
Scripts, CI et agents de code
Automatisation sûre, codes de sortie, pipelines
jq et schéma des commandes pour les agents.Référence
Options globales, variables d’environnement, codes de sortie et dépannage.