Ciele CLI

La commande ciele utilise les mêmes opérations d'API que la console d'administration. La CLI prend en charge le service hébergé et les installations auto-hébergées.

Prérequis

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

Installer

Compilez et installez le paquet autonome à partir d'une extraction 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 installed n'a plus besoin du dépôt.

Une fois @ciele/cli 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 de fichier est 0600.

La CLI résout une clé dans cet ordre :

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.

Code de sortie	Signification
`0`	L'opération est terminée.
`1`	Le serveur a renvoyé une erreur.
`2`	L'entrée de la commande n'est pas valide.
`3`	L'authentification a échoué.

ciele doctor vérifie la découverte de l'API, la compatibilité de l'API, la clé, son rôle et son organisation.

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>

Chaque commande qui ajoute des connaissances nécessite --assistants. Une Collection n'a pas de propriétaire ; par conséquent, ces liens sont le seul moyen de mettre les connaissances à la disposition 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. Utilisez sources add-org dans ce cas. 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'une des valeurs suivantes : --url, --file ou --text. La commande nécessite --assistants pour la même raison que les autres commandes d'ajout.

Liens de source

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 détenues par l'Organisation, pour l'ensemble des Assistants.

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

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

Commandes de flux

Découvrez ce qu'un flux 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 d'écrire 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 ancienne CLI comparée à une version plus récente de Ciele affiche les nouvelles listes.

ciele flows catalog

Vérifiez un flux avant de l'enregistrer

flows draft vérifie une modification apportée à un flux. flows validate vérifie un flux 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 pour une raison avant tout : lorsqu'un flux écrit dans un connecteur, Ciele ajoute une action de révision humaine avant cette écriture. Ces deux commandes vous montrent l'action ajoutée. Une sauvegarde le fait en silence.

Observez 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 pour les Teammates

Donnez à un Teammate ses capacités

Un nouvel IA Teammate peut répondre aux questions. Il ne peut agir que lorsque vous lui avez 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 Éditeur.

Un Teammate peut avoir un maximum de cinq Routines.

Configurez un coéquipier en une seule commande

teammates create crée un coéquipier qui répond aux questions. Il ne peut pas agir et n'effectue aucune tâche sans supervision. teammates provision réalise les trois étapes en même temps.

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

L'ordre est le suivant : créer, puis accorder, puis planifier. Si une étape échoue, la commande vous indique où elle s'est arrêtée. Le coéquipier reste utilisable jusqu'à ce stade.

Une clé sans le rôle d'administrateur 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 projet est un espace de travail partagé. Un coéquipier IA associé à un projet lit le document de mémoire de ce projet à 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.

Il n'existe pas de commande pour votre propre couche de mémoire. Une clé API agit au nom du membre qui l'a créée ; par conséquent, une commande ici afficherait le document privé de ce membre. Utilisez Paramètres, puis Mémoire, dans la console.

Commandes Opérations et Organisation

ciele conversations list --assistant <assistant-id>
ciele conversations pin <conversation-id>
ciele messages feedback <message-id> --value -1
ciele improvements list
ciele entities list
ciele memories subjects
ciele help-desks list
ciele teammates list
ciele channels list
ciele skills list
ciele goals list <assistant-id>
ciele alerts list
ciele organization get
ciele members list
ciele invites list
ciele api-keys list
ciele providers list
ciele sso connection

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

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

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.

Sur cette page