theRizwan / FlagshipRouter

# FlagshipRouter
**Free AI models for every coding tool.** FlagshipRouter is a local AI gateway that connects Claude Code, Codex, Cursor, Cline, OpenCode and other coding tools to free AI models through one OpenAI-compatible endpoint.
- **Free providers only.** The dashboard, management APIs and routing only expose providers with a free offer (Kiro, OpenCode Free, OpenRouter free models, NVIDIA NIM, Groq, Cloudflare Workers AI, Ollama, self-hosted servers and more).
- **A Models screen instead of a provider list.** Every model from every free provider in one searchable table, with a ready/connect status and a one-click test.
- **One place to rename.** Product name, CLI command, data folder, the prefix your tools show on models, and the provider policy all live in `brand.json`.
- **Starts with one command.** Running `flagshiprouter` starts the server and opens the browser UI.
## Quick start
Requires Node.js 20.9 or newer (22 recommended).
 [code] 
`npm run launch` installs the dependencies, builds the app (a few minutes, first run only), and starts the CLI. The server runs on port `20128` and the dashboard opens in your browser; the terminal keeps a small menu (open browser UI, terminal UI, hide to tray, exit). Later runs start in seconds and rebuild automatically when the sources or `brand.json` change.
Pass CLI options after `--`, for example `npm run launch -- --host 127.0.0.1` (local only), `-- -p 20130` (another port) or `-- --no-browser`.
To use the `flagshiprouter` command anywhere, link the CLI package once:
 [code] 
For development with hot reload:
 [code] 
The dashboard's default password is `123456`; change it under **Settings** before exposing the router beyond localhost.
## Connect a coding tool
1. Open **Endpoint & Key** and create an API key.
2. Open **Models**, pick a model marked **Ready** (OpenCode Free models need no signup) or connect a provider to unlock more.
3. Point your tool at `http://localhost:20128/v1` with that key, or use **CLI Tools** to write the config for Claude Code, Codex, OpenCode, Cline, Copilot and others. Models appear in those tools as `flagshiprouter/ `.
 [code] 
## Rename everything from `brand.json`
| Field | Controls |
| --- | --- |
| `name` | Product name in the dashboard, terminal UI, tray, page titles, translations |
| `slug` | npm package, CLI command, data folder (`~/. `), headers, MITM certificate names |
| `modelPrefix` | Provider key written into CLI tool configs, so models show as ` / ` |
| `tagline`, `description` | Page title, web app manifest |
| `repository`, `branch` | Links, changelog and agent-skill URLs |
| `updateCheck` | npm update notices (keep `false` until the package is published under `slug`) |
| `providers` | Free-provider policy (see below) |
After editing `brand.json`, run `npm run brand:sync` to update the two `package.json` files (package name, CLI bin). Everything else reads `brand.json` at runtime or build time.
## Free-provider policy
 [code] 
A provider is available when