Ciele CLI

La commande ciele utilise les mêmes opérations d’API que l’admin console. La CLI prend en charge le service hébergé ainsi que les installations auto-hébergées.

Configuration requise

Utilisez Node.js 22.6 ou une version ultérieure.
Créez une clé API d’organisation.

Installation

Compilez et installez le package autonome à partir d’une copie locale du dépôt :

pnpm --dir packages/cli pack --pack-destination ./dist
npm install --global ./packages/cli/dist/ciele-cli-*.tgz
ciele help

L’archive tar inclut ses dépendances d’exécution. La commande installée n’a plus besoin du dépôt.

Une fois que @ciele/cli est publié sur npm, npm install --global @ciele/cli installe le même artefact.

Les contributeurs peuvent également exécuter node packages/cli/bin/ciele.mjs sans l’installer.

Se connecter

Pour le service hébergé, exécutez :

ciele login --key "$CIELE_API_KEY"
ciele whoami

Pour une installation auto-hébergée, ajoutez son origine publique :

ciele login \
  --key "$CIELE_API_KEY" \
  --base-url "https://ciele.example.edu"
ciele doctor

La commande login valide la clé avant d’écrire ~/.ciele/config.json. Sur les systèmes pris en charge, le mode du fichier est 0600.

La CLI résout une clé dans l’ordre suivant :

L’option --api-key.
La variable d’environnement CIELE_API_KEY.
Le fichier de configuration enregistré.

La CLI utilise le même ordre pour --base-url, CIELE_BASE_URL et l’origine enregistrée. L’origine hébergée est la valeur par défaut finale.

Utiliser la sortie de l'automatisation

Ajoutez --json à une commande pour obtenir une sortie lisible par machine.

Exit code	Signification
`0`	L’opération s’est terminée.
`1`	Le serveur a renvoyé une erreur.
`2`	La commande saisie n’est pas valide.
`3`	Échec de l’authentification.

ciele doctor vérifie la découverte de l’API, la compatibilité de l’API, la clé, son Role et son Organization.

Commandes relatives à l'assistant et aux connaissances

ciele assistants list --all
ciele assistants update <assistant-id> --file assistant-patch.json
ciele flows list <assistant-id>
ciele flows update <flow-id> --file flow-patch.json
ciele collections list <assistant-id>
ciele sources add-file <collection-id> --file handbook.pdf --assistants <assistant-id>
ciele sources get <source-id>
ciele publish status <assistant-id>

Toute commande qui ajoute des connaissances nécessite --assistants. Une Collection n'a pas de propriétaire ; ces liens sont donc le seul moyen de mettre les connaissances à la portée d'un Assistant. Les commandes sont sources add-text, sources add-url, sources add-file, faqs add et faqs import.

Ajouter des connaissances sans Collection

Un nouvel Assistant n’a pas de Collection, car la liste des Collections n’affiche que les Collections qui contiennent ses Sources. Dans ce cas, utilisez sources add-org. Cela place la Source dans la Knowledge Library de l’Organisation.

ciele sources add-org --url https://example.com/help --assistants <assistant-id>
ciele sources add-org --file handbook.pdf --assistants <assistant-id>
ciele sources add-org --text "Opening hours are 09:00 to 17:00." --assistants <assistant-id>

Indiquez l’un des éléments suivants : --url, --file ou --text. La commande nécessite --assistants pour la même raison que les autres commandes add.

Liens vers les sources

Une Source répond pour les Assistants qui lui sont liés. Ces commandes lisent et modifient les liens.

ciele sources list-org
ciele sources link <source-id> --assistants <assistant-id>,<assistant-id>
ciele sources direct-access <source-id> on --assistant <assistant-id>

sources list-org répertorie toutes les Sources appartenant à l’Organisation, pour l’ensemble des Assistants.

sources link remplace l’ensemble des liens. Une liste vide supprime tous les liens, et la Source cesse de répondre.

sources direct-access détermine si cet Assistant spécifique peut fournir le fichier original à un Visiteur.

Rechercher dans la base de connaissances

knowledge search affiche les passages qui correspondent à une question, avec le Document et la Source de chaque passage. Cela ne génère pas de réponse.

ciele knowledge search "How do I connect Salesforce?"
ciele knowledge search "How do I connect Salesforce?" --assistant <assistant-id>
ciele knowledge search "How do I connect Salesforce?" --json

Avec --assistant, la recherche utilise uniquement les Sources liées à cet Assistant. Sans cela, la recherche utilise l’ensemble de la Library. --json présente les résultats avec leur rang, leur score et leurs ID.

Poser une question à un Assistant

