Skip to Content
CLI Reference

CLI Reference

CLI pre-beta: The cendriix npm package is not published yet. Design partners use the web app at app.cendriix.ai. Commands below are the target interface.

Overview

CommandDescription
cendriix initCreate a new workspace
cendriix loginAuthenticate the CLI
cendriix runTrigger and manage runs
cendriix logsStream run logs
cendriix workspaceManage workspaces and connectors
cendriix replayTime-travel replay of past runs
cendriix policyManage guardrail policies
cendriix auditQuery and export audit events

cendriix init

Scaffolds a workspace configuration and authenticates the session.

cendriix init [workspace-slug]
FlagDefaultDescription
--regionus-east-1Primary cloud region
--planstarterBilling plan: starter, growth, enterprise
--no-browserPrint the auth URL instead of opening a browser tab

cendriix login

Authenticates or re-authenticates the CLI.

cendriix login [--workspace <slug>] cendriix login --token $CENDRIIX_TOKEN # CI / non-interactive

cendriix run

Trigger a workflow run, approve/reject a paused run, or cancel.

cendriix run <workflow> [options] cendriix run approve --run <run-id> cendriix run reject --run <run-id> [--note "reason"] cendriix run cancel --run <run-id>
FlagDescription
--ticketJira / Linear ticket key to attach
--dry-runPlan without executing; print agent chain + estimated cost
--envTarget environment: preview, staging, production
--modelOverride the default LLM
--runRun ID for approve/reject/cancel. Use latest shorthand
--noteHuman note attached to approve/reject events
cendriix run ship-from-ticket --ticket JIRA-3421 cendriix run approve --run latest --note "LGTM"

cendriix logs

Stream or retrieve structured logs.

cendriix logs [--run <run-id>] [--follow] [--level <level>]
FlagDefaultDescription
--runlatestRun ID
--followfalseStream live logs (SSE)
--levelinfoMinimum: debug, info, warn, error
--outputprettyFormat: pretty or json

cendriix workspace

cendriix workspace list cendriix workspace switch <slug> cendriix workspace cloud connect --provider aws cendriix workspace cloud disconnect --provider aws

cendriix replay

cendriix replay <run-id> [--step <n>] [--policy <file>]

cendriix policy

cendriix policy list cendriix policy apply <file.yaml> cendriix policy validate <file.yaml> cendriix policy diff <file.yaml>

cendriix audit

cendriix audit [--run <run-id>] [--from <date>] [--to <date>] [--format json|csv]

Global flags

FlagDescription
--workspaceOverride the active workspace
--outputpretty (default), json, yaml
--verboseEnable debug logging
--no-colorDisable ANSI colour output

Environment variables

VariableDescription
CENDRIIX_TOKENService-account token for non-interactive auth
CENDRIIX_WORKSPACEDefault workspace slug
CENDRIIX_API_URLOverride API base URL (default: https://api.cendriix.ai/v1)
Last updated on