Ciele CLI

Der Befehl ciele verwendet dieselben API-Operationen wie die Administratorkonsole. Die CLI unterstützt den gehosteten Service sowie selbstgehostete Installationen.

Voraussetzungen

Verwenden Sie Node.js 22.6 oder höher.
Erstellen Sie einen Organization API key.

Installieren

Bauen und installieren Sie das eigenständige Paket aus einem Repository-Checkout:

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

Das Tarball-Archiv enthält seine Laufzeitabhängigkeiten. Der installierte Befehl benötigt das Repository nicht mehr.

Nachdem @ciele/cli auf npm veröffentlicht wurde, installiert npm install --global @ciele/cli dasselbe Artefakt.

Mitwirkende können node packages/cli/bin/ciele.mjs auch ausführen, ohne es zu installieren.

Anmelden

Für den gehosteten Dienst führen Sie Folgendes aus:

ciele login --key "$CIELE_API_KEY"
ciele whoami

Fügen Sie bei einer selbst gehosteten Installation deren öffentlichen Ursprung hinzu:

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

Der Befehl login validiert den Schlüssel, bevor er ~/.ciele/config.json schreibt. Auf unterstützten Systemen ist der Dateimodus 0600.

Die CLI löst einen Schlüssel in dieser Reihenfolge auf:

Die Option --api-key.
Die Umgebungsvariable CIELE_API_KEY.
Die gespeicherte Konfigurationsdatei.

Die CLI verwendet dieselbe Reihenfolge für --base-url, CIELE_BASE_URL und den gespeicherten Origin. Der gehostete Origin ist der letzte Standardwert.

Automatisierungsausgabe verwenden

Fügen Sie --json zu einem Befehl hinzu, um eine maschinenlesbare Ausgabe zu erhalten.

Exit code	Bedeutung
`0`	Der Vorgang wurde abgeschlossen.
`1`	Der Server hat einen Fehler zurückgegeben.
`2`	Die Eingabe des Befehls ist ungültig.
`3`	Authentication failed.

ciele doctor überprüft die API-Erkennung, die API-Kompatibilität, den Schlüssel, seine Role und seine Organization.

Befehle für Assistenten und Wissen

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>

Jeder Befehl, der Wissen hinzufügt, benötigt --assistants. Eine Collection hat keinen Owner, daher sind diese Links das Einzige, was das Wissen einem Assistant zugänglich macht. Die Befehle sind sources add-text, sources add-url, sources add-file, faqs add und faqs import.

Wissen ohne Collection hinzufügen

Ein neuer Assistant hat keine Collection, da die Collection-Liste nur die Collections anzeigt, die seine Sources enthalten. Verwenden Sie in diesem Fall sources add-org. Dadurch wird die Source in die Knowledge Library der Organisation aufgenommen.

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>

Geben Sie eines von --url, --file oder --text an. Der Befehl benötigt --assistants aus demselben Grund wie die anderen add-Befehle.

Quellenverknüpfungen

Eine Source beantwortet Anfragen für die mit ihr verknüpften Assistants. Diese Befehle lesen die Links aus und ändern sie.

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 listet alle Sources auf, die der Organisation gehören, und zwar über alle Assistants hinweg.

sources link ersetzt den Link-Satz. Eine leere Liste entfernt alle Verknüpfungen, und die Source hört auf zu antworten.

sources direct-access legt fest, ob dieser eine Assistant einem Visitor die Originaldatei bereitstellen darf.

Das Wissen durchsuchen

knowledge search zeigt die Passagen an, die zu einer Frage passen, zusammen mit dem Document und der Source jeder Passage. Es generiert keine Antwort.

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

Mit --assistant verwendet die Suche nur die Sources, die mit diesem Assistant verknüpft sind. Ohne diese Option verwendet die Suche die gesamte Library. --json gibt die Ergebnisse mit ihrem Rang, ihrer Bewertung und ihren IDs aus.

Einen Assistenten fragen

assistants ask sendet eine Frage an einen veröffentlichten Assistant. Der Befehl zeigt die Antwort, die von der Antwort zitierten Sources sowie die ID der Conversation an.

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

Verwenden Sie --conversation mit der ID einer früheren Antwort, um diese Conversation fortzusetzen. Nur der API-Schlüssel, mit dem eine Conversation gestartet wurde, kann sie fortsetzen. Mit einer anderen ID startet die Frage eine neue Conversation.

Jede Frage verbraucht einen Model Turn und erstellt eine Conversation. Die Inbox zeigt es mit dem Label API key an, wenn Sie den Filter Staff conversations auf Include staff oder Staff only setzen. Der Befehl wird mit einem Fehlercode beendet, wenn der Assistant nicht antworten konnte.

Flow-Befehle

Erfahren Sie, was ein Flow enthalten kann

ciele flows catalog zeigt die Trigger, die Actions und die Condition-Arten dieser Ciele-Bereitstellung an. Es zeigt auch, welche Actions jeder Trigger zulässt. Lesen Sie es, bevor Sie eine Flow-Datei schreiben. Der Server lehnt einen Trigger, eine Action oder eine Condition-Art ab, die nicht in der Liste enthalten ist.

Diese Antwort liefert die Bereitstellung, nicht die CLI. Eine ältere CLI in Verbindung mit einer neueren Version von Ciele zeigt die neuen Listen an.

ciele flows catalog

