Quick Start

This guide walks you from zero to a running agent session. Assumes you’ve completed Installation.

1. Start the Control Plane

If you’re running locally:

edgeplane-tower --bind 127.0.0.1:8008

If you have a deployed instance, point the CLI at it:

export EP_BASE_URL="https://edgeplane.example.com"

2. Authenticate

edgeplane auth login       # opens a browser OIDC flow → writes ~/.edgeplane/session.json
edgeplane auth whoami      # confirm identity and token expiry

After auth login succeeds, edgeplane picks up the session automatically from ~/.edgeplane/session.json — no further credential management needed.

3. Verify the Connection

edgeplane health --json
edgeplane status           # shows auth, runtime, and workspace lease status

health --json reports {"ok": true, ...} when the tower is reachable. status shows auth, runtime, and workspace context (no top-level ok field). If health fails, confirm EP_BASE_URL is set and the tower is reachable.

4. Launch an Agent

edgeplane run claude         # Claude Code with EdgePlane MCP wired in
edgeplane run codex          # OpenAI Codex CLI
edgeplane run gemini         # Google Gemini CLI

edgeplane run validates your environment, fetches the onboarding manifest, and injects EdgePlane as an MCP server before handing off to the agent binary. No manual MCP config required.

5. Explore the Fleet

edgeplane tui

The TUI gives you a full-screen fleet view. Key bindings: a — agents, m — domains, f — live event feed, s — secrets, c — config.

What’s Next

Agent Setup — per-agent config, ACP runtime, profile loading
Concepts: Domains, Missions & Tasks — the organizational model
Guides: Deployment — running EdgePlane in production