mirror of
https://github.com/Finesssee/ProxyPilot.git
synced 2026-11-19 02:17:46 +00:00
71 lines
2.5 KiB
Markdown
71 lines
2.5 KiB
Markdown
# ProxyPilot
|
||
|
||
ProxyPilot is a local “AI proxy + desktop UX” for agentic CLIs (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 dashboard, 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, iFlow
|
||
- `Open Auth Folder` shortcut
|
||
|
||
## 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)
|