CLI Reference
DROID+ ships as a single binary with a set of subcommands for managing AI agent runtimes.
droid
DROID+ — Headless AI Agent Runtime Engine. Like nginx serves websites, DROID+ serves AI agents. One binary, one config, production-ready agents in minutes.
Usage:
droid [command]
Available Commands:
| Command | Description |
|---|---|
init | Initialize a new DROID+ project |
up | Start the DROID+ runtime |
down | Stop a running DROID+ instance |
agents | List running agents |
agents reload | Hot-reload agent configurations |
health | Check DROID+ server health |
version | Print version information |
Global Flags:
| Flag | Description |
|---|---|
-h, --help | Help for droid |
droid init
Create a new directory with a minimal DROID+ configuration, example agent, and .env template.
Usage:
droid init [project-name]
Arguments:
project-name— Name of the directory to create (default:my-agent)
Example:
droid init skincare-bot
cd skincare-bot
Created files:
droid.yaml— Main configurationconfigs/agents/example.yaml— Example agent config.env.example— Environment variables template
droid up
Start the DROID+ AI agent runtime with OpenAI-compatible API and Management API.
Usage:
droid up [flags]
Flags:
| Flag | Type | Default | Description |
|---|---|---|---|
--config, -c | string | auto-detect | Path to config file |
--daemon, -d | bool | false | Run in background (use systemd/docker for production) |
Examples:
# Start with auto-detected config
droid up
# Start with specific config file
droid up --config /etc/droid/droid.yaml
# Start in background
droid up -d
droid down
Send SIGTERM to the running DROID+ process using the PID file.
Usage:
droid down
Example:
droid down
droid agents
Query the Management API to list all loaded agents and their status.
Usage:
droid agents [flags]
Flags:
| Flag | Type | Default | Description |
|---|---|---|---|
--port | int | 8081 | Management API port |
Example:
# List agents on default port
droid agents
# List agents on custom management port
droid agents --port 9091
droid agents reload
Hot-reload agent configurations without restarting the runtime. Reads the agents directory and applies any changes.
Usage:
droid agents reload
Example:
# Add a new agent YAML, then reload
cp new-agent.yaml configs/agents/
droid agents reload
droid health
Probe the OpenAI-compatible API and Management API health endpoints.
Usage:
droid health [flags]
Flags:
| Flag | Type | Default | Description |
|---|---|---|---|
--openai-port | int | 8080 | OpenAI API port |
--management-port | int | 8081 | Management API port |
Example:
# Check health on default ports
droid health
# Check health on custom ports
droid health --openai-port 9080 --management-port 9081
droid version
Print DROID+ version information.
Usage:
droid version [flags]
Flags:
| Flag | Description |
|---|---|
--json | Output as JSON |
Example:
droid version
# DROID+ v0.5.0 (community) built ...
droid version --json
# {"version":"0.5.0","edition":"community","commit":"...","build_time":"..."}