Skip to content

edgeplane & edgeplaned CLI

edgeplane is the primary operator and agent interface. All interactivity: fleet views, agent launch, capability dispatch, and the TUI.

FlagMeaning
--base-url <URL>Control plane base URL (overrides EP_BASE_URL)
--jsonOutput as JSON
VariableDefaultPurpose
EP_BASE_URLhttp://localhost:8008Backend HTTP base URL
EP_OUTPUThumanDefault 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.


Terminal window
edgeplane status [--verify-lease] # combined auth / runtime / workspace status
edgeplane doctor # shortcut to edgeplane system doctor
edgeplane health [--json] # backend connectivity and MCP health probe
edgeplane version # local CLI version + backend reachability
edgeplane config # effective local runtime config (secrets redacted)
Terminal window
edgeplane tui [--mission <id>]

Full-screen terminal UI. Server and token come from env or ~/.edgeplane/session.json.

KeyTabDescription
aAgentsFleet nodes — status, current task, ops
mDomainsDomains → Missions → Tasks (Enter to drill down)
fFeedLive SSE event stream (p to pause)
pApprovalsPending approval queue (y approve / n deny / s skip)
sSecretsInfisical folder/secret browser (read-only)
cConfigConnection status and server info
Ctrl+Q / Ctrl+CQuit

Terminal window
edgeplane auth login [--ttl-hours N] [--print-token] # exchange credentials for a session token
edgeplane auth whoami # verify identity and session expiry
edgeplane auth logout [--local-only] # revoke server-side and clear local file

Session tokens (mcs_* prefix) are stored at ~/.edgeplane/session.json (chmod 600). They are never written to agent config files on disk — injected at exec time only.


Terminal window
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 launch openclaw # OpenClaw
edgeplane launch custom # Custom ACP agent

Diagnostics:

Terminal window
edgeplane run claude doctor [-p <profile>] [--fix] [--json]
edgeplane run codex doctor [-p <profile>] [--fix] [--json]
edgeplane run codex status [-p <profile>] [--json]

Flags for edgeplane launch (non-Claude/Codex agents):

FlagEffect
--preflight-onlyValidate env + auth without launching
--no-daemonSkip daemon management
--skip-config-genUse existing config, skip manifest fetch
--no-embed-tokenOmit token from written config
--legacy-global-configWrite config to global agent paths
--daemon-timeout NSeconds to wait for daemon ready (default: 15)
-- <args>Pass remaining args verbatim to the agent

Terminal window
edgeplane use --mission-id <id> [--lease-seconds N] [--workspace-label <label>]
edgeplane use --release
edgeplane release [--reason <text>] [--ignore-missing]

Terminal window
edgeplane agent signal <id> --content "..." # send a prompt to an agent
edgeplane agent list [--source local|remote|all] [--json]
edgeplane agent describe <id> [--json]
edgeplane agent attach <id> [--web] [--remote]
edgeplane agent cancel <id>
Terminal window
edgeplane agent cron list [--json]
edgeplane agent cron describe <name> [--limit N] [--json]
edgeplane agent cron reload # re-parse cron.toml
edgeplane 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.

Terminal window
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 events
edgeplane agent supervise watch [--poll-secs N] # ratatui TUI

Terminal window
edgeplane profile create <name>
edgeplane profile list
edgeplane profile show <name>
edgeplane profile activate <name> # atomic symlink swap
edgeplane profile use <name> # activate + download in one step
edgeplane profile download <name> [--out <path>]
edgeplane profile pull <name>
edgeplane profile publish <name>
edgeplane profile pin <name> <sha256>
edgeplane profile status <name>
edgeplane profile delete <name>

Terminal window
edgeplane capabilities [--tag <tag>] # list capability packs
edgeplane capabilities describe <pack>.<capability>
edgeplane exec <pack>.<capability> --json [--dry-run]
edgeplane receipts last [--json]

Terminal window
edgeplane data tools list
edgeplane data tools call --tool <name> --payload '<json>'
edgeplane data sync status --domain-id <id> [--mission-id <id>]
edgeplane data sync promote ...
edgeplane data explorer tree
edgeplane data explorer node ...
edgeplane system doctor [--fix]
edgeplane system backup --target postgres|s3|all
edgeplane system profile-gc ...
edgeplane system update ...

Terminal window
edgeplane approvals list
edgeplane approvals approve <id>
edgeplane approvals reject <id>
edgeplane admin policy active
edgeplane admin policy versions
edgeplane admin policy events
edgeplane admin governance ...

Terminal window
edgeplane init # initialize local configuration
edgeplane serve # start MCP stdio server (used by agents)
edgeplane logs # local log tail
edgeplane completion <shell> # shell completion generator

See edgeplaned Daemon for the full reference.

Quick commands:

Terminal window
edgeplaned run --backend-url http://localhost:8008
edgeplaned version
edgeplaned get-secret MY_API_KEY # inside agent subprocess only

Terminal window
edgeplane-tower --serve --bind 0.0.0.0:8008

Native routes: /health, /raft/status, /domains, /missions, /tasks, /agents.

Terminal window
curl http://localhost:8008/health
curl http://localhost:8008/raft/status

All commands support --json for structured output. Always use --json when parsing programmatically — human-readable output format is not stable across releases.

Terminal window
edgeplane status --json
edgeplane health --json
edgeplane agent list --json