English · 简体中文
This is the user entry point — start here to install the gateway, call the OpenAI-compatible API, connect coding agents and understand the high-level architecture. The root README is the product overview; this index gets you running.
- Install & deploy — quick start, Docker Compose, local development, declarative startup config, the Docker image, backups, the desktop app, where your data lives, and an FAQ on password resets, logs and uninstalling.
- API reference — chat completions,
auto:*routing strategies, streaming, tool calling, vision, Gemini Google Search grounding, embeddings, response headers, and the Anthropic Messages surface. - Clients & coding agents — OpenAI-compatible clients, recipes for Claude Code / Codex CLI / Cline / Continue / Aider / opencode / Cursor, the MCP server, editor autocomplete, and Context Handoff.
- Prompt compression — request-side modes, safeguards, per-request controls, custom tool-output filters, statistics, and preview APIs.
- Fetch Relay — route provider HTTP requests through a user-controlled, streaming application-layer relay.
- Architecture & internals — how the router works, routing and operational details, what's not supported, honest limitations, and the provider Terms-of-Service review.
- Android with Termux — experimental local installation using Node's built-in SQLite driver.
- Fallback chains — named fallback-chain lifecycle, empty-chain authoritative 400,
auto:<name>routing, and catalog-sync backfill. - Docker deployment — container configuration and persistent storage.
- Desktop app — build and package the Electron application.
- Contributor guide — development loop, testing expectations, and contribution policy.
- Database migrations — create, apply, inspect, and roll back schema migrations.
index.html— project landing page.install.sh— Unix Docker bootstrap script.install.ps1— PowerShell bootstrap script.success.html— post-install success page.