assistants ask envoie une question à un Assistant publié. La commande affiche la réponse, les Sources citées par la réponse et l’ID de la Conversation.

ciele assistants ask <assistant-id> "How do I connect Salesforce?"
ciele assistants ask <assistant-id> "And ServiceNow?" --conversation <conversation-id>

Utilisez --conversation avec l’ID d’une réponse précédente pour poursuivre cette Conversation. Seule la clé API qui a démarré une Conversation peut la poursuivre. Avec un ID différent, la question démarre une nouvelle Conversation.

Chaque question utilise un tour de modèle et crée une Conversation. La boîte de réception l’affiche avec l’étiquette API key lorsque vous réglez le filtre Staff conversations sur Include staff ou Staff only. La commande se termine avec un code d’erreur lorsque l’Assistant n’a pas pu répondre.

Commandes de flux

Découvrez ce qu’un Flow peut contenir

ciele flows catalog affiche les déclencheurs, les actions et les types de conditions de ce déploiement Ciele. Il indique également quelles actions chaque déclencheur autorise. Lisez-le avant de rédiger un fichier Flow. Le serveur refuse un trigger, une action ou un type de condition qui ne figure pas dans la liste.

C’est le déploiement qui fournit cette réponse, et non la CLI. Une CLI plus ancienne utilisée avec une version plus récente de Ciele affiche les nouvelles listes.

ciele flows catalog

Vérifiez un Flow avant de l’enregistrer

flows draft vérifie une modification apportée à un Flow. flows validate vérifie un Flow complet. Aucune de ces commandes n’effectue d’enregistrement. Les deux vous montrent le Flow que Ciele stockerait.

ciele flows draft --file patch.json --summary "add a refund branch"
ciele flows validate <assistant-id> --file flow.json --rationale "own flow"

Utilisez-les principalement pour une raison : lorsqu’un Flow écrit dans un connecteur, Ciele ajoute une action de revue humaine avant cette écriture. Ces deux commandes vous montrent l’action ajoutée. Une opération de sauvegarde le fait de manière silencieuse.

Observer un flux HTTP

Un Flow avec le déclencheur HTTP conserve un enregistrement de chaque appel entrant.

ciele flows runs <flow-id> --limit 20

Les conversations n’incluent pas ces exécutions, car un appel entrant n’est pas une conversation.

Commandes Teammate

Attribuer des capacités à un Teammate

Un nouveau Teammate IA peut répondre aux questions. Il ne peut agir tant que vous ne lui avez pas attribué un domaine, et il n’effectue aucun travail en autonomie tant que vous ne lui avez pas assigné une Routine.

ciele teammates grants <teammate-id>
ciele teammates set-grants <teammate-id> --domains improvements,knowledge
ciele teammates routines <teammate-id>
ciele teammates add-routine <teammate-id> --instruction "Triage new feedback" --cadence daily --hour 8

set-grants envoie l’ensemble complet des domaines à chaque fois. --domains "" les supprime tous. Cette commande nécessite une clé API disposant du rôle Admin ou d’un rôle supérieur, car elle permet à un agent de modifier vos données. Les autres commandes Teammate nécessitent le rôle Editor.

Un Teammate peut avoir un maximum de cinq Routines.

Configurer un coéquipier en une seule commande

teammates create crée un Teammate qui répond aux questions. Il ne peut pas agir et n’effectue aucun travail en mode non supervisé. teammates provision exécute les trois étapes ensemble.

ciele teammates provision --name "Triage" \
  --grants improvements \
  --routine "Triage new feedback:daily:8"

L’ordre est : create, puis grant, puis schedule. Si une étape échoue, la commande vous indique où elle s’est arrêtée. Le teammate reste utilisable jusqu’à ce stade.

Une clé sans le rôle Admin peut créer le coéquipier. Elle ne peut pas accorder un domaine. La commande indique ensuite qu’elle s’est arrêtée à l’étape grants.

Projets et mémoire

Un Project est un espace de travail partagé. Un AI Teammate associé à un Project lit le document de mémoire de ce Project à chaque tour.

ciele projects list
ciele projects create --name "Q4 migration"
ciele projects get <project-id>
ciele projects set-document <project-id> --file notes.md --note "after review"
ciele teammates memory <teammate-id>
ciele teammates set-memory <teammate-id> --file memory.md --note "corrected"

set-document et set-memory remplacent le texte intégral. Ciele conserve le texte précédent dans l’historique du document.

Tâches

ciele tasks list --project <project-id> --status to_do,in_progress
ciele tasks list --label <label-id> --due-from 2026-11-01 --due-to 2026-11-30 --q "brief"
ciele tasks list --improvement <improvement-id> --cursor <next-cursor>
ciele tasks create --project <project-id> --title "Draft the launch brief" --due 2026-11-02
ciele tasks get <task-id>
ciele tasks update <task-id> --status in_review --assignee <user-id>
ciele tasks update <task-id> --json '{"labelIds":["<label-id>"],"blockedBy":["<task-id>"]}'
ciele tasks update <task-id> --archive
ciele tasks comment <task-id> --body "Ready for review"
ciele tasks labels
ciele tasks create-label --name "Bug" --color red
ciele tasks update-label <label-id> --color amber
ciele tasks delete-label <label-id> --yes
ciele projects milestones <project-id>
ciele projects set-milestones <project-id> --json '[{"name":"Launch","date":"2026-11-02"}]'
ciele tasks delete <task-id> --yes

set-milestones remplace la liste complète. Pour conserver un jalon, envoyez-le à nouveau avec son ID. tasks delete supprime également les sous-tâches, les commentaires et les fichiers de la tâche. tasks update --archive masque la tâche et ses sous-tâches. --restore les affiche à nouveau. Lorsqu’il y a davantage de tâches, tasks list affiche le curseur de la page suivante. tasks delete-label supprime le Label de chaque tâche. Les tâches restent.

Il n’existe pas de commande pour votre propre couche de mémoire. Une clé API agit comme le membre qui l’a créée ; ainsi, une commande ici afficherait le document privé de ce membre. Dans la console, accédez à Settings, puis à Memory.

Commandes relatives aux opérations et à l’organisation

ciele conversations list --assistant <assistant-id>
ciele conversations pin <conversation-id>
ciele messages feedback <message-id> --value -1
ciele improvements list
ciele memories subjects
ciele help-desks list
ciele teammates list
ciele channels list
ciele skills list
ciele quick-texts list
ciele goals list <assistant-id>
ciele alerts list
ciele organization get
ciele members list
ciele members set-role <user-id> --role-id <role-id>
ciele members set-assistants <user-id> --scope selected --assistants <assistant-id>:editor
ciele roles list
ciele roles create --name "Content reviewer" --capabilities knowledge:view,knowledge:edit
ciele roles set-defaults --member <role-id>
ciele invites list
ciele api-keys list
ciele audit-log list --action members.updateRole --from 2026-10-01
ciele providers list
ciele sso connection

Les commandes qui suppriment des données nécessitent --yes. Le flux de comportement par défaut (Default behavior Flow) ne peut pas être supprimé.

--role prend le nom d'un rôle prédéfini. --role-id prend l'ID de n'importe quel rôle, y compris un rôle personnalisé. ciele roles list affiche les ID. ciele whoami indique également le nombre de capacités associées à la clé.

Exécutez ciele help pour chaque groupe de commandes et chaque option acceptée. Ajoutez --file lorsqu’une commande accepte une entrée JSON complète ou un patch.

Exemple de vérification CI

export CIELE_API_KEY="ciele_sk_..."
export CIELE_BASE_URL="https://ciele.example.edu"
ciele publish status "$ASSISTANT_ID" --json

Stockez toutes les valeurs dans le magasin de secrets CI. N’écrivez pas de clé dans un fichier de workflow.

Bundles d’Assistant portable

Export écrit un bundle JSON versionné sur la sortie standard. Import crée un nouvel Assistant et renvoie un rapport des références de destination non résolues.

ciele assistants export <assistant-id> > assistant.json
ciele assistants import assistant.json

Les bundles excluent les identifiants et les données des visiteurs. L’importation nécessite un accès en modification. Configurez les identifiants et les références manquants avant de publier le nouvel Assistant.

Exports d'Insights planifiés

Créez un calendrier à partir d’une définition JSON. La cadence hebdomadaire utilise weekday, de zéro pour le dimanche à six pour le samedi.

{
  "name": "Weekly Insights",
  "kind": "insights_overview",
  "format": "csv",
  "filters": {},
  "cadence": { "kind": "weekly", "weekday": 1 },
  "hour": 8,
  "recipientMemberIds": ["member-uuid"]
}

ciele exports create --file schedule.json --yes
ciele exports list
ciele exports update <schedule-id> --file patch.json --yes
ciele exports pause <schedule-id> --yes
ciele exports resume <schedule-id> --yes
ciele exports delete <schedule-id> --yes

La cadence mensuelle utilise {"kind":"monthly","day":1}. L’heure est exprimée en UTC. Les destinataires doivent être des Members actifs de l’Organisation.

Sur cette page