Getting Started

@freerouter/gateway runs a local OpenAI-compatible proxy plus a dashboard. Provider keys are stored encrypted on this machine; clients authenticate with a gateway key.

1. Install & run

The published package is invoked with npx (no global install needed):

npx @freerouter/gateway serve

During local development, use the workspace scripts instead:

# production-style single-port server (API + dashboard)
bun run serve

# development server with HMR (Vite on :5173, API on a free port)
bun run dev

On first start with no gateway keys, the server auto-generates one and prints it:

🛰  FreeRouter Gateway running at http://127.0.0.1:4141
   Dashboard: http://localhost:4141
   Proxy:    POST http://localhost:4141/v1/chat/completions
   Keys stored under: /Users/you/.freerouter

🔑 Generated your first FreeRouter gateway key:
   fr-live-9f3k...
   Put this into any OpenAI-compatible client as the API key.

2. Open the dashboard

Visit http://localhost:4141. From there you can:

• Connect provider keys (Groq, Google, OpenRouter, …) — encrypted and stored locally.
• Create gateway keys for your applications.
• Watch analytics (requests, tokens, latency, failures).
• Test a provider connection directly.

3. Make your first request

Use the gateway key as the OpenAI API key, pointing baseURL at the gateway:

import OpenAI from "openai"

const client = new OpenAI({
  baseURL: "http://localhost:4141/v1",
  apiKey: "fr-live-9f3k...", // your gateway key
})

const res = await client.chat.completions.create({
  model: "free:auto",
  messages: [{ role: "user", content: "Hello!" }],
})

console.log(res.choices[0].message.content)

Next Steps