edgeplane & edgeplaned CLI
edgeplane — Operator CLI
Section titled “edgeplane — Operator CLI”edgeplane is the primary operator and agent interface. All interactivity: fleet views, agent launch, capability dispatch, and the TUI.
Global Flags
Section titled “Global Flags”| Flag | Meaning |
|---|---|
--base-url <URL> | Control plane base URL (overrides EP_BASE_URL) |
--json | Output as JSON |
Environment Variables
Section titled “Environment Variables”| Variable | Default | Purpose |
|---|---|---|
EP_BASE_URL | http://localhost:8008 | Backend HTTP base URL |
EP_OUTPUT | human | Default output format |
Auth is handled automatically via ~/.edgeplane/session.json (OIDC session from edgeplane auth login), the node JWT at /etc/edgeplane/node.json (for edgeplaned), or a service account token passed as a Bearer header for CI. No static token env var is used.
Core Commands
Section titled “Core Commands”Status and Health
Section titled “Status and Health”edgeplane status [--verify-lease] # combined auth / runtime / workspace statusedgeplane doctor # shortcut to edgeplane system doctoredgeplane health [--json] # backend connectivity and MCP health probeedgeplane version # local CLI version + backend reachabilityedgeplane config # effective local runtime config (secrets redacted)edgeplane tui [--domain <id>]Full-screen terminal UI. Server and token come from env or ~/.edgeplane/session.json.
| Key | Tab | Description |
|---|---|---|
a | Agents | Fleet nodes — status, current task, ops |
m | Domains | Domains → Missions → Tasks (Enter to drill down) |
f | Feed | Live SSE event stream (p to pause) |
p | Approvals | Pending approval queue (y approve / n deny / s skip) |
s | Secrets | Infisical folder/secret browser (read-only) |
c | Config | Connection status and server info |
| Ctrl+Q / Ctrl+C | Quit |
edgeplane auth login [--ttl-hours N] [--print-token] # exchange credentials for a session tokenedgeplane auth whoami # verify identity and session expiryedgeplane auth logout [--local-only] # revoke server-side and clear local fileSession tokens (ep_* prefix) are stored at ~/.edgeplane/session.json (chmod 600). They are never written to agent config files on disk — injected at exec time only.
Agent Launch
Section titled “Agent Launch”edgeplane run <runtime> [options]| Runtime | Description |
|---|---|
claude | Claude Code with EdgePlane MCP wired in (ACP persistent session) |
codex | OpenAI Codex CLI (driver agent) |
gemini | Google Gemini CLI (driver agent) |
openclaw | OpenClaw (driver agent) |
custom | Custom ACP agent (driver) |
Common flags:
edgeplane run claude [-p <profile>] [--mission <id>] [--mode interactive|headless|solo] [-- args]edgeplane run codex [-p <profile>] [--mission <id>] [--mode interactive|headless|solo] [-- args]edgeplane run gemini [-p <profile>] [-- args]edgeplane run openclaw [-- args]edgeplane run custom [-- args]edgeplane launch was removed in v0.13.0. All agents launch through edgeplane run.
Diagnostics:
edgeplane run claude doctor [-p <profile>] [--fix] [--json]edgeplane run codex doctor [-p <profile>] [--fix] [--json]edgeplane run codex status [-p <profile>] [--json]Workspace Lease
Section titled “Workspace Lease”edgeplane use --mission-id <id> [--lease-seconds N] [--workspace-label <label>]edgeplane use --releaseedgeplane release [--reason <text>] [--ignore-missing]Agent Management
Section titled “Agent Management”edgeplane agent signal <id> --content "..." # send a prompt to an agentedgeplane agent list [--source local|remote|all] [--json]edgeplane agent describe <id> [--json]edgeplane agent attach <id> [--web] [--remote]edgeplane agent cancel <id>Scheduled Jobs (edgeplane agent cron)
Section titled “Scheduled Jobs (edgeplane agent cron)”edgeplane agent cron list [--json]edgeplane agent cron describe <name> [--limit N] [--json]edgeplane agent cron reload # re-parse cron.tomledgeplane agent cron history [--name <n>] [-n N] [--json]edgeplane agent cron gc-now [--history-days N]Jobs are defined in ~/.edgeplane/edgeplaned/cron.toml. See edgeplaned Daemon for the format.
Supervision (edgeplane agent supervise)
Section titled “Supervision (edgeplane agent supervise)”edgeplane agent supervise list [--json]edgeplane agent supervise status <id> [--limit N] [--json]edgeplane agent supervise restart <id>edgeplane agent supervise pause [<id>] [--all]edgeplane agent supervise resume [<id>] [--all]edgeplane agent supervise history [--agent-id <id>] [-n N] [--json]edgeplane agent supervise events [--json] # stream live supervisor eventsedgeplane agent supervise watch [--poll-secs N] # ratatui TUIProfiles
Section titled “Profiles”edgeplane profile listedgeplane profile show --name <name>edgeplane profile create --name <name> [--description "..."] [--activate]edgeplane profile activate --name <name> # atomic symlink swapedgeplane profile use --name <name> # activate + pull in one stepedgeplane profile publish --name <name> # upload local bundle → serveredgeplane profile pull --name <name> # pull bundle into local profile cache (use --apply to activate)edgeplane profile download --name <name> [--out <file>] # save bundle to a local fileedgeplane profile pin --name <name> --sha256 <hash>edgeplane profile status --name <name> # local sync status vs backendedgeplane profile delete --name <name> --confirm-deleteCapabilities
Section titled “Capabilities”edgeplane capabilities [--tag <tag>] # list capability packsedgeplane capabilities describe <pack>.<capability>edgeplane exec <pack>.<capability> --json [--dry-run]edgeplane receipts last [--json]Data and System
Section titled “Data and System”edgeplane data tools listedgeplane data tools call --tool <name> --payload '<json>'edgeplane data explorer treeedgeplane data explorer node ...
edgeplane system doctor [--fix]edgeplane system backup --target postgres|rustfs|alledgeplane system profile-gc ...edgeplane system update ...Utility
Section titled “Utility”edgeplane init # initialize local configurationedgeplane serve # start MCP stdio server (used by agents)edgeplane logs # local log tailedgeplane completion <shell> # shell completion generatoredgeplaned Daemon
Section titled “edgeplaned Daemon”See edgeplaned Daemon for the full reference.
Quick commands:
edgeplaned run --backend-url http://localhost:8008edgeplaned versionedgeplaned get-secret MY_API_KEY # inside agent subprocess onlyedgeplane-tower Server
Section titled “edgeplane-tower Server”edgeplane-tower --bind 0.0.0.0:8008Use --no-migrate to skip database migrations on startup.
Native routes: /api/health, /raft/status, /domains, /missions, /tasks, /agents.
curl http://your-tower-host:8008/api/healthcurl http://your-tower-host:8008/raft/statusMachine-Readable Output
Section titled “Machine-Readable Output”All commands support --json for structured output. Always use --json when parsing programmatically — human-readable output format is not stable across releases.
edgeplane status --jsonedgeplane health --jsonedgeplane agent list --json