Ciele

Ciele CLI

Gestiona Ciele desde un terminal o una tarea automatizada.

El comando ciele utiliza las mismas operaciones de API que la consola de administración. La CLI es compatible con el servicio alojado y con las instalaciones autoalojadas.

Requisitos

Instalar

Compila e instala el paquete independiente desde una copia del repositorio:

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

El tarball incluye sus dependencias de tiempo de ejecución. El comando installed ya no necesita el repositorio.

Después de publicar @ciele/cli en npm, npm install --global @ciele/cli instala el mismo artefacto.

Los colaboradores también pueden ejecutar node packages/cli/bin/ciele.mjs sin instalarlo.

Iniciar sesión

Para el servicio alojado, ejecuta:

ciele login --key "$CIELE_API_KEY"
ciele whoami

Para una instalación autohospedada, añade su origen público:

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

El comando login valida la clave antes de escribir ~/.ciele/config.json. En los sistemas compatibles, el modo de archivo es 0600.

La CLI resuelve una clave en este orden:

  1. La opción --api-key.
  2. La variable de entorno CIELE_API_KEY.
  3. El archivo de configuración guardado.

La CLI utiliza el mismo orden para --base-url, CIELE_BASE_URL y el origen guardado. El origen alojado es el valor predeterminado final.

Usar la salida de automatización

Añade --json a un comando para recibir una salida legible por máquina.

Código de salidaSignificado
0La operación se ha completado.
1El servidor ha devuelto un error.
2La entrada del comando no es válida.
3Error de autenticación.

ciele doctor verifica el descubrimiento de la API, la compatibilidad de la API, la clave, su rol y su organización.

Comandos de asistente y conocimiento

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>

Cada comando que añade conocimiento necesita --assistants. Una Colección no tiene propietario, por lo que estos enlaces son lo único que pone el conocimiento al alcance de un Asistente. Los comandos son sources add-text, sources add-url, sources add-file, faqs add y faqs import.

Añadir conocimiento sin una Collection

Un nuevo Asistente no tiene ninguna Colección, porque la lista de Colecciones muestra solo las Colecciones que contienen sus Fuentes. En ese caso, usa sources add-org. Coloca la Fuente en la Biblioteca de conocimiento de la Organización.

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>

Indica uno de estos: --url, --file o --text. El comando necesita --assistants por la misma razón que los demás comandos de adición.

Enlaces de fuente

Una Fuente responde por los Asistentes vinculados a ella. Estos comandos leen y modifican los enlaces.

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 enumera todas las Fuentes que posee la Organización, en todos los Asistentes.

sources link reemplaza el conjunto de enlaces. Una lista vacía elimina todos los enlaces y la Fuente deja de responder.

sources direct-access decide si ese Asistente puede entregar el archivo original a un Visitante.

Comandos de flujo

Descubre qué puede contener un Flow

ciele flows catalog muestra los desencadenantes, las acciones y los tipos de condición de esta implementación de Ciele. También muestra qué acciones permite cada desencadenante. Léelo antes de escribir un archivo Flow. El servidor rechaza un desencadenante, una acción o un tipo de condición que no esté en la lista.

La implementación da esta respuesta, no la CLI. Una CLI anterior comparada con una Ciele más reciente muestra las nuevas listas.

ciele flows catalog

Comprueba un Flow antes de guardarlo

flows draft comprueba un cambio en un Flow. flows validate comprueba un Flow completo. Ninguno de los dos comandos guarda nada. Ambos te muestran el flujo que Ciele almacenaría.

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

Úsalos sobre todo por una razón: cuando un Flow escribe en un conector, Ciele añade una acción de revisión humana antes de esa escritura. Estos dos comandos te muestran la acción añadida. Al guardar, se hace de forma silenciosa.

Observa un flujo HTTP

Un flujo con el desencadenante HTTP mantiene un registro de cada llamada entrante.

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

Las conversaciones no incluyen estas ejecuciones, porque una llamada entrante no es una conversación.

Comandos de Teammate

Dale a un Teammate sus capacidades

Un nuevo Teammate de IA puede responder preguntas. No puede actuar hasta que le concedas un dominio, y no realiza ningún trabajo de forma autónoma hasta que le asignes una 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 envía el conjunto completo de dominios cada vez. --domains "" los elimina todos. Este comando requiere una clave de API con el rol de administrador o superior, ya que permite que un agente modifique tus datos. Los demás comandos de Teammate requieren el rol Editor.

Un Teammate puede tener un máximo de cinco Routines.

Configura un compañero de equipo con un solo comando

teammates create crea un compañero de equipo que responde a las preguntas. No puede actuar y no realiza ningún trabajo desatendido. teammates provision realiza los tres pasos a la vez.

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

El orden es crear, luego conceder y después programar. Si un paso falla, el comando te indica dónde se detuvo. El compañero de equipo se puede seguir utilizando hasta ese momento.

Una clave sin el rol de administrador puede crear al compañero de equipo. No puede conceder un dominio. A continuación, el comando informa de que se detuvo en el paso de concesiones.

Proyectos y memoria

Un Project es un espacio de trabajo compartido. Un compañero de IA vinculado a un proyecto lee el documento de memoria de ese proyecto en cada turno.

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 y set-memory reemplazan el texto completo. Ciele conserva el texto anterior en el historial del documento.

No hay ningún comando para tu propia capa de memoria. Una clave API actúa como el miembro que la creó, por lo que un comando aquí mostraría el documento privado de ese miembro. En la consola, ve a Configuración y luego a Memoria.

Comandos de Operations y Organization

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

Los comandos que eliminan datos requieren --yes. No se puede eliminar el flujo de comportamiento predeterminado.

Ejecuta ciele help para cada grupo de comandos y opción aceptada. Añade --file cuando un comando acepte una entrada JSON completa o un parche.

Ejemplo de comprobación de CI

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

Guarda todos los valores en el almacén de secretos de CI. No escribas una clave en un archivo de flujo de trabajo.

En esta página