Ciele CLI

Der Befehl ciele verwendet dieselben API-Operationen wie die Administrator-Konsole. Die CLI unterstützt den gehosteten Dienst sowie selbst gehostete Installationen.

Voraussetzungen

• Verwenden Sie Node.js 22.6 oder höher.
• Erstellen Sie einen Organisations-API-Schlüssel.

Installieren

Erstellen 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 Tar-Archiv enthält seine Laufzeitabhängigkeiten. Der installierte Befehl benötigt das Repository nicht mehr.

Nachdem @ciele/cli in 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 Self-Hosted-Installation deren öffentlichen Origin 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:

1. Die Option --api-key.
2. Die Umgebungsvariable CIELE_API_KEY.
3. Die gespeicherte Konfigurationsdatei.

Die CLI verwendet dieselbe Reihenfolge für --base-url, CIELE_BASE_URL und den gespeicherten Ursprung. Der gehostete Ursprung ist die letzte Standardeinstellung.

Automatisierungs-Ausgabe verwenden

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

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

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 Besitzer, daher sind diese Links das Einzige, was das Wissen für einen 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 Assistent hat keine Collection, da die Collection-Liste nur die Collections anzeigt, die seine Quellen enthalten. Verwenden Sie in diesem Fall sources add-org. Dadurch wird die Quelle in die Wissensbibliothek 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 entweder --url, --file oder --text an. Der Befehl benötigt --assistants aus demselben Grund wie die anderen add-Befehle.

Quellverknüpfungen

Eine Quelle antwortet für die mit ihr verknüpften Assistenten. Diese Befehle lesen und ändern die Links.

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 jede Quelle auf, die die Organisation besitzt, und zwar über alle Assistenten hinweg.

sources link ersetzt den Link-Satz. Eine leere Liste entfernt jeden Link, und die Quelle antwortet nicht mehr.

sources direct-access entscheidet, ob dieser eine Assistant einem Visitor die Originaldatei zur Verfügung stellen darf.

Flow-Befehle

Erfahren Sie, was ein Flow enthalten kann

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

Diese Antwort gibt die Bereitstellung, nicht die CLI. Eine ältere CLI zeigt im Vergleich zu einer neueren Ciele-Version die neuen Listen an.

ciele flows catalog

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

flows draft prüft eine Änderung an einem Flow. flows validate prüft einen vollständigen Flow. Keiner der beiden Befehle speichert etwas. Beide zeigen Ihnen den Flow, 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 Konnektor schreibt, fügt Ciele vor diesem Schreibvorgang eine Aktion zur menschlichen Überprüfung hinzu. Diese beiden Befehle zeigen Ihnen die hinzugefügte Aktion an. Ein Speichervorgang führt dies im Hintergrund aus.

Einen HTTP-Flow beobachten

Ein Flow mit dem HTTP-Trigger zeichnet jeden eingehenden Aufruf auf.

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

Gespräche umfassen diese Ausführungen nicht, da ein eingehender Anruf kein Gespräch ist.

Teammate-Befehle

Einem Teammate seine Capabilities zuweisen

Ein neuer KI-Teammate kann Fragen beantworten. Er kann erst handeln, wenn Sie ihm eine Domäne zuweisen, und er führt keine unbeaufsichtigten Arbeiten aus, 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. Für diesen Befehl ist ein API-Schlüssel mit der Rolle „Admin“ oder höher erforderlich, da er einem Agenten ermöglicht, Ihre Daten zu ändern. Für die anderen Teammate-Befehle ist die Editor-Rolle erforderlich.

Ein Teammate kann maximal fünf Routinen haben.

Richten Sie einen Teammate mit einem einzigen Befehl ein

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

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

Die Reihenfolge lautet: erstellen, dann gewähren, dann planen. Wenn ein Schritt fehlschlägt, teilt Ihnen der Befehl mit, wo er angehalten hat. Der Teammate bleibt bis zu diesem Punkt nutzbar.

Ein Schlüssel ohne die Admin-Rolle kann den Teamkollegen erstellen. Es kann keine Domäne gewähren. Der Befehl meldet dann, dass er beim Schritt „grants“ abgebrochen hat.

Projekte und Speicher

Ein Projekt ist ein gemeinsamer 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.

Es gibt keinen Befehl für Ihre eigene Speicherebene. Ein API-Schlüssel fungiert als das Mitglied, das ihn erstellt hat. Daher würde ein Befehl hier das private Dokument dieses Mitglieds anzeigen. Wählen Sie in der Konsole „Settings“ und dann „Memory“.

Befehle für Vorgänge und 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

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

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 einen CI-Check

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.