Link.Assistant.Router
A self-hosted gateway for safely sharing one AI subscription with family,
household members, colleagues, or a small team. Each person, task, or agent gets
an independently expiring, revocable, rate-limited la_sk_… token while the
vendor credential stays inside the router.
The primary use case is putting Claude Code and other agentic clients behind one Claude MAX subscription without handing its OAuth credential to every user. Per-token request and actual-token budgets contain runaway agents and make usage attributable. The router also supports additional subscription and OpenAI-compatible providers when a deployment needs them.
Overview
Link.Assistant.Router is a transparent proxy between API clients (such as Claude Code) and vendor APIs. It provides an OpenRouter-like surface for subscription credentials while keeping the sharing, attribution, and containment controls local to the operator.
- Proxies all Anthropic API requests transparently, including SSE/streaming responses
- Supports Claude MAX (OAuth) by reading Claude Code session credentials
- Vendor subscriptions — the default
UPSTREAM_PROVIDER=autodiscovers healthy Claude, Codex, Gemini, and Qwen CLI credentials, exposes their model union, and routes each model to its owning subscription; an explicit provider value pins all traffic - OpenAI-compatible endpoints —
/v1/chat/completions,/v1/responses,/v1/modelstranslate to Anthropic or forward to a configured OpenAI-compatible provider - Optional Gonka upstream —
UPSTREAM_PROVIDER=gonkaforwards OpenAI-compatible routes to Gonka instead of translating them to Anthropic - Optional Crater ForgeFed upstream —
UPSTREAM_PROVIDER=craterturns OpenAI chat requests into ForgeFedOffer{Ticket}tasks and waits for resolved task results - Optional LiteLLM/OpenAI-compatible upstream —
UPSTREAM_PROVIDER=openai-compatibleroutes OpenAI SDK traffic to a stored provider such as LiteLLM - Multi-account routing — pool any number of Claude, Codex, Gemini, or Qwen subscriptions; session affinity, strict token pins, round-robin / fill-first / least-used selection, request caps, and
Retry-After-aware cooldowns - Issues custom
la_sk_...JWT tokens with expiration and revocation for multi-tenant access - Persistent token store — text (Lino) and binary backends, both on by default; tokens survive restarts
- Live observability — Prometheus
/metrics, JSON/v1/usage, per-account health at/v1/accounts lino-arguments+.lenv— every flag has an env-var alias and an optional.lenvfile fallback- First-class CLI —
serve, token/provider/account management,clients list|setup|show|remove|doctor, and deployment diagnostics - Replaces custom tokens with real OAuth credentials internally, so the OAuth token is never exposed to clients
- Runs as a single Docker container for easy deployment
Every feature is configurable — conflicting design choices in upstream community proxies become toggles (--routing-mode, --storage-policy, --disable-openai-api, --disable-anthropic-api, --disable-metrics, --experimental-compatibility).
Architecture
Client (Claude Code / API user)
|
| Authorization: Bearer la_sk_...
v
Link.Assistant.Router (Rust / axum)
|
| Authorization: Bearer <real OAuth token>
v
Anthropic API (api.anthropic.com)
When UPSTREAM_PROVIDER=gonka, clients still authenticate to the router with
Authorization: Bearer la_sk_..., but upstream OpenAI-compatible requests are
sent to Gonka with Gonka signing headers instead of the client token. This
project remains Link.Assistant.Router; Gonka is an optional backend.
When UPSTREAM_PROVIDER=openai-compatible, clients still authenticate to the
router with Authorization: Bearer la_sk_... or x-api-key: la_sk_.... The
router forwards OpenAI-compatible requests to the configured provider, such as
a LiteLLM proxy, and substitutes only the upstream provider key inside the
router.
When UPSTREAM_PROVIDER=crater, /v1/chat/completions accepts normal OpenAI
chat requests, delivers a ForgeFed Offer containing a Ticket to
CRATER_FORGEFED_INBOX, reads Accept.result, polls that task URI until
isResolved:true, and maps the resolved content back to OpenAI JSON or SSE.
Vendor subscriptions (Codex, Gemini, Qwen)
By default, leave UPSTREAM_PROVIDER=auto: the router discovers every healthy
vendor credential, returns their union from /v1/models, and sends each model
to its owning subscription. Set a concrete value to pin a deployment to one
provider. Clients still authenticate with their la_sk_... token; the router
supplies the selected vendor OAuth token.
| Provider | UPSTREAM_PROVIDER (aliases) |
Credentials (read-only) | Upstream |
|---|---|---|---|
| Claude | anthropic |
~/.claude/.credentials.json |
api.anthropic.com |
| Codex / ChatGPT | codex (chatgpt, openai-codex) |
~/.codex/auth.json |
ChatGPT backend Responses API |
| Gemini | gemini (google, code-assist) |
~/.gemini/oauth_creds.json |
Code Assist generateContent |
| Qwen | qwen (qwen-code, dashscope) |
~/.qwen/oauth_creds.json |
DashScope OpenAI-compatible |
The credential files are produced by each vendor's own CLI (run its login
once); the router only reads them. Expired tokens are refreshed in memory using
the vendor's public OAuth client — the files on disk are never modified and
secrets are never logged. /v1/chat/completions and /v1/responses are
translated to each backend's dialect (Codex uses the OpenAI Responses API;
Gemini uses the Code Assist envelope with synthesized SSE for streaming; Qwen is
OpenAI-compatible). Run router doctor to verify each credential file is
present and its token valid.
To pool subscriptions, set ADDITIONAL_ACCOUNT_DIRS to vendor-specific
credential homes. The active UPSTREAM_PROVIDER determines how every directory
is parsed. New sessions use ACCOUNT_ROUTING_STRATEGY; a session remains on its
chosen account for SESSION_AFFINITY_TTL_SECS, and an la_sk_... token issued
with an account claim is a strict pin. Automatic selection skips accounts
whose configured ACCOUNT_REQUEST_LIMITS cap is spent or whose upstream
returned HTTP 429. Pinned and session-bound requests fail instead of silently
changing identity.
Quick Start
Prerequisites
- Rust 1.88+ (for building from source)
- Docker (for containerized deployment)
- A Claude MAX subscription with an active Claude Code OAuth session
1. Install a released binary (Linux and macOS)
Every release publishes attested, checksummed archives for linux-amd64,
linux-arm64, darwin-arm64, and darwin-amd64. Pick the platform slice that
matches the machine, verify it, and install both binaries:
VERSION=
# macOS on Apple Silicon: darwin-arm64. Intel Macs: darwin-amd64.
PLATFORM=darwin-arm64
# Checksums, then the signed provenance of the build itself.
Updating is the same sequence with a newer VERSION: the archive contains only
the two binaries, so overwriting them in place leaves configuration untouched.
On Linux, sha256sum -c replaces shasum -a 256 -c.
2. Build from source
The binary will be at target/release/link-assistant-router.
3. Set up Claude Code credentials
The router reads OAuth credentials from the Claude Code home directory. By default, it looks in ~/.claude for credential files. Make sure you have an active Claude Code session:
# Log in with Claude Code (this creates the session files)
The router searches these files in order:
credentials.json.credentials.jsonauth.jsonoauth.jsonconfig.json
Two on-disk layouts are supported automatically:
-
Nested (the format real Claude Code writes to
~/.claude/.credentials.json): -
Flat (convenient for tests and minimal setups):
For the nested layout the router reads accessToken and expiresAt from inside
claudeAiOauth. For the flat layout it reads accessToken (or access_token,
oauthToken, oauth_token) from the top level of the first file found. The
file is only ever read — the router never writes back to or deletes your
credential files.
4. Start the router
# Required: set the JWT signing secret
# Optional: customize port (default: 8080)
# Optional: set Claude Code home directory (default: ~/.claude)
# Optional: override upstream URL (default: https://api.anthropic.com)
# Start the router
You should see:
INFO Link.Assistant.Router v0.2.0
INFO Upstream: https://api.anthropic.com
INFO Claude Code home: /home/user/.claude
INFO Listening on 0.0.0.0:8080
5. Issue a custom token
|
Response:
Save the token value for use in API requests.
6. Use the router as an Anthropic API proxy
# Use the custom token to make requests through the router
|
The router will:
- Validate the
la_sk_...token - Replace it with the real OAuth token from the Claude Code session
- Inject the upstream headers Claude MAX OAuth requires —
anthropic-version(default2023-06-01when the client omits it) and theanthropic-beta: oauth-2025-04-20flag (merged with any betas the client already sent) - Forward the request to
https://api.anthropic.com/v1/messages - Stream the response back to the client
Because the router injects these headers itself, a client only needs to send the
la_sk_... token — it never needs the real OAuth token, the OAuth beta flag, or
even an anthropic-version header.
Use-case documentation
Each supported scenario has its own document under docs/use-cases/, so you can read only the one you need:
| Document | Scenario |
|---|---|
| per-task-tokens.md | One la_sk_… token per task — audit, monitoring, security, isolation |
| audit-and-monitoring.md | Aggregate /metrics, admin-only per-token /v1/usage, and the JSONL audit log |
| with-router.md | Temporary-by-default one-line launcher, remote selection, managed Docker lifecycle, and exact global undo |
| claude-max-in-codex.md | A Claude MAX subscription inside Codex CLI and other OpenAI-dialect clients |
| chatgpt-in-claude-code.md | A ChatGPT/Qwen/Gemini/LiteLLM backend inside Claude Code and other Anthropic-dialect clients |
| cli-claude-code.md | Claude Code configuration |
| cli-codex.md | Codex CLI configuration |
| cli-qwen-code.md | Qwen Code configuration |
| cli-gemini-cli.md | Gemini CLI configuration |
| cli-opencode.md | opencode configuration |
| cli-grok-cli.md | Grok CLI configuration |
| cli-agent.md | Link.Assistant Agent configuration |
| cli-cursor.md | Cursor CLI — explicitly not supported, and why |
Using with Claude Code
The primary use case is routing Claude Code through the proxy so multiple users can share a single Claude MAX subscription.
Step 1: Start the router (on the server/host machine)
Step 2: Issue a token for each user
# Issue a token for user Alice
|
# Issue a token for user Bob
|
Step 3: Configure Claude Code to use the router (on each user's machine)
# Set the base URL to point to the router
# Set the custom token as the API key
# Run Claude Code normally — all requests go through the router
Claude Code will work exactly as normal, with all requests transparently proxied through the router.
API Endpoints
Always available
| Endpoint | Method | Description |
|---|---|---|
/health |
GET | Health check, returns ok |
/api/tokens |
POST | (admin) Issue a new custom token |
/api/tokens/list |
GET | (admin) List every persisted token |
/api/tokens/revoke |
POST | (admin) Revoke a token by id |
/api/tokens/rotate |
POST | (admin) Issue a replacement admin token and revoke the caller's own |
/api/providers |
GET/POST | (admin) List or upsert OpenAI-compatible upstream providers |
/api/providers/{name} |
GET/DELETE | (admin) Show or delete one provider |
Login surface (--disable-login-api to opt out)
Authorizes a deployment that has no credential file — see
docs/use-cases/remote-login.md. The optional
provider request field selects claude (the backwards-compatible default)
or codex. Claude drives the TUI /login flow and requests its full scope set;
LOGIN_CLI_ARGS=setup-token explicitly selects the narrower user:inference
flow. Codex defaults to its device-code flow, which needs no callback port or
vendor CLI; its PKCE loopback flow remains available as a CLI fallback.
| Endpoint | Method | Description |
|---|---|---|
/api/login |
POST | (admin) Start a login; optional body: `{"provider":"claude" |
/api/login/{id} |
GET | (admin) Status includes awaiting_code (Claude) or awaiting_device plus user_code (Codex) |
/api/login/{id} |
DELETE | (admin) Cancel a pending login and kill its process |
/api/login/{id}/code |
POST | (admin) Submit the code the human copied from the browser |
For a foreground local login, use link-assistant-router auth claude or
auth codex. Claude's --flow code stores its pending PKCE login for 15
minutes, so the code can be redeemed from a later process with
auth claude --flow code --code <code>. auth status reports each
provider credential as usable, expired, or absent. auth codex defaults
to device authorization; --flow device or --flow loopback makes the choice
explicit. Unsupported forced flows fail instead of falling back.
Admin UI surface (--admin-port to opt in)
Served on a separate listener that does not exist unless you give it a port, and on which every route but bootstrap and status requires the admin credential — see docs/use-cases/admin-ui.md.
| Endpoint | Method | Description |
|---|---|---|
/api/admin/status |
GET | (open) Credential state: claimed, bootstrap open, provisioned by environment |
/api/admin/bootstrap |
POST | (open while unclaimed) Mint a candidate token; authorises nothing on its own |
/api/admin/bootstrap/confirm |
POST | Activate the candidate, authenticated with the candidate token itself |
/api/admin/rotate |
POST | (admin) Mint a replacement admin credential and retire the current one |
/api/admin/summary |
GET | (admin) Version, upstream, accounts and credential state |
/ and static assets |
GET | The embedded React console |
Chat admin channels (TELEGRAM_BOT_TOKEN / VK_BOT_TOKEN to opt in)
Optional Telegram and VK bots that administer the router from a private chat — they poll outward, so no inbound port is opened. They share the same system-wide admin claim as the web UI: one first admin per deployment, claimed in a browser or in a chat. See docs/use-cases/chat-admin-bots.md.
| Env / flag | Description |
|---|---|
TELEGRAM_BOT_TOKEN / --telegram-bot-token |
Bot API token; present ⇒ the Telegram channel runs |
VK_BOT_TOKEN / --vk-bot-token |
VK community token (needs VK_GROUP_ID) |
VK_GROUP_ID / --vk-group-id |
VK community id the token belongs to |
CHAT_ADMIN_SECRET_TTL_SECS / --chat-admin-secret-ttl-secs |
Seconds before a message carrying a credential is deleted (default 120) |
CHAT_ADMIN_RATE_LIMIT_PER_MINUTE / --chat-admin-rate-limit-per-minute |
Sensitive commands per user per minute (default 5) |
Anthropic surface (--disable-anthropic-api to opt out)
| Endpoint | Method | Description |
|---|---|---|
/v1/messages |
POST | Anthropic Messages — preserves SSE streaming |
/v1/messages/count_tokens |
POST | Token-count helper |
/api/anthropic/v1/messages |
POST | Namespaced Anthropic Messages alias |
/api/anthropic/v1/messages/count_tokens |
POST | Namespaced token-count alias |
/invoke |
POST | Bedrock-format invoke |
/invoke-with-response-stream |
POST | Bedrock streaming invoke |
/api/latest/anthropic/v1/messages |
POST | Legacy Messages alias; prefix stripped before forwarding |
/api/latest/anthropic/v1/messages/count_tokens |
POST | Legacy token-count alias; prefix stripped before forwarding |
/v1/projects/{project}/locations/{location}/publishers/anthropic/models/{model}:rawPredict |
POST | Vertex rawPredict pass-through |
/v1/projects/{project}/locations/{location}/publishers/anthropic/models/{model}:streamRawPredict |
POST | Vertex streaming rawPredict pass-through |
/v1/projects/{project}/locations/{location}/publishers/anthropic/models/{model}/count-tokens:rawPredict |
POST | Vertex token-count pass-through |
OpenAI surface (--disable-openai-api to opt out)
| Endpoint | Method | Description |
|---|---|---|
/v1/chat/completions |
POST | Chat Completions, translated to Anthropic Messages, forwarded to the selected OpenAI-compatible provider, or delivered as a Crater ForgeFed task |
/v1/responses |
POST | Responses API, translated to Anthropic Messages or forwarded to the selected OpenAI-compatible provider |
/v1/models |
GET | OpenAI-shaped union of models from healthy subscriptions in automatic mode |
/api/openai/v1/* |
GET/POST | Namespaced aliases for models, Chat Completions, and Responses |
/api/codex/v1/* |
GET/POST | Codex namespace; Responses is the subscription's native protocol |
/api/qwen/v1/* |
GET/POST | Qwen namespace; forwards its native OpenAI-compatible protocol |
/api/gemini/v1beta/models |
GET | Native Gemini model list (union of every connected subscription) |
/api/gemini/v1beta/models/{model} |
GET | Native Gemini model metadata |
/api/gemini/v1beta/models/{model}:generateContent |
POST | Native Gemini generation, routed to the model's owning subscription (Codex, Claude, Qwen or Gemini) |
/api/gemini/v1beta/models/{model}:streamGenerateContent |
POST | Native Gemini SSE response |
/api/vertex/v1/projects/.../models/{model}:generateContent |
POST | Native Vertex-style generation through Gemini Code Assist |
Provider-specific namespaces use the matching healthy subscription in
automatic mode, or the provider pinned by UPSTREAM_PROVIDER.
When UPSTREAM_PROVIDER=anthropic, gpt-4o, gpt-4o-mini, gpt-4, and the
o* reasoning families are explicit aliases for the Claude Sonnet / Haiku /
Opus tiers respectively. Native claude-* IDs pass through unchanged. In
automatic mode, routing uses only subscription catalogs: vendor-shaped IDs
prefer their matching vendor if catalogs overlap, and an unqualified name
advertised by multiple healthy subscriptions is rejected until
UPSTREAM_PROVIDER is pinned. Other model names return 404 not_found_error
instead of silently selecting a default model. Successful Anthropic-backed
responses report the resolved Claude model that actually served the request.
Model identity and output limits
Responses always report the model id the client requested, including catalog
aliases such as codex-auto-review, in model — for buffered replies and for
every streamed chunk on each OpenAI surface. When the provider serves a
different concrete model, the router reports it separately in the
x_router_upstream_model response field and the x-router-upstream-model
response header, instead of replacing the requested identity.
Codex subscriptions accept max_output_tokens, max_tokens, and
max_completion_tokens. The ChatGPT backend rejects an explicit cap, so the
router strips the field from the upstream request and enforces the cap itself:
visible output is truncated at the caller's budget and the exchange ends with
finish_reason: "length" on Chat Completions, or status: "incomplete" with
incomplete_details.reason: "max_output_tokens" on Responses. The budget is
estimated at roughly four characters per token, and hidden reasoning tokens are
not observable, so the cap bounds visible output rather than billed tokens.
With UPSTREAM_PROVIDER=gonka, /v1/chat/completions and /v1/responses
forward OpenAI-compatible JSON to Gonka without Anthropic translation. If a
request omits model, the router uses GONKA_MODEL.
With UPSTREAM_PROVIDER=openai-compatible, the same routes forward JSON to the
configured provider. This supports LiteLLM proxy deployments by setting the
provider base URL to the LiteLLM /v1 API base. Streaming OpenAI requests are
passed through for OpenAI-compatible providers, and Anthropic-backed streaming
requests are translated to OpenAI SSE chunks.
With UPSTREAM_PROVIDER=crater, /v1/chat/completions supports normal JSON
responses and SSE with either request-body "stream": true or ?stream=true.
The SSE stream emits OpenAI chat-completion chunks once the ForgeFed task
resolves.
MPP charges for OpenAI endpoints
The OpenAI-compatible endpoints can advertise Machine Payments Protocol (MPP)
charges with HTTP 402 Payment Required. Enable this only after configuring
the amount, currency, and recipient for your payment method:
MPP_ENABLE=true
MPP_AMOUNT=0.05
MPP_CURRENCY=USD
MPP_RECIPIENT=acct_or_wallet
MPP_METHOD=stripe
When enabled, unpaid calls to /v1/chat/completions and /v1/responses
return WWW-Authenticate: Payment ... with protocol="mpp" and
intent="charge". This is separate from the ForgeFed/ActivityPub discovery
surface. Payment credential settlement is intentionally not accepted until a
method-specific verifier is configured.
Observability (--disable-metrics to opt out)
| Endpoint | Method | Description |
|---|---|---|
/metrics |
GET | Public Prometheus text-exposition aggregate counters |
/v1/usage |
GET | Admin-only JSON snapshot, including per-token and per-account counters |
/v1/accounts |
GET | Admin-only multi-account health: cooldowns, last error, used count, configured limit, and remaining requests |
/metrics deliberately contains no token ids, labels, or account names because
it is available without authentication. Administrators can inspect per-token
usage in the /v1/usage token_calls JSON map. Set --audit-log for a durable
JSONL trail of the same events. See
docs/use-cases/audit-and-monitoring.md.
POST /api/tokens
Issue a new custom JWT token.
Request body:
| Field | Type | Default | Description |
|---|---|---|---|
ttl_hours |
integer | 24 | Token lifetime in hours |
label |
string | "" |
Optional human-readable label |
scope |
string | "" |
"admin" mints a credential that also unlocks the admin endpoints; omit for an ordinary client token |
Response:
Proxy Routes
The two documented /api/latest/anthropic/v1/messages routes are forwarded to
the corresponding upstream Anthropic API paths. Unknown routes and methods are
rejected locally rather than forwarded. The proxy:
- Validates the
Authorization: Bearer la_sk_...orx-api-key: la_sk_...token - Replaces it with the real OAuth token
- Forwards all headers (except
host,authorization,x-api-key,connection,transfer-encoding) - Passes through the request body unmodified
- Streams back the response (SSE-compatible)
- Preserves the upstream status code and response headers
Error responses follow the Anthropic API error format:
| Status | Condition |
|---|---|
| 401 | Missing or invalid/expired token |
| 403 | Token has been revoked |
| 502 | OAuth token unavailable or upstream request failed |
Configuration
Configuration is read by lino-arguments in this order: CLI flags,
environment variables, .lenv, then .env. The default file format is
Lino-style key/value notation:
TOKEN_SECRET: your-router-token-secret
UPSTREAM_PROVIDER: openai-compatible
OPENAI_COMPATIBLE_PROVIDER_NAME: litellm
OPENAI_COMPATIBLE_BASE_URL: http://litellm:4000/v1
OPENAI_COMPATIBLE_MODEL: claude-sonnet
OPENAI_COMPATIBLE_MODELS: claude-sonnet,gpt-4o
Every flag listed in --help has an env-var alias and can be configured from
.lenv with the same env-var key.
Core
| Flag / env | Default | Required | Description |
|---|---|---|---|
--token-secret / TOKEN_SECRET |
— | Yes | Secret key for signing/validating JWT tokens |
--port / ROUTER_PORT |
8080 |
No | Port to listen on |
--host / ROUTER_HOST |
0.0.0.0 |
No | Host/IP to bind to |
--claude-code-home / CLAUDE_CODE_HOME |
~/.claude |
No | Primary Claude Code credentials directory |
--upstream-provider / UPSTREAM_PROVIDER |
auto |
No | Automatically route by model across healthy subscriptions, or pin anthropic, codex, gemini, qwen, gonka, crater, or openai-compatible |
--upstream-base-url / UPSTREAM_BASE_URL |
https://api.anthropic.com |
No | Upstream Anthropic API URL |
UPSTREAM_READ_TIMEOUT_SECS |
120 |
No | Seconds to wait for the next byte from an upstream before failing the request; 0 disables the bound. A long answer may legitimately stream for many minutes, but a backend that has gone silent must not leave a client waiting forever |
--api-format / UPSTREAM_API_FORMAT |
(auto) | No | Restrict the proxy to anthropic / bedrock / vertex |
--bridge-model / ANTHROPIC_BRIDGE_MODEL |
(per provider) | No | Upstream model used when /v1/messages is served from a non-Anthropic upstream (details) |
--audit-log / AUDIT_LOG |
(disabled) | No | Append one JSON line per authorised request (token id, label, provider, surface, path, model) to this file (details) |
--request-log / REQUEST_LOG |
$DATA_DIR/requests |
No | Root directory for redacted per-token JSONL exchange logs, tied together by correlation_id |
--request-log-max-bytes / REQUEST_LOG_MAX_BYTES |
104857600 (100 MiB) |
No | Per-token request-log size bound; each token independently discards its oldest complete records first |
--max-proxy-request-bytes / MAX_PROXY_REQUEST_BYTES |
67108864 (64 MiB) |
No | Deliberate proxy request-body ceiling; independent of request-log capture and returns HTTP 413 when exceeded |
--verbose / VERBOSE |
false |
No | Verbose tracing |
GitHub API credential proxy
The opt-in GitHub proxy lets an agent authenticate with its router-issued task
token while the real GitHub credential remains inside the router. It supports
bare REST paths, GitHub CLI's custom-host /api/v3/* rewrite, and GraphQL at
/api/graphql and /graphql. The /github/* namespace exposes arbitrary REST
paths without colliding with inference/admin routes. Plain git over SSH/HTTPS
is outside this proxy.
GITHUB_PROXY_TOKEN_FILE=/run/secrets/github-token
# Or: GITHUB_PROXY_TOKEN=github_pat_...
# Optional enterprise/test upstream:
# GITHUB_PROXY_BASE_URL=https://github.example/api/v3
# Optional ordered JSON policy:
GITHUB_PROXY_POLICY=/etc/link-assistant/github-policy.json
No GitHub routes are mounted until a real upstream credential is configured.
Client Authorization is never forwarded; the router validates it as an
la_sk_… token and injects the operator credential upstream. Rate-limit and
request-id headers return to the client, while cookies and credentials do not.
Deletion, forced REST ref updates, GraphQL mutations whose operation deletes an object, and forced GraphQL ref updates are denied by default. An ordered policy file can override a narrow operation without weakening the remaining defaults:
The first matching configured rule wins, then the built-in destructive policy
applies. * matches one path segment and /** matches the remainder. A blocked
call returns 403 with a GitHub-shaped message and
x-link-assistant-policy: blocked. This protects API-mediated ref deletion and
forced ref updates; branch protection remains necessary because a force-push
over the git transport never reaches these routes.
For GitHub CLI, terminate trusted HTTPS at the router host and set the router-issued token as the custom-host credential:
Gonka provider
Gonka support is optional. Set UPSTREAM_PROVIDER=gonka to pin the deployment
to it instead of using automatic subscription routing.
TOKEN_SECRET=your-router-token-secret
UPSTREAM_PROVIDER=gonka
GONKA_PRIVATE_KEY=your_gonka_private_key
GONKA_SOURCE_URL=https://node4.gonka.ai
GONKA_MODEL=Qwen/Qwen3-235B-A22B-Instruct-2507-FP8
| Flag / env | Default | Required | Description |
|---|---|---|---|
--gonka-private-key / GONKA_PRIVATE_KEY |
— | Yes, for Gonka | Private key used to sign Gonka upstream requests |
--gonka-source-url / GONKA_SOURCE_URL |
https://node4.gonka.ai |
No | Gonka source node URL |
--gonka-model / GONKA_MODEL |
Qwen/Qwen3-235B-A22B-Instruct-2507-FP8 |
No | Default model for Gonka OpenAI-compatible requests |
Your Gonka account must be activated for inference, funded, and have a published on-chain public key. Participant registration is only needed for hosting.
Crater ForgeFed provider
Crater support is optional. It keeps router-issued la_sk_... tokens at the
edge, then uses ForgeFed to submit work to a remote ticket tracker or exchange.
TOKEN_SECRET=your-router-token-secret
UPSTREAM_PROVIDER=crater
CRATER_FORGEFED_INBOX=https://tracker.example/inbox
CRATER_FORGEFED_TARGET=https://tracker.example/projects/demo
# Optional; defaults to ACTIVITYPUB_ACTOR_BASE_URL/actor/code
CRATER_FORGEFED_ACTOR=https://router.example/actor/code
| Flag / env | Default | Required | Description |
|---|---|---|---|
--crater-forgefed-inbox / CRATER_FORGEFED_INBOX |
— | Yes, for Crater | Remote ForgeFed inbox that receives Offer{Ticket} activities |
--crater-forgefed-actor / CRATER_FORGEFED_ACTOR |
${ACTIVITYPUB_ACTOR_BASE_URL}/actor/code |
No | Local actor URI used in outbound activities |
--crater-forgefed-target / CRATER_FORGEFED_TARGET |
inbox URI | No | Ticket tracker or project URI used as Offer.target |
--crater-poll-interval-ms / CRATER_POLL_INTERVAL_MS |
1000 |
No | Delay between task URI polls |
--crater-poll-timeout-secs / CRATER_POLL_TIMEOUT_SECS |
120 |
No | Maximum wait for isResolved:true |
OpenAI-compatible / LiteLLM provider
Generic OpenAI-compatible providers are used when
UPSTREAM_PROVIDER=openai-compatible. The boot-time config can come from
.lenv, env vars, or CLI flags:
TOKEN_SECRET: your-router-token-secret
UPSTREAM_PROVIDER: openai-compatible
OPENAI_COMPATIBLE_PROVIDER_NAME: litellm
OPENAI_COMPATIBLE_BASE_URL: http://litellm:4000/v1
OPENAI_COMPATIBLE_API_KEY_ENV: LITELLM_MASTER_KEY
OPENAI_COMPATIBLE_MODEL: claude-sonnet
OPENAI_COMPATIBLE_MODELS: claude-sonnet,gpt-4o
| Flag / env | Default | Required | Description |
|---|---|---|---|
--openai-compatible-provider-name / OPENAI_COMPATIBLE_PROVIDER_NAME |
litellm |
No | Stored provider name to resolve |
--openai-compatible-base-url / OPENAI_COMPATIBLE_BASE_URL |
http://localhost:4000/v1 |
No | Upstream OpenAI-compatible /v1 API base |
--openai-compatible-api-key / OPENAI_COMPATIBLE_API_KEY |
— | No | Inline upstream key; prefer persisted provider storage for long-lived secrets |
--openai-compatible-api-key-env / OPENAI_COMPATIBLE_API_KEY_ENV |
— | No | Environment variable containing the upstream key |
--openai-compatible-model / OPENAI_COMPATIBLE_MODEL |
— | No | Default model injected when requests omit model |
--openai-compatible-models / OPENAI_COMPATIBLE_MODELS |
— | No | Comma-separated models exposed from /v1/models |
Persistent provider records live in <DATA_DIR>/providers.lenv. Inline
provider API keys are encrypted with AES-GCM using a key derived from
TOKEN_SECRET; API responses and CLI output only show whether a stored key is
present.
Provider records can also be imported from JSON, provider-store .lenv, or an
indented Links-style config:
litellm
kind "openai-compatible"
base-url "http://litellm:4000/v1"
model "claude-sonnet"
models "claude-sonnet,gpt-4o"
api-key-env "LITELLM_MASTER_KEY"
The HTTP API accepts the same shape at POST /api/providers:
Routing & storage
| Flag / env | Default | Description |
|---|---|---|
--routing-mode / ROUTING_MODE |
direct |
direct (OAuth substitution), cli (Claude CLI subprocess), or hybrid |
--storage-policy / STORAGE_POLICY |
both |
Persistent token store: memory, text (Lino), binary, or both |
--data-dir / DATA_DIR |
platform-specific | Where tokens.lino / tokens.bin live |
--claude-cli-bin / CLAUDE_CLI_BIN |
claude |
Local Claude CLI binary used by the cli backend |
--additional-account-dirs / ADDITIONAL_ACCOUNT_DIRS |
(empty) | Comma-separated extra credential homes for the active subscription provider |
--account-routing-strategy / ACCOUNT_ROUTING_STRATEGY |
round-robin |
New-session policy: round-robin, priority/fill-first, or least-used/quota-first |
--account-cooldown-secs / ACCOUNT_COOLDOWN_SECS |
60 |
Minimum cooldown after a quota response; a longer upstream Retry-After wins |
--session-affinity-ttl-secs / SESSION_AFFINITY_TTL_SECS |
3600 |
Inactive seconds before a conversation can be assigned again; 0 disables affinity |
--account-request-limits / ACCOUNT_REQUEST_LIMITS |
(unknown) | Comma-separated request caps, primary first then extras; must match pool size, and 0 means unknown/unlimited |
Storage formats and ownership
Router-owned token state uses the associative stack. tokens.lino is a
portable Links Notation projection produced by lino-objects-codec, with each
record represented as Type → SubType → Value. tokens.bin is the same
semantic graph in a native doublets store backed by file-mapped
platform-mem. The text, binary, and default both policies select those
two projections; memory remains non-persistent. Hand-built tokens.lino
files and LARTOK01 JSON containers from earlier releases are loaded and
atomically converted on first open.
Other files keep the format of the boundary they serve:
- Provider/client credentials and client settings such as
.credentials.json,auth.json,settings.json, andconfig.tomlare vendor-owned interoperability files. The router continues to read or update the vendor's expected shape. - Per-token
requests/<token-hash>/requests.jsonlfiles and the optional audit JSONL are append-only operational streams intended for log collectors and standard text tooling, rather than mutable router domain state. providers.lenvis the router's existing portable provider configuration interchange. Moving additional router-owned state onto doublets can be done independently of the token migration.
Feature toggles
| Flag / env | Default | Description |
|---|---|---|
--disable-openai-api / DISABLE_OPENAI_API |
off | Hide /v1/chat/completions, /v1/responses, /v1/models |
--disable-anthropic-api / DISABLE_ANTHROPIC_API |
off | Hide /v1/messages* and Bedrock paths |
--disable-metrics / DISABLE_METRICS |
off | Hide /metrics, /v1/usage, /v1/accounts |
--disable-login-api / DISABLE_LOGIN_API |
off | Hide /api/login* |
--login-cli-command / LOGIN_CLI_COMMAND |
claude |
Program /api/login drives on a PTY |
--login-cli-args / LOGIN_CLI_ARGS |
(none; TUI /login) |
Comma-separated arguments for that program; set setup-token for the narrow-scope alternative |
--login-session-ttl-secs / LOGIN_SESSION_TTL_SECS |
900 |
How long a pending login waits for its code before expiring |
--login-max-sessions / LOGIN_MAX_SESSIONS |
4 |
Maximum simultaneously pending logins; beyond it, 429 |
--experimental-compatibility / EXPERIMENTAL_COMPATIBILITY |
off | XML history, model spoofing and other community-proxy behaviours |
--admin-key / TOKEN_ADMIN_KEY |
— | Flat bootstrap Bearer key accepted by /api/tokens* alongside admin-scoped tokens |
--allow-anonymous-admin / ALLOW_ANONYMOUS_ADMIN |
off | Opt back into unauthenticated /api/tokens* access (not recommended) |
--admin-port / ADMIN_PORT |
— (disabled) | Port for the admin UI listener; no port, no admin surface |
--admin-host / ADMIN_HOST |
127.0.0.1 |
Address the admin UI listener binds, independent of the proxy |
--admin-claim-ttl-secs / ADMIN_CLAIM_TTL_SECS |
120 |
Lifetime of an unconfirmed admin bootstrap candidate |
--mpp-enable / MPP_ENABLE |
off | Return MPP 402 Payment Required challenges on OpenAI endpoints |
--mpp-amount / MPP_AMOUNT |
0.00 |
Per-request MPP charge amount |
--mpp-currency / MPP_CURRENCY |
USD |
Currency or asset for MPP charges |
--mpp-recipient / MPP_RECIPIENT |
— | Recipient wallet, merchant account, or payment address |
--mpp-method / MPP_METHOD |
— | Optional MPP payment method identifier |
CLI subcommands
# Default: starts the HTTP server (same as `serve`).
# Issue / list / revoke / show tokens locally (no HTTP needed):
# ...optionally cap how many upstream requests the token may make:
# ...cap actual input + output tokens and bursts as well:
# Inspect configured accounts:
# Manage OpenAI-compatible upstream providers:
# Safely configure local agentic CLIs against this router:
# Print resolved configuration + credential / store probes:
Logging
The router uses tracing with the RUST_LOG environment variable:
# Default: info level
RUST_LOG=info
# Debug level for detailed request tracing
RUST_LOG=debug
# Trace level for maximum verbosity
RUST_LOG=trace
RUST_LOG overrides the default info level (or the debug fallback selected
by --verbose). Every HTTP request also writes a structured exchange to
$DATA_DIR/requests/<token-hash>/requests.jsonl by default. Client and upstream
phases share an x-request-id/correlation_id and carry the token hash, id,
and label. Missing or invalid credentials use the explicit unauthenticated
directory. Credentials longer than the safety threshold retain three leading
and trailing characters with a fixed * mask; shorter values are replaced
with [REDACTED]. The same helper handles headers, URI query parameters, and
JSON bodies, and no complete credential is logged. Request bodies larger than
10 MiB continue to the handler but are omitted from the log. Directories and
files use owner-only permissions on Unix. REQUEST_LOG_MAX_BYTES applies to
each token independently, so one caller cannot evict another's history.
Docker Deployment
Build the image
Run the container
The Dockerfile sets CLAUDE_CODE_HOME=/data/claude by default, so mount your Claude Code session directory to /data/claude.
Credential lifecycle in a container
The single image intentionally contains no vendor CLI. It performs Claude OAuth and refresh in-process:
| Operation | Needs the Claude CLI in the image? | Mount mode |
|---|---|---|
| Serve requests with a valid access token | No | :ro |
| Renew an expired access token | No — the router exchanges the refreshToken itself |
:ro |
| First-time login (no credential file yet) | No — native OAuth | writable |
POST /api/login (remote login over HTTP) |
No — native OAuth | writable |
Renewal happens in memory: the router exchanges the refreshToken stored in the mounted credential file against Anthropic's token endpoint and keeps the result in RAM. The credential file is never written to, which is why :ro keeps working across expiry — and why a restarted container refreshes again from the same file. The same mechanism already covers Codex, Gemini, and Qwen.
Two things still require a real login: a directory with no credential file at all, and a refreshToken that has itself been revoked or expired.
Logging in from inside a container
The regular image can authorize itself without a preinstalled Claude CLI:
# Log in once into a named volume (interactive, needs a writable mount)
# Then run the router against that volume
If native OAuth fails, auth claude downloads the current Claude Code package
through bun into a temporary cache, completes the compatibility flow, and
removes that cache. Force this path with auth claude --flow cli.
The release pipeline verifies that ghcr.io/link-assistant/router is publicly
pullable without credentials. On the first package publication, the publishing
job fails closed if GitHub created the package as private. An organization owner
must open the package settings, change its visibility to Public, and rerun
the failed job. GitHub does not currently provide a package-visibility API, so
this one-time bootstrap cannot be automated safely.
Docker Compose example
version: "3.8"
services:
router:
build: .
ports:
- "8080:8080"
environment:
TOKEN_SECRET: ${TOKEN_SECRET}
ROUTER_PORT: "8080"
volumes:
# `:ro` is enough: token renewal happens in memory. Drop `:ro` (and use
# `:ro` can be dropped when authorizing from the container.
- ${HOME}/.claude:/data/claude:ro
restart: unless-stopped
VPS Deployment
To deploy on a VPS (e.g., Ubuntu):
# 1. Install Rust
|
# 2. Clone and build
# 3. Set up Claude Code credentials on the VPS
# (log in with Claude Code to create session files)
# 4. Create a systemd service (optional, for auto-start)
# 5. Check status
Resilient reverse SSH tunnel
The companion docker/tunnel/Dockerfile runs
autossh as a non-root user and republishes the router on a far-side host. It
fails fast with a diagnostic naming any missing required variable and uses SSH
keepalives plus ExitOnForwardFailure, allowing the container restart policy
and autossh to recover a dropped connection.
The remote bind defaults to loopback. Set TUNNEL_REMOTE_BIND only when the
far-side SSH server is deliberately configured to expose remote forwards.
Host verification is strict and fail-closed: TUNNEL_KNOWN_HOSTS must point to
a readable, non-empty file containing the pinned far-side host key.
Akash and Kubernetes
Ready-to-edit deployment templates are included for hosted environments:
Replace placeholder secrets, set ACTIVITYPUB_ACTOR_BASE_URL to the public
router URL, and mount or provision Claude Code credentials at
CLAUDE_CODE_HOME before exposing the service.
ForgeFed Integration
The router exposes ActivityPub/ForgeFed endpoints for service discovery and problem-source federation. See docs/forgefed.md for the actor document, inbox, follow activity, and deployment verification steps.
Token System
The router uses JWT-based custom tokens with the la_sk_ prefix.
Token lifecycle
- Issue:
POST /api/tokenscreates a signed JWT with a UUID subject, expiration, optional label, and optional per-token request, token-spend, and rate controls - Validate: Each proxy request extracts the
Authorization: Bearer la_sk_...header, strips the prefix, and verifies the JWT signature and expiration - Meter: Each admitted request increments
used_requests; successful upstream usage payloads add actual input and output tokens toused_tokens. Reachingmax_requests,max_tokens, orrate_limit_per_minutereturns429 Too Many Requestsbefore another request is forwarded - Revoke: Tokens can be revoked by their subject ID. Records (including the revoked flag and usage counter) are written to the persistent token store, so revocations and usage survive restarts
Token format
Tokens are standard HS256 JWTs with the la_sk_ prefix. The JWT payload contains:
scope is absent (or empty) on an ordinary client token and "admin" on an
administrative one — see Admin access.
Admin access
The /api/tokens* endpoints — and every other endpoint marked (admin) above
— are closed by default. Three things can open them:
-
An admin-scoped token. It is an ordinary
la_sk_…JWT carrying"scope": "admin", so it expires, has an identity (sub), shows up intokens list, and can be revoked and rotated like any other token.# CLI # HTTP (from an existing admin credential) |Rotation is a single step — mint the replacement and revoke the credential that asked for it:
| -
The flat
--admin-key/TOKEN_ADMIN_KEY. Still supported unchanged as a bootstrap and compatibility credential for deployments that configure everything externally, and now compared in constant time. It carries no identity or expiry, so it cannot rotate itself (/api/tokens/rotateanswers400); prefer an admin-scoped token for day-to-day use. -
Nothing at all — only if you pass
--allow-anonymous-admin(ALLOW_ANONYMOUS_ADMIN=1). This restores the historical wide-open behaviour and is logged as a warning at startup.
When neither an admin key nor an active admin token exists, the router mints one on startup and prints it once:
Admin token (shown once, store it now): la_sk_eyJ0eXAi...
A client token presented to an admin endpoint is rejected: authorisation is by
scope, not by "any valid token". The converse does not hold: scope=admin is a
superset of client access, so one administrator credential both manages
tokens (/api/tokens/list) and reaches the models (/v1/models). The same is
true of the flat TOKEN_ADMIN_KEY.
The first-visitor claim
The web UI and the chat bots (Telegram, VK) share one system-wide first-visitor
claim, and it produces an ordinary admin-scoped la_sk_… JWT — the credential
model above, not a parallel one. The two-phase handshake is unchanged: phase one
mints the candidate already revoked, so an undelivered mint authorises
nothing and cannot brick the deployment; confirming it activates the credential,
closes bootstrap on every channel, and retires the startup bootstrap-admin
token by id, so the Tokens table, the CLI and the bots all show it revoked.
POST /api/admin/bootstrap and POST /api/admin/rotate accept an optional
{"ttl_hours": n} body to limit the credential lifetime (capped at one year;
omitted means the cap). Expiry and revocation are enforced on the same path as
every other token. Rotation is atomic: the replacement is minted and the
previous credential revoked by id under the claim lock.
Deployments claimed by an older version still hold an opaque la_admin_…
credential. It keeps working, doctor warns about it, and the first
/api/admin/rotate converts the claim into a JWT.
Per-token containment controls
Each token can cap request count, actual upstream-reported input plus output tokens, and requests per minute. This lets you hand a credential to a separate person, task, or agent without exposing the vendor OAuth credential or letting one runaway loop immediately consume the shared subscription.
# CLI
# HTTP: same, via the admin endpoint
|
- Omitting
--max-requests/max_requestsleaves the token unlimited. - Omitting
--max-tokens/max_tokensleaves actual token spend unlimited. Counts come from vendor responseusagefields and are persisted across restarts; the response that crosses a cap completes, and the next request is rejected. - Omitting
--rate-limit-per-minute/rate_limit_per_minutedisables the per-token one-minute request window. - Usage is counted per forwarded request and persisted in the token store, so the budget is enforced across restarts.
- When the budget is exhausted the router responds with
429 Too Many Requestsand arate_limit_errorbody ({"error":{"message":"Token has reached its request limit",...}}) instead of forwarding upstream. tokens listshowsrequestsandtokensasused/maxplus the configuredrpm; each credential has independent counters and a separate rate window.
Security notes
- The
TOKEN_SECRETmust be kept secure — anyone with the secret can forge tokens - OAuth tokens from the Claude Code session are never exposed to clients
- Tokens are validated on every request
- Use a strong, random secret (e.g.,
openssl rand -hex 32) - Pair short TTLs with
max_tokensand a per-minute rate to give each task a tightly scoped, self-expiring credential
Testing
Run all tests
This runs the unit, integration, release-workflow, and documentation tests, including account affinity/caps, provider-scoped token caching, request-routing metadata, protocol translation, metrics, and configuration validation.
Run specific test suites
# Unit tests only
# Integration tests only
# A specific test
# With verbose output
Code quality checks
# Check formatting
# Run Clippy lints
# All checks together
&& &&
Manual end-to-end testing
Use the provided script to test the router locally:
# Make the script executable
# Run manual tests (starts the router, issues a token, tests endpoints)
Or test manually step by step:
# Terminal 1: Start the router with a test credential file
# Terminal 2: Test the endpoints
# 1. Health check
# Expected: ok
# 2. Issue a token
TOKEN=
# 3. Test proxy with token (will get auth error from Anthropic since test-oauth-token is not real)
|
# 4. Test without token (should get 401)
|
# 5. Test with invalid token (should get 401)
|
Run the example
This demonstrates token issuance, validation, and revocation programmatically.
Project Structure
.
├── .github/workflows/
│ └── release.yml # CI/CD pipeline (lint, test, build, release)
├── changelog.d/ # Changelog fragments (per-PR documentation)
├── docs/ # Documentation
│ ├── use-cases/ # One document per supported scenario / CLI
│ ├── case-studies/ # Per-issue research, requirements, solution plans
│ └── adr/ # Architecture decision records
├── examples/
│ └── basic_usage.rs # Token management example
├── scripts/
│ ├── test-manual.sh # Manual end-to-end testing script
│ ├── bump-version.rs # Version bumping utility
│ ├── check-file-size.rs # File size validation
│ └── ... # Other CI/CD scripts
├── src/
│ ├── lib.rs # Library root — re-exports modules
│ ├── main.rs # Binary entry point — Cli dispatch + server setup
│ ├── cli.rs # `lino-arguments`-based CLI parser + subcommands
│ ├── config.rs # CLI/env/.lenv configuration
│ ├── crater.rs # Crater ForgeFed task provider
│ ├── oauth.rs # Claude Code OAuth credential reader
│ ├── accounts.rs # Multi-account router (round-robin/priority/least-used + cooldowns)
│ ├── app_state.rs # Shared HTTP handler state
│ ├── storage.rs # Persistent token store (text Lino + binary backends)
│ ├── providers.rs # OpenAI-compatible provider store + encrypted secrets
│ ├── proxy.rs # Transparent API proxy with token swap, OpenAI shim, ops endpoints
│ ├── request_routing.rs # Session/account routing signal extraction
│ ├── openai.rs # OpenAI <-> Anthropic translation helpers
│ ├── anthropic_bridge.rs # Anthropic Messages served from OpenAI-dialect upstreams
│ ├── anthropic_stream.rs # OpenAI SSE -> Anthropic SSE translator
│ ├── audit.rs # Per-token JSONL audit log
│ ├── claude_identity.rs # Claude Code identity block required by Claude MAX OAuth
│ ├── metrics.rs # Atomic counters, Prometheus rendering, JSON snapshots
│ └── token.rs # Custom JWT token management (la_sk_...)
├── tests/
│ └── integration_test.rs # Integration tests
├── experiments/ # Local end-to-end harnesses (see docs/case-studies/)
├── Cargo.toml # Project configuration and dependencies
├── Dockerfile # Multi-stage Docker build
├── CHANGELOG.md # Project changelog
├── CONTRIBUTING.md # Contribution guidelines
├── LICENSE # Unlicense (public domain)
└── README.md # This file
Contributing
See CONTRIBUTING.md for development setup, coding guidelines, and the pull request process.