grouter: Instructions file for Codex

AGENTS.md

This file provides guidance to Codex (Codex.ai/code) when working with code in this repository.

Project

grouter (package grouter-auth) is a CLI + local OpenAI-compatible proxy that aggregates OAuth and API-key accounts across 15+ AI providers (Qwen, GitHub Copilot, Codex, Codex, Gemini, Kimi, Kiro, KiloCode, GitLab Duo, Cursor, OpenRouter, Groq, DeepSeek, etc.) behind a single local endpoint. Built as a Bun single-file binary — no external services, state lives in ~/.grouter/grouter.db (SQLite).

Commands

bun run dev             # bun --hot index.ts serve fg  (foreground, hot-reload)
bun run start           # Foreground proxy (no hot-reload)
bun run build           # Pre-embeds logos, bundles to dist/grouter (chmod +x)
bun run deploy          # build + bun link — refresh the globally-linked binary
bun test                # Run Bun tests (none currently — add alongside code)
bun test path/to/file.test.ts   # Single test file

# CLI (once built + linked, or via `bun index.ts <cmd>`)
grouter setup             # First-run wizard
grouter add               # Arrow-key picker → add a provider connection
grouter serve on|off|fg|logs|restart|status
grouter models [provider]
grouter up openclaude [--provider X --model Y]
grouter list | test [id] | enable/disable <id> | remove <id> | unlock [id]
grouter config [--strategy fill-first|round-robin] [--port N] [--sticky-limit N]

The prebuild script (scripts/embed-logos.ts) reads src/public/logos/*.png and emits src/web/logos-embedded.ts with base64 constants — this is what makes logos work inside the single-file bundled binary. Never edit logos-embedded.ts by hand.

Architecture

Entry point and command layer

index.ts wires commander subcommands to handlers in src/commands/*.ts. The hidden _daemon subcommand is the entrypoint the detached background proxy spawns — never call it directly.

Proxy server (src/proxy/)

serve on spawns a detached child (_daemon) that runs startAllServers():

• Router on :3099 (configurable) — picks any active account across all providers using the rotation strategy.
• Per-provider listeners on :3100+ — each provider with registered accounts gets its own Bun.serve instance that pins the provider on every request. Port allocation lives in the provider_ports table.