Skip to content

CLI

Routeplane ships as one static binary, routeplane, with no dependencies to install. It runs the local router your agent talks to, and gives you a scriptable command-line surface to control it.

Your agent never talks to a remote API directly — it points at the binary running locally, by default on http://127.0.0.1:4356. Everything else in these docs — the four model protocols, the MCP and ACP gateways — is served from that one endpoint.

You run it as a daemon and control its lifecycle:

  • routeplane serve — run the router in the foreground.
  • routeplane start / stop / restart / status — manage it as a background daemon.
  • routeplane reload — hot-reload the config and routing table without a restart.
Terminal window
routeplane init # scaffold ./routeplane.yaml
routeplane providers list # every configured provider + auth status
routeplane providers login <provider> # interactive credential setup (OAuth device-code or key)
routeplane providers logout <provider> # clear stored credentials
routeplane models # list routable models
routeplane route <model> # resolve a model through the routing table
routeplane status # daemon pid, listen address, model count
routeplane observe status # OTel exporter state
routeplane update # self-update the binary in place

Every command accepts --json (the default; agent-native) or --human for a readable rendering.

Also in the binary: routeplane config (config validation against the published schema), routeplane key (virtual-key management), routeplane policy, routeplane tools (MCP server introspection), routeplane agents / agent-proxy (ACP), routeplane spawn (launch a coding-agent harness pointed at the local daemon), routeplane skills, and routeplane mcp. Run any of them with --help for details.

**Routeplane Cloud is on the Phase D roadmap and not yet shipping.** The shipped binary carries a minimal `routeplane cloud` stub — `cloud login` currently reports *not available* — and the Cloud endpoints do not respond yet. Self-host with your own provider keys today (see [Installation](/get-started/installation)).

The v0.1.0 binary ships three Cloud account commands:

Terminal window
routeplane cloud login # sign in to Routeplane Cloud (currently disabled — Cloud not yet live)
routeplane cloud logout # clear the stored Cloud credential
routeplane cloud status # show current Cloud account status

Once Cloud ships, this surface grows into full account management — API keys, usage and request history, billing, policies (budgets, rate limits, guardrails, presets), BYOK key submission, and OAuth client registration — all scriptable and --json-friendly. That expanded surface is documented as it lands; treat any routeplane cloud <resource> command beyond the three above as planned, not shipped.