Choose a RouteKit workflow

Use this page as a map. Each linked guide has one job, its own prerequisites, and a clear result, so you can read only the path that matches what you are trying to do.

Choose your starting point

Run the quickstart

Let your agent handle setup, or configure and verify one working route yourself.

Understand the architecture

Learn how the CLI, daemon, data plane, and control plane fit together.

If RouteKit is already running, choose the client or workflow you need below.

Connect a coding tool or HTTP client

Connect coding tools

Launch qualified Codex or Claude Code builds, or install persistent native-client settings.

Check supported coding tool versions

See the exact Codex and Claude Code builds qualified with RouteKit.

Call the HTTP gateway

Authenticate and send OpenAI, Responses, or Anthropic-compatible requests.

For an interactive coding session, choose a launcher and run it from your project:

routekit codex
routekit claude

The native client opens in the current directory with a suitable startup model. Use its model picker to switch among compatible RouteKit routes. Pass an exact provider/model only when a script, reproducible run, or one-off comparison must control the startup model.

RouteKit's TypeScript packages are not tested or supported as a public embedded API. Applications should use the CLI-managed daemon and authenticated HTTP gateway. See TypeScript API status for the boundary.

Configure providers and routing

Configure providers and models

Set provider credentials, the default model, aliases, catalog policy, and retention.

Pool subscription accounts

Enroll Claude Code or Codex accounts and configure same-provider rotation.

Set up AWS Bedrock

Apply least privilege, run preflight checks, and verify a Bedrock route.

Canonical model IDs are always provider/native-model. A request never falls through to another provider or billing class when its selected route is unavailable.

Monitor and troubleshoot

Monitor and operate RouteKit

Inspect health, account activity, quota, calls, logs, and retained rollups.

Set up a remote gateway

Provision through SSH and connect through an operator-managed HTTPS front door.

Troubleshoot a failure

Diagnose daemon startup, missing models, subscription routes, remotes, and configuration.

Update or remove RouteKit

Most RouteKit work follows the same five-stage loop:

Configure a provider or enroll a subscription account.
Verify live discovery with routekit providers status and routekit models list.
Connect a coding tool or authenticated HTTP client.
Observe health, usage, and call attribution.
Diagnose with routekit doctor and daemon logs when a route stops behaving as expected.

Use the command reference when you already know the task and only need exact syntax.

Before shared or production use

Review router configuration for provider, model, authentication, and network settings.
Read privacy and stored data.
Use an exact build listed in supported coding tool versions.
Keep the default loopback bind unless an authenticated network boundary is intentional.
Use named data-plane tokens instead of sharing the private owner token.

Develop from source

Contributors can follow develop from source for the repository toolchain, verification commands, and package map.