@andeya/token-free-gateway-linux-arm64

v0.5.1

Published

2 months ago

Prebuilt token-free-gateway binary for Linux (ARM64)

0High
0Medium
0Low

andeya

openai gateway ai llm claude chatgpt cli

Token-Free Gateway

中文文档

Use ChatGPT, Claude, Gemini, DeepSeek, and 9 more AI models — completely free, no API keys required. Just log in via browser.

Token-Free Gateway is a lightweight OpenAI-compatible API server that turns web-based AI sessions into a standard /v1/chat/completions endpoint with full Tools / Function Calling support. Point any OpenAI SDK client at it and it just works.

Why Token-Free Gateway?

| Traditional API usage | Token-Free Gateway | | --------------------- | -------------------------- | | Purchase API tokens | Completely free | | Pay per request | No quota, no billing | | Credit card required | Browser login only | | API key may leak | Credentials stored locally |

What You Get

One endpoint, 13 providers — Claude, ChatGPT, DeepSeek, Doubao, Gemini, GLM, GLM Intl, Grok, Kimi, Perplexity, Qwen, Qwen CN, Xiaomi MiMo
100% OpenAI-compatible — /v1/chat/completions, /v1/models, streaming, tool_calls — zero client-side changes
Full Function Calling — tools are injected as prompts, responses are parsed back into standard tool_calls
Single binary, batteries included — playwright-core is bundled; the only external dependency is Chrome
Cross-platform — macOS, Linux, Windows
Daemon mode — start / stop / restart / status like a proper service

Prerequisites

Chrome (or Chromium) — Install from google.com/chrome or your OS package manager. Keep it updated to a recent stable version. The gateway controls your browser over CDP — it does not embed a browser.

That's it. playwright-core is bundled in the binary; no playwright install, no extra runtime dependencies.

Does my Chrome version need to "match" something? — No. The gateway connects to your Chrome's debug WebSocket; CDP stays compatible across recent Chrome versions.

Quick Start

Step 1 — Install

Choose one method:

Via npm (recommended):

npm install -g token-free-gateway

Prebuilt binary — download from GitHub Releases:

tar xzf token-free-gateway-<platform>.tar.gz
chmod +x token-free-gateway

From source:

git clone https://github.com/andeya/token-free-gateway.git && cd token-free-gateway
bun install
bun run build    # → ./token-free-gateway

Step 2 — Authorize providers

Run the authorization wizard. Chrome will start automatically if it is not already running in debug mode:

token-free-gateway webauth

Chrome opens with login pages for all 13 providers. Log in to the ones you want, then press Enter in the terminal. Select which providers to authorize — credentials are saved to ~/.token-free-gateway/auth-profiles.json.

DeepSeek: keep the DeepSeek chat page open while running webauth — the wizard captures the bearer token from the live session.
Tip: if the terminal doesn't return after authorization, press Ctrl+C — credentials are already saved.

Step 3 — Start the gateway

token-free-gateway start      # background daemon (logs: ~/.token-free-gateway/gateway.log)
token-free-gateway serve      # foreground (for debugging)

The gateway listens on http://localhost:3456 by default. Chrome is checked (and auto-started if needed) before the daemon launches.

Step 4 — Use it

Point any OpenAI SDK client at the gateway:

from openai import OpenAI

client = OpenAI(
    base_url="http://localhost:3456/v1",
    api_key="any-string",          # or your TFG_API_KEY if configured
)

# Simple chat
response = client.chat.completions.create(
    model="claude-sonnet-4-20250514",
    messages=[{"role": "user", "content": "Hello!"}],
)
print(response.choices[0].message.content)

Function Calling works out of the box:

response = client.chat.completions.create(
    model="claude-sonnet-4-20250514",
    messages=[{"role": "user", "content": "What's the weather in Tokyo?"}],
    tools=[{
        "type": "function",
        "function": {
            "name": "get_weather",
            "description": "Get current weather for a city",
            "parameters": {
                "type": "object",
                "properties": {"city": {"type": "string"}},
                "required": ["city"],
            },
        },
    }],
)
# response.choices[0].message.tool_calls → standard OpenAI tool_calls

cURL:

# List available models
curl http://localhost:3456/v1/models

# Chat completion
curl http://localhost:3456/v1/chat/completions \
  -H "Content-Type: application/json" \
  -d '{"model":"claude-sonnet-4-20250514","messages":[{"role":"user","content":"Hello!"}]}'

If you have set TFG_API_KEY, add -H "Authorization: Bearer <your-key>" to every request (except /health).

Supported Providers

| Provider | Model ID prefix | Auth Method | Client | | ----------- | --------------- | --------------------- | ------------------------- | | Claude | claude-* | Session cookie | CDP (browser fetch) | | ChatGPT | chatgpt-* | Access token + cookie | CDP (browser fetch) | | DeepSeek | deepseek-* | Bearer token + cookie | CDP (browser fetch + PoW) | | Doubao | doubao-* | Session cookie | CDP (browser fetch) | | Gemini | gemini-* | Google SID cookie | CDP (browser fetch) | | GLM (智谱) | glm-* | Refresh token cookie | CDP (browser fetch) | | GLM Intl | glm-intl-* | Session cookie | CDP (browser fetch) | | Grok | grok-* | SSO cookie | CDP (browser fetch) | | Kimi | kimi-* | Access token | CDP (browser fetch) | | Perplexity | perplexity-* | Next-auth cookie | CDP (browser fetch) | | Qwen | qwen-* | Session cookie | CDP (browser fetch) | | Qwen CN | qwen-cn-* | XSRF + cookie | CDP (browser fetch) | | Xiaomi MiMo | xiaomimo-* | Bearer token | CDP (browser fetch) |

All providers share a centralized BrowserManager that maintains a single CDP connection to Chrome with auto-reconnection and health monitoring.

CLI Reference

token-free-gateway [command] [options]

Commands:
  serve               Start in foreground (default)
  start               Start as background daemon
  stop                Stop the daemon
  restart             Restart the daemon
  status              Show running status
  webauth             Authorize web AI providers
  chrome [start|stop] Launch/stop Chrome debug mode

Options:
  --help, -h          Show help
  --version, -v       Show version

Configuration

Two ways to configure the gateway — pick whichever fits your workflow:

TFG_* environment variables  ← highest priority
        ↓ fall through if not set
~/.token-free-gateway/config.json
        ↓ fall through if not set
built-in defaults             ← lowest priority

Option A — config file (recommended)

On first start the gateway automatically creates ~/.token-free-gateway/config.json with all defaults filled in:

{
  "port": 3456,
  "apiKey": "",
  "cdpUrl": "http://127.0.0.1:9222"
}

Edit the fields you want to change and leave the rest as-is.

| Field | Default | Description | | -------- | ----------------------- | --------------------------------------------- | | port | 3456 | Server listen port | | apiKey | "" (disabled) | Bearer token for client auth; empty = no auth | | cdpUrl | http://127.0.0.1:9222 | Chrome DevTools Protocol endpoint |

Option B — environment variables

All variables use the TFG_ prefix to avoid conflicts with other software.

| Variable | Default | Description | | ------------- | ----------------------- | --------------------------------------------- | | TFG_PORT | 3456 | Server listen port | | TFG_API_KEY | "" (disabled) | Bearer token for client auth; empty = no auth | | TFG_CDP_URL | http://127.0.0.1:9222 | Chrome DevTools Protocol endpoint |

You can also put them in a .env file next to the binary — Bun loads it automatically:

TFG_PORT=3456
TFG_API_KEY=my-secret-key
TFG_CDP_URL=http://127.0.0.1:9222

Note: environment variables always win over config.json, so you can use the file for defaults and override individual values per-session with env vars.

API Endpoints

| Method | Path | Auth | Description | | ------ | ---------------------- | -------- | -------------------------------------------- | | POST | /v1/chat/completions | Required | Chat completions (streaming + non-streaming) | | GET | /v1/models | Required | List models from authorized providers | | GET | /v1/models/:id | Required | Get model details | | GET | /health | Public | Health check (includes browser CDP status) |

"Required" means the Authorization: Bearer <TFG_API_KEY> header is checked only when TFG_API_KEY is configured. If unset, all endpoints are open.

How It Works

sequenceDiagram
    participant C as Client (OpenAI SDK)
    participant G as Token-Free Gateway
    participant B as BrowserManager
    participant Ch as Chrome (CDP)
    participant P as Web AI Provider

    C->>G: POST /v1/chat/completions<br/>(messages + tools)
    G->>G: tools → prompt injection<br/>route to provider
    G->>B: getPage(provider domain)
    B->>Ch: CDP connection (auto-reconnect)
    Ch->>P: Browser-side fetch (with cookies)
    P-->>Ch: Response
    Ch-->>B: page.evaluate result
    B-->>G: Parsed response
    G->>G: Parse text → tool_calls
    G-->>C: OpenAI-format tool_calls

    Note over C: Client executes tools locally

    C->>G: POST /v1/chat/completions<br/>(messages + tool results)
    G->>B: Forward via CDP
    B->>Ch: Browser-side fetch
    Ch->>P: Request with session
    P-->>Ch: Final response
    Ch-->>G: Result
    G-->>C: Final answer

All API requests to web AI providers are executed inside the browser via Chrome DevTools Protocol (CDP), bypassing Cloudflare and other bot-protection systems. A centralized BrowserManager singleton manages the shared CDP connection with auto-reconnection, health monitoring, and Chrome auto-start.

Platform Compatibility

| Feature | macOS | Linux | Windows | | -------------------------------- | ----- | ----- | ------------------------------- | | Gateway (serve/start/stop) | ✅ | ✅ | ✅ | | chrome command | ✅ | ✅ | ✅ | | start-chrome-debug.sh | ✅ | ✅ | ✅ (use chrome start instead) | | All providers | ✅ | ✅ | ✅ |

Dev Scripts

bun run dev         # Dev server with hot reload
bun run test        # Unit tests
bun run check       # Biome lint + format check
bun run lint:fix    # Auto-fix all issues
bun run typecheck   # TypeScript check
bun run build       # Compile standalone binary
bun run bump        # Show current version
bun run bump:patch  # Bump patch version (x.y.Z) and sync all package.json files
bun run bump:minor  # Bump minor version (x.Y.0) and sync all package.json files
bun run bump:major  # Bump major version (X.0.0) and sync all package.json files

Troubleshooting

| Problem | Solution | | ------------------------------- | ------------------------------------------------------------------------- | | /v1/models returns empty | Run token-free-gateway webauth to authorize providers | | /health returns degraded | Chrome is not reachable — run token-free-gateway chrome start | | webauth hangs | Press Ctrl+C — credentials are saved | | Chrome auto-start fails | Run token-free-gateway chrome start manually, then rerun webauth | | Chrome port 9222 already in use | Stop conflicting process: lsof -i:9222 / netstat -ano \| findstr 9222 | | DeepSeek auth fails | Keep DeepSeek chat page open during webauth | | Daemon not starting | Check logs: ~/.token-free-gateway/gateway.log |

Acknowledgments

This project was distilled and redesigned from openclaw-zero-token, extracting the web AI provider layer and OpenAI compatibility module into a standalone, lightweight gateway focused purely on protocol conversion.

License

MIT