Überprüfen Sie einen Flow, bevor Sie ihn speichern

flows draft überprüft eine Änderung an einem Flow. flows validate überprüft einen vollständigen Flow. Keiner der beiden Befehle speichert irgendetwas. Beide zeigen Ihnen den Flow an, den Ciele speichern würde.

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

Verwenden Sie sie vor allem aus einem Grund: Wenn ein Flow in einen Connector schreibt, fügt Ciele vor diesem Schreibvorgang eine Aktion zur manuellen Überprüfung hinzu. Diese beiden Befehle zeigen Ihnen die hinzugefügte Aktion an. Ein Save führt dies stillschweigend aus.

Einen HTTP-Flow beobachten

Ein Flow mit dem HTTP-Trigger führt Aufzeichnungen über jeden eingehenden Aufruf.

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

Conversations umfassen diese Runs nicht, da ein eingehender Aufruf keine Conversation ist.

Teammate-Befehle

Einem Teammate seine Fähigkeiten zuweisen

Ein neues KI-Teammitglied kann Fragen beantworten. Er kann erst dann agieren, wenn Sie ihm eine Domain zuweisen, und er erledigt keine unbeaufsichtigte Arbeit, bis Sie ihm eine Routine zuweisen.

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 sendet jedes Mal den vollständigen Satz von Domains. --domains "" entfernt sie alle. Dieser Befehl erfordert einen API-Schlüssel mit der Rolle Admin oder einer höheren Rolle, da er es einem Agenten ermöglicht, Ihre Daten zu ändern. Die anderen Teammate-Befehle erfordern die Rolle Editor.

Ein Teammate kann maximal fünf Routines haben.

Richten Sie ein Teammember mit einem einzigen Befehl ein

teammates create erstellt einen Teammate, der Fragen beantwortet. Er kann nicht handeln und erledigt keine unbeaufsichtigte Arbeit. teammates provision führt die drei Schritte gemeinsam aus.

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

Die Reihenfolge lautet: create, dann grant, dann schedule. Wenn ein Schritt fehlschlägt, teilt Ihnen der Befehl mit, wo er abgebrochen wurde. Bis zu diesem Punkt bleibt der Teammate nutzbar.

Ein Schlüssel ohne die Rolle „Admin Role“ kann den Teammate erstellen. Es kann keine Domain gewähren. Der Befehl meldet dann, dass er beim Schritt „grants“ angehalten hat.

Projekte und Speicher

Ein Project ist ein gemeinsam genutzter Arbeitsbereich. Ein AI Teammate, der einem Projekt zugeordnet ist, liest bei jedem Zug das Memory-Dokument dieses Projekts.

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 und set-memory ersetzen den vollständigen Text. Ciele speichert den vorherigen Text im Verlauf des Dokuments.

Aufgaben

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 ersetzt die vollständige Liste. Um einen Meilenstein beizubehalten, senden Sie ihn erneut mit seiner ID. tasks delete löscht außerdem die Subtasks, Kommentare und Dateien der Task. tasks update --archive blendet die Task und ihre Subtasks aus. --restore zeigt sie wieder an. Wenn es mehrere Tasks gibt, zeigt tasks list den Cursor für die nächste Seite an. tasks delete-label entfernt das Label von jeder Task. Die Tasks bleiben erhalten.

Es gibt keinen Befehl für Ihre eigene Memory Layer. Ein API-Schlüssel fungiert als das Mitglied, das ihn erstellt hat. Daher würde ein Befehl hier das private Dokument dieses Mitglieds anzeigen. Verwenden Sie in der Konsole Settings und anschließend Memory.

Befehle für Operations und Organization

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

Befehle, die Daten löschen, erfordern --yes. Der Default Behavior Flow kann nicht gelöscht werden.

--role erwartet den Namen einer vordefinierten Rolle. --role-id erwartet die ID einer beliebigen Rolle, auch einer benutzerdefinierten Rolle. ciele roles list zeigt die IDs an. ciele whoami zeigt außerdem an, über wie viele Capabilities der Schlüssel verfügt.

Führen Sie ciele help für jede Befehlsgruppe und jede akzeptierte Option aus. Fügen Sie --file hinzu, wenn ein Befehl eine vollständige JSON-Eingabe oder einen vollständigen Patch akzeptiert.

Beispiel für eine CI-Prüfung

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

Speichern Sie alle Werte im CI-Secret-Store. Schreiben Sie keinen Schlüssel in eine Workflow-Datei.

Portable Assistant-Bundles

Export schreibt ein versioniertes JSON-Bundle in die Standardausgabe. Import erstellt einen neuen Assistenten und gibt einen Bericht über unaufgelöste Zielreferenzen zurück.

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

Bundles schließen Anmeldeinformationen und Visitor-Daten aus. Import erfordert Bearbeitungszugriff. Konfigurieren Sie fehlende Anmeldeinformationen und Verweise, bevor Sie den neuen Assistenten veröffentlichen.

Geplante Insights-Exporte

Erstellen Sie einen Zeitplan aus einer JSON-Definition. Der wöchentliche Rhythmus verwendet weekday von null für Sonntag bis sechs für Samstag.

{
  "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

Der monatliche Turnus verwendet {"kind":"monthly","day":1}. Die Uhrzeit ist in UTC angegeben. Die Empfänger müssen aktuelle Mitglieder der Organisation sein.

Auf dieser Seite