@opentrust/cli

CLI tool to manage OpenTrust — an open-source AI Agent Runtime Security Platform.

Install

npm install -g @opentrust/cli

Or run directly with npx:

npx @opentrust/cli <command>

Quick Start

# 1. Initialize project (clone repo into current directory)
mkdir my-project && cd my-project
opentrust init

# 2a. Local mode — install dependencies and start
opentrust setup
opentrust start

# 2b. Docker mode — build and start via Docker Compose
opentrust start --docker

Commands

| Command | Description | |---------|-------------| | opentrust init | Clone OpenTrust repository into current directory | | opentrust setup | Install dependencies, build, and initialize databases | | opentrust start [service] | Start services (core, dashboard, gateway, or all) | | opentrust stop [service] | Stop services | | opentrust status | Show status of all services | | opentrust logs <service> | Tail logs for a service |

Docker Mode

All service commands support --docker (-d) flag to use Docker Compose:

opentrust start --docker        # docker compose up -d --build
opentrust stop --docker         # docker compose down
opentrust status --docker       # docker compose ps + health checks
opentrust logs --docker core    # docker compose logs core
opentrust setup --docker        # docker compose build

Init Options

opentrust init --repo <url>     # Custom git repository URL
opentrust init --branch <name>  # Specific branch (default: main)

Services

| Service | Port | Description | |---------|------|-------------| | Core | 53666 | Security engine — content detection (S01-S10), behavior assessment | | Dashboard | 53667/53668 | Management panel — Agent assets, risk graph, policies, logs | | Gateway | 8900 | AI security gateway — LLM API proxy with PII/credential sanitization |

Prerequisites

Docker mode (recommended):

• Docker >= 20.10
• Docker Compose >= 2.0

Local mode:

• Node.js >= 18 (Gateway requires >= 22)
• pnpm >= 9 (Dashboard uses pnpm monorepo)

Environment Variables

| Variable | Description | |----------|-------------| | OPENTRUST_HOME | Override the project root directory (defaults to cwd) |

License

Apache-2.0