Ciele CLI

The ciele command uses the same API operations as the administrator console. The CLI supports the hosted service and self-hosted installations.

Requirements

Use Node.js 22.6 or later.
Create an Organization API key.

Install

Build and install the standalone package from a repository checkout:

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

The tarball includes its runtime dependencies. The installed command no longer needs the repository.

After @ciele/cli is published to npm, npm install --global @ciele/cli installs the same artifact.

Contributors can also run node packages/cli/bin/ciele.mjs without installing it.

For the hosted service, run:

ciele login --key "$CIELE_API_KEY"
ciele whoami

For a self-hosted installation, add its public origin:

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

The login command validates the key before it writes ~/.ciele/config.json. On supported systems, the file mode is 0600.

The CLI resolves a key in this order:

The --api-key option.
The CIELE_API_KEY environment variable.
The saved configuration file.

The CLI uses the same order for --base-url, CIELE_BASE_URL, and the saved origin. The hosted origin is the final default.

Use automation output

Add --json to a command to receive machine-readable output.

Exit code	Meaning
`0`	The operation completed.
`1`	The server returned an error.
`2`	The command input is not valid.
`3`	Authentication failed.

ciele doctor verifies API discovery, API compatibility, the key, its Role, and its Organization.

Assistant and knowledge commands

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>

Every command that adds knowledge needs --assistants. A Collection has no owner, so these links are the only thing that puts the knowledge in the reach of an Assistant. The commands are sources add-text, sources add-url, sources add-file, faqs add, and faqs import.

Source links

A Source answers for the Assistants linked to it. These commands read and change the 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 lists every Source the Organization owns, across all Assistants.

sources link replaces the link set. An empty list removes every link, and the Source stops answering.

sources direct-access decides whether that one Assistant can give a Visitor the original file.

Operations and Organization commands

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

Commands that delete data require --yes. The Default behavior Flow cannot be deleted.

Run ciele help for every command group and accepted option. Add --file when a command accepts a complete JSON input or patch.

Example CI check

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

Store all values in the CI secret store. Do not write a key in a workflow file.

On this page