Quick Start
This guide walks you from zero to a running agent session. Assumes you’ve completed Installation.
1. Start the Control Plane
Section titled “1. Start the Control Plane”If you’re running locally:
edgeplane-tower --serve --bind 127.0.0.1:8008If you have a deployed instance, set EP_BASE_URL to point to it.
2. Configure Your Connection
Section titled “2. Configure Your Connection”export EP_BASE_URL="http://localhost:8008" # or your deployed URLVerify connectivity:
edgeplane health --json3. Create a Session Token (recommended)
Section titled “3. Create a Session Token (recommended)”Exchange your credentials for a revocable session token that’s never written to agent config files:
edgeplane auth login # creates ~/.edgeplane/session.jsonedgeplane auth whoami # confirm identityAfter this, EP_TOKEN is no longer needed in the environment — edgeplane picks up the session automatically.
4. Launch an Agent
Section titled “4. Launch an Agent”edgeplane run claude # Claude Codeedgeplane run codex # OpenAI Codex CLIedgeplane run gemini # Google Gemini CLIedgeplane run validates your environment, fetches the onboarding manifest, and launches the agent with EdgePlane wired in as an MCP server.
5. Create Your First Domain
Section titled “5. Create Your First Domain”Inside the running agent, or via the CLI:
edgeplane statusOr open the TUI for a full fleet view:
edgeplane tuiThe TUI gives you real-time agent status, domain/mission/task drill-down, a live event feed, and a pending approvals queue.
What’s Next
Section titled “What’s Next”- Agent Setup — per-agent config, MCP server setup, auth modes
- Concepts: Domains, Missions & Tasks — the organizational model
- Guides: Deployment — running EdgePlane in production