Files
ProxyPilot/docs/proxypilot.md
2026-05-18 19:16:51 +07:00

3.0 KiB
Raw Permalink Blame History

ProxyPilot

ProxyPilot is a local AI proxy with CLI + system tray interface for agentic tools (Droid/Factory, Codex CLI, Warp).

This repo started as a fork of CLIProxyAPI, but is now branded as ProxyPilot. For compatibility, some internal names and headers still use CLIProxyAPI (e.g. X-CLIProxyAPI-*).

What’s included

  • ProxyPilot tray app (Windows) to start/stop/restart the proxy engine, open the web dashboard in browser, open logs, and toggle autostart.
  • Prompt-budget middleware to reduce “prompt too long” failures in strict CLIs.
  • Long-session memory with pinned state + persistent TODO (local disk).
  • Optional auth debugging and cooldown reset endpoints for local troubleshooting.

Install / uninstall (Windows)

  • Install: run dist\\ProxyPilot-Setup.exe
  • Launch: Start Menu → ProxyPilot
  • Uninstall: Settings → Apps → Installed apps → ProxyPilot → Uninstall

Build / package

If you have Go installed:

  • Build binaries: go run .\\cmd\\proxypilotpack build
  • Package zip: go run .\\cmd\\proxypilotpack package-zip → dist\\ProxyPilot.zip
  • Package installer (recommended): go run .\\cmd\\proxypilotpack package-inno (requires Inno Setup ISCC.exe) → dist\\ProxyPilot-Setup.exe

Endpoints / health

  • GET /healthz (no auth)
  • GET /v1/models (requires API key)
  • GET /proxypilot.html (local-only ProxyPilot dashboard; no manual key entry)

Example:

  • curl -H "Authorization: Bearer local-dev-key" http://127.0.0.1:<port>/v1/models

Autostart toggles (tray)

ProxyPilot tray app can toggle:

  • Launch on login (starts ProxyPilot)
  • Auto-start proxy (starts the proxy engine when ProxyPilot launches)

On Windows this uses a per-user Run entry (no admin required).

Local management (Dashboard / tray)

When the proxy is started by the ProxyPilot tray app, it sets a per-user MANAGEMENT_PASSWORD for the engine process so /v0/management/* endpoints are enabled for local use.

The password is stored in the ProxyPilot UI state file:

  • %LOCALAPPDATA%\\ProxyPilot\\ui-state.json (preferred)
  • legacy fallback: %LOCALAPPDATA%\\CLIProxyAPI\\ui-state.json (migrates to %LOCALAPPDATA%\\ProxyPilot\\ui-state.json)

OAuth helpers (tray)

ProxyPilot tray app includes:

  • Private OAuth window toggle (opens Edge --inprivate when available)
  • One-click login launchers: Antigravity, Gemini CLI, Codex, Claude, Qwen
  • Open Auth Folder shortcut

Account risk warning: Antigravity, Gemini/Gemini CLI, and Claude login launchers use unofficial compatibility OAuth paths. Providers may treat proxy, automation, shared-token, or third-party OAuth traffic as abnormal usage or a policy violation. These flows can risk quota loss, account restriction, or account suspension. Use disposable or non-critical accounts only if you accept that risk; prefer official API keys or officially supported developer access for important accounts.

Logs / diagnostics

Useful paths:

  • logs/proxypilot-engine.out.log
  • logs/proxypilot-engine.err.log
  • logs/v1-responses-*.log / logs/v1-chat-completions-*.log (request logs, if enabled)