Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ccs.kaitran.ca/llms.txt

Use this file to discover all available pages before exploring further.

CLIProxy API Integration

CCS uses CLIProxyAPI by default, with an opt-in CLIProxyAPIPlus community fork for plus-only providers. In the current CCS UI, that capability is split across three routes, not one generic page.

Current Surface Map

RouteWhat lives thereUse it when
/cliproxyOAuth overview workspaceprovider status, variants, quick setup, routing, account actions
/cliproxy/ai-providersAI Providers workspaceAPI-key and connector routes that belong inside CLIProxy
/cliproxy/control-panelembedded control panelupstream management-center features that CCS does not re-skin

OAuth Overview Workspace

CLIProxy overview workspace
The /cliproxy route is the main CCS-owned control surface. It includes:
  • a provider rail for authenticated OAuth providers
  • a variant list for CCS-managed provider variants
  • a proxy status widget and backend label
  • quick setup for guided first-time configuration
  • provider editors for accounts, models, targets, and routing
  • deep links such as ?provider=claude and ?action=auth for focused flows

Supported OAuth Providers

ProviderStatusNotes
ClaudeOAuthAnthropic Claude with quota support
GeminiOAuthGoogle Gemini via OAuth
CodexOAuthOpenAI Codex routing
AntigravityOAuthmulti-account routing
GitHub Copilot (deprecated)OAuthCompatibility account routing with quota support
KiroOAuthAWS Builder ID / IDC-driven Kiro access
QwenOAuthAlibaba Qwen Code
iFlowOAuthalternative AI routing
KimiOAuthMoonshot Kimi OAuth-backed routing
CursorOAuthbrowser-driven polling flow via CLIProxy
GitLab DuoOAuth / PATbrowser OAuth or PAT login on the same shortcut
CodeBuddyOAuthbrowser-driven polling flow via CLIProxy
Kilo AIOAuthdevice-code flow through CLIProxy

Quota-Supported Providers

agy · claude · codex · gemini Deprecated compatibility provider: ghcp

Backend Requirements

CCS can authenticate 13 CLIProxy providers today, but not all of them work on both backend binaries.
  • original is the default backend and tracks router-for-me/CLIProxyAPI
  • plus downloads the maintained kaitranntt/CLIProxyAPIPlus fork and migrates legacy deleted-upstream Plus installs safely to the original backend
  • The embedded control panel follows the backend: original uses upstream CPAMC, while plus uses the maintained kaitranntt/Cli-Proxy-API-Management-Center dashboard fork
  • Works on original or plus: agy, claude, codex, gemini, iflow, kimi, qwen
  • Requires plus: kiro, cursor, gitlab, codebuddy, kilo, and deprecated ghcp compatibility
Sanitized CCS proxy settings showing remote mode and fallback controls
The same backend choice is reflected in the dashboard proxy settings. Keep fallback enabled when you need remote proxy convenience without making local launches depend on a single unavailable upstream. Advanced users can override the generated CPAMC source with cliproxy.management_panel_repository.

Model Catalogs And Pickers

CCS treats CLIProxy management model definitions as the primary catalog source. The dashboard resolves model metadata in this order:
  1. live CLIProxy management catalog
  2. cached catalog snapshot
  3. static CCS fallback catalog
That keeps the overview workspace usable even when the proxy is briefly unavailable. The catalog-sync subset is currently 9 providers: agy · claude · codex · gemini · iflow · kimi · kiro · qwen Deprecated compatibility provider: ghcp The newer auth-capable providers (cursor, gitlab, codebuddy, kilo) are still current and supported, but they do not yet participate in the same local static catalog-sync pipeline.
ccs cliproxy catalog
ccs cliproxy catalog refresh
ccs cliproxy catalog reset
After a CLIProxyAPI or CLIProxyAPIPlus release, run ccs cliproxy --latest to update the local backend binary, then ccs cliproxy catalog refresh to refresh dashboard model pickers and static fallback metadata.

Routing Strategy

CCS exposes the proxy-wide routing strategy directly instead of inferring it from account mix.
StrategyBehaviorGood fit
round-robinspread requests across matching healthy accountseven usage and predictable distribution
fill-firstdrain one healthy account before touching backupskeep backup accounts cold until needed
CCS keeps round-robin as the default until you change it explicitly.
ccs cliproxy routing
ccs cliproxy routing explain
ccs cliproxy routing set fill-first
ccs cliproxy routing set round-robin

AI Providers Workspace

/cliproxy/ai-providers is now the dedicated home for non-OAuth upstreams that still belong to the proxy layer. Use it for:
  • API-key families such as Gemini, Codex, Claude-compatible, and Vertex routes
  • named OpenAI-compatible connectors
  • advanced route composition with prefixes, proxy overrides, headers, and model aliases
Use API Profiles instead when you want a CCS-native profile with its own .settings.json.

Control Panel Embed

/cliproxy/control-panel embeds the upstream management center inside the CCS dashboard shell.
  • Local mode reverse-proxies management.html through the dashboard server to avoid cross-origin and port issues
  • Remote mode uses the saved remote proxy config and bootstraps auth into the iframe when a management token is available
Use this page when the upstream management center already exposes the exact operation you need and CCS has intentionally chosen not to duplicate it.

Target Metadata

Variants on the overview route can carry a CCS target:
TargetCLIMeaning
claudeClaude Codedefault target
droidFactory Droidalternate runtime for compatible flows
ccs cliproxy create my-droid --provider gemini --target droid
ccs cliproxy edit my-droid --target droid
The target is CCS metadata layered on top of CLIProxy-managed routing.

Quick Start

ccs config
# Sidebar -> CLIProxy
Start on /cliproxy for OAuth-backed providers. Move to /cliproxy/ai-providers when you need API-key or connector routes. Open /cliproxy/control-panel when you need the upstream management-center surface.