Quick Start

If you prefer the desktop app, start with the CCX Desktop setup guide and follow Install → Configure key → Start service → Agent configuration → Add channels → Verify requests.

Installation

Docker (Recommended)

docker run -d \
  --name ccx \
  -p 3000:3000 \
  -v ./config:/app/.config \
  -e PROXY_ACCESS_KEY=your-proxy-key \
  -e ADMIN_ACCESS_KEY=your-admin-key \
  ghcr.io/benedictking/ccx:latest

Binary

Download the binary for your platform from GitHub Releases, then run:

export PROXY_ACCESS_KEY=your-proxy-key
export ADMIN_ACCESS_KEY=your-admin-key
./ccx

The service listens on http://localhost:3000 by default.

Core Concepts

Channels

A channel represents a configured upstream API connection, including:

• API Key: Authentication credential for the upstream service
• Base URL: Upstream API endpoint
• Model List: Models available through this channel
• Priority: Scheduling weight

Five Proxy Endpoints

Endpoint	Path	Description
Claude Messages	/v1/messages	Claude native protocol
OpenAI Chat	/v1/chat/completions	OpenAI Chat protocol
Codex Responses	/v1/responses	OpenAI Responses protocol
Gemini	/v1beta/models/*	Gemini native protocol
Images	/v1/images/*	OpenAI Images protocol

Admin Console

Visit http://localhost:3000 and log in with your ADMIN_ACCESS_KEY.

From the admin console you can:

• Add and manage channels
• View request logs and traffic stats
• Test channel connectivity
• Adjust channel priorities

Next Steps

Head to Client Setup to configure Claude Code, Codex CLI / App, or OpenCode; head to Provider Setup to configure each LLM provider.