Skip to main content
The Sentrial CLI ships with @sentrial/sdk as the sentrial binary. It is designed for humans and agents: local setup, scriptable inspection, and CI checks all use API-key auth instead of browser login.

​
Install

From the root of an agent repo: 
curl -fsSL https://raw.githubusercontent.com/sentrialdev/Sentrial/main/scripts/install.sh | bash
The installer bootstraps the CLI through npm, installs the right SDK package for the project, and writes safe example files without committing a real API key.

​
Authentication

Agents should use API keys from organization settings: 
export SENTRIAL_API_KEY=sentrial_live_xxx
For local human use, you can save the key once: 
sentrial login --api-key sentrial_live_xxx
The CLI resolves credentials in this order:
  1. --api-key
  2. SENTRIAL_API_KEY
  3. ~/.sentrial/config.json
Use --api-url or SENTRIAL_API_URL for self-hosted or local API targets.

​
Setup Commands

# Install the SDK and scaffold example integration files
sentrial install

# Preview without changing files
sentrial install --dry-run

# Scaffold examples only
sentrial init

# Force language detection when a repo is ambiguous
sentrial init --language python
sentrial init --language typescript
Generated examples use placeholder API keys, so they are safe to commit as references.

​
Sessions

# List recent sessions
sentrial sessions list

# Filter by time, status, or local agent name
sentrial sessions list --last 7d --status failed --agent support

# Print JSON for scripts and agents
sentrial sessions list --json

# Fetch one session and its events
sentrial sessions get <session-id>

# Fetch a session without events
sentrial sessions get <session-id> --no-events

​
Events

# List all events for a session
sentrial events list <session-id>

# Filter event type
sentrial events list <session-id> --type tool_call

# Machine-readable output
sentrial events list <session-id> --json

​
Signals And Diagnosis

# List detected signals
sentrial signals list --last 30d

# Filter signal type or source
sentrial signals list --type negative --source heuristic

# Diagnose a failed session from its event timeline
sentrial diagnose <session-id>

​
CI Gates

Use evaluate in scripts to fail a build when an experiment regresses: 
sentrial evaluate <experiment-id> --min-score 80 --max-regression 5
For agent automation, prefer JSON: 
sentrial evaluate <experiment-id> --min-score 80 --json

​
Reserved Commands

These commands are intentionally present but guarded until the backing APIs are public: 
sentrial clusters
sentrial fix <session-id>
sentrial replay <session-id>