Skip to content
Routeplane

Installation

Routeplane runs as a local proxy — a single binary on your machine. It’s fully open-source under Apache 2.0 with your own provider keys. No cloud dependency, no vendor lock-in.

Routeplane Cloud is on the roadmap as an optional managed overlay. See the product roadmap for details.

Install the binary

Section titled “Install the binary”

Install from the v0.1.0 source tarball — the one method that works publicly today. Requires the Rust toolchain; the build takes ~2 minutes.

Terminal window
curl -L -O https://routeplaneapp.vercel.app/downloads/routeplane-v0.1.0-source.tar.gz
tar -xzf routeplane-v0.1.0-source.tar.gz
cd johnmwhitman-routeplane-*/
cargo install --path apps/routeplane

The tarball is also available from the GitHub release.

Other install methods: Once Routeplane is published to crates.io, cargo install routeplane will be the one-liner. Homebrew (brew install routeplane/tap/routeplane) and Docker are also in progress; see the product roadmap.

Set your provider keys in the environment and start the proxy:

Terminal window
export OPENAI_API_KEY=sk-...    # ANTHROPIC_API_KEY / GOOGLE_API_KEY also work
routeplane start
# Proxy running at http://127.0.0.1:4356

Routeplane auto-detects any key set in the environment — no config file needed. Any provider whose key is present is immediately available. See BYOK for the full list of recognized variables, or local & private models to point Routeplane at Ollama, vLLM, or LM Studio for free.

For advanced routing rules, guardrails, or multi-account failover, scaffold a config file:

Terminal window
routeplane init          # writes ./routeplane.yaml (override with `-c <path>`)
routeplane start

Use Routeplane Cloud

Section titled “Use Routeplane Cloud”

Not yet shipping. Routeplane Cloud is on the roadmap (Phase D, ~90–180 days) as an optional managed overlay. For now, self-host with your own provider keys using the methods above. See Self-host vs Cloud and the product roadmap for what Cloud will add.

Point your agent at the proxy

Section titled “Point your agent at the proxy”

However you start it, Routeplane is a drop-in proxy. Point your agent runtime at the proxy base URL — http://127.0.0.1:4356 when self-hosting — and every model call routes through Routeplane with no harness changes.