EggPool
A lightweight, LAN-hosted proxy that aggregates multiple AI provider accounts behind one OpenAI/Anthropic-compatible endpoint.
Features
- Proxies model requests across multiple providers and accounts behind a single endpoint
- OpenAI- and Anthropic-compatible upstream request paths, with transparent bidirectional protocol transcoding
- Dynamically discovers available models; routes by quota utilization (load-based, never cost-based)
- Per-account outbound proxy support (pproxy — SOCKS5, HTTP, Shadowsocks)
- Tracks requests, tokens, latency, errors, and cost provenance in SQLite (
provider_reported, trusted localderived/partial, boundedestimated; reservation is advisory, not a floor) - Multi-page dashboard with 50+ themes, reliability, routing, and runtime views
- Model metadata enrichment from provider catalogs, OpenRouter, Artificial Analysis, and Hugging Face
- Provider-neutral request shaping: cache reporting, safe suffix compression, policy-scoped overrides, optional synthetic cache controls, and advisory threshold tuning
- Thinking/reasoning capability-aware routing with configurable budget mapping
- High-concurrency stream stability: bounded retry queue, lock-contention diagnostics, and an OpenCode-specific operator playbook for sustained coding-agent streaming loads
- Designed for lightweight deployments (Raspberry Pi, SBCs)
Quick Start
# Install (one-shot)
curl -fsSL https://raw.githubusercontent.com/eggstack/eggpool/main/scripts/install.sh | bash
# Interactive onboarding — connect providers, validate, start
eggpool onboard
# Install as a systemd service
sudo env "PATH=$PATH" "$(command -v eggpool)" deploy systemd --install
See Deployment for alternative install methods (pipx, manual, production) and the full deployment guide.
CLI Reference
| Command | Description |
|---|---|
eggpool serve |
Start the proxy server (daemon mode; --verbose for foreground) |
eggpool stop |
Stop the running server |
eggpool restart |
Fully restart the server (stop then start) |
eggpool rehash |
Restart to apply config changes |
eggpool onboard |
Interactive onboarding wizard |
eggpool connect |
Add a provider account interactively |
eggpool connect list |
List supported providers |
eggpool logout |
Remove a configured provider account |
eggpool check-config |
Validate configuration |
eggpool migrate |
Run database migrations |
eggpool models refresh |
Refresh the model catalog |
eggpool accounts list |
List configured provider accounts |
eggpool accounts status |
Show account status (provider, priority, weight, enabled) |
eggpool accounts explain |
Show per-account routing eligibility for a model |
eggpool stats transcoding |
Show protocol transcoding statistics |
eggpool stats repair-costs |
Dry-run/apply repair for suspicious historical request costs |
eggpool stats recompute-costs |
Recompute cost_microdollars on historical requests |
eggpool runtime-status |
Print runtime health summary |
eggpool backup |
Create a timestamped backup |
eggpool recover |
Restore from a backup archive |
eggpool deploy systemd |
Print/install systemd unit |
eggpool deploy cron |
Install watchdog cron (non-systemd) |
eggpool deploy backup-cron |
Install daily backup cron job |
eggpool deploy logrotate |
Print/install logrotate config |
eggpool deploy all |
Print every deployment snippet in sequence |
eggpool update |
Check for and install updates |
eggpool uninstall |
Uninstall EggPool from this machine |
All commands accept --config /path/to/config.toml. Config resolution: --config > $EGGPOOL_CONFIG > ~/.config/eggpool/config.toml > ./config.toml.
Full command reference: docs/deployment.md
Configuration
Configuration lives in a single TOML file. API keys are loaded from environment variables or .env.
# Example provider configuration
[providers.opencode-go]
id = "opencode-go"
base_url = "https://opencode.ai/zen/go/v1"
protocols = ["openai", "anthropic"]
[[providers.opencode-go.accounts]]
name = "personal"
api_key = "sk-your-opencode-go-key"
Use eggpool connect for interactive provider setup. See docs/providers.md for the full provider catalog, configuration details, and troubleshooting.
Key Config Sections
| Section | Purpose |
|---|---|
[server] |
Bind address, port (default 11300), API key, logging, threads |
[upstream] |
Upstream API base URL, timeouts, connection pool |
[database] |
SQLite path, WAL mode |
[models] |
Catalog refresh, exposure mode, model collapse, withdrawal policy |
[routing] |
Routing strategy, retry limits, quota mode, same-tier fairness |
[dashboard] |
Dashboard toggle, theme, refresh interval |
[providers.*] |
Provider configs with accounts and routing priority |
[network] |
Outbound transport, DNS cache |
[model_info] |
Optional model metadata refresh, aliases, overrides, and external source settings |
[transcoder] |
Protocol transcoding between OpenAI and Anthropic formats |
[compression] |
Request shaping: observe/safe, stable thresholds, transform toggles, advanced policy overrides |
[cache] |
Synthetic cache controls (post-route, disabled by default, dry-run first) |
The catalog refresh is non-destructive by default: failed, empty, or partial upstream responses never silently de-pool a healthy account. Set [models].catalog_withdrawal_policy (preserve_until_health default, confirmed_once, confirmed_twice) to opt into destructive behavior on authoritative refreshes. See architecture/README.md § Catalog Refresh Semantics.
Full config reference: config.example.toml | docs/providers.md
Protocol transcoding
When [transcoder] enabled = true, EggPool bridges OpenAI Chat Completions and Anthropic Messages bidirectionally so a single client ecosystem (e.g. OpenCode, which speaks only OpenAI) can reach Anthropic-only upstreams and vice versa.
What gets translated:
- Request bodies (text + tool-use + vision + thinking + structured outputs)
- Streaming SSE events (including tool-call deltas and thinking deltas)
- Non-retryable error envelopes
- Usage and cost fields (preserved exactly as the upstream reported them)
What is dropped with a structured warning log:
- OpenAI fields with no Anthropic equivalent (
logit_bias,presence_penalty,top_logprobs, etc.) - Anthropic fields with no OpenAI equivalent (
top_k,cache_control)
Feature flags ([transcoder.features]) — all off by default:
tools— bidirectional tool calling translationvision— image/document content partsthinking— extended thinking ↔ reasoning_contentstructured_outputs—response_format/json_schemacoercionanthropic_primitives—top_k,cache_control,context_management,container,mcp_servers
The streaming hot path is optimised for sustained concurrent coding-agent loads. See docs/transcoding.md for the full translation table, known limitations, and streaming performance notes.
Request shaping
EggPool includes an opt-in, cache-preserving request-shaping stack. With shipped defaults the entire stack is reporting-only: no request body, header, or route is altered. Routing remains load-based — cache, compression, synthetic-cache, and tuning fields never enter QuotaFairScorer.
The stack covers provider cache counters, request segmentation, native cache preservation, optional compression (observe → safe), optional synthetic cache annotations, and advisory tuning. The dashboard /cache page provides operator summary cards and drill-down tables; advanced diagnostics stay collapsed unless a warning is present.
| Operator guide | docs/cache-compression.md |
|---|---|
| Copy-pasteable profiles | docs/cache-compression-profiles.md |
| Troubleshooting | docs/cache-compression-troubleshooting.md |
| Architecture | architecture/README.md |
API Endpoints
| Method | Path | Description |
|---|---|---|
GET |
/v1/models |
List available models |
POST |
/v1/chat/completions |
OpenAI-compatible chat completions |
POST |
/v1/messages |
Anthropic-compatible messages |
GET |
/v1/healthz |
Liveness check |
GET |
/v1/readyz |
Readiness check |
GET |
/api/backoffs |
Active upstream-derived account backoffs (?now=<epoch> for reproducible snapshots) |
GET |
/api/model-info |
Enriched model metadata summaries |
GET |
/api/model-info/{model_id} |
Enriched metadata detail for one model |
GET |
/api/model-info/{model_id}/aliases |
Source-keyed alias rows for one model |
GET |
/api/model-info/sources |
Model-info source health and diagnostics per source |
POST |
/api/model-info/refresh |
Trigger model-info refresh (auth-gated; supports ?model_id=&source=&force=1) |
GET |
/api/stats/cache-observability |
Cache counter status coverage |
GET |
/api/stats/canonical-request-segmentation |
Segmentation status, not_collected / empty_request / parse_failure counts, and token estimates |
GET |
/api/stats/cache-stability |
Transcoder cache boundary tracker counters |
GET |
/api/stats/compression-observability |
Observe-mode opportunity, per-policy roll-ups |
GET |
/api/stats/compression-runtime |
Safe-mode applied/fallback counts and latency |
GET |
/api/stats/compression-policies |
Per-policy roll-up table |
GET |
/api/stats/synthetic-cache-observability |
Synthetic cache candidate / applied / native-preserved counts |
GET |
/api/stats/compression-tuning |
Threshold tuning recommendations |
GET |
/api/stats/request-shaping |
Operator-facing request-shaping summary |
GET |
/api/stats/runtime |
Runtime metrics, routing guardrails, background task summaries, stream diagnostics |
When [dashboard].enabled = true, a multi-page dashboard is served at / with request stats, latency metrics, provider health, model-info detail pages, and more. Stats API available under /api/stats/*.
Model-info observability
The dashboard /models page shows enriched model metadata from provider catalogs, OpenRouter, Artificial Analysis, and Hugging Face. It surfaces degraded-state notices when the model-info service is unavailable, and join-failure diagnostics when catalog rows don't match canonical lookups. The /api/stats/runtime endpoint includes a model_info section with source health. See docs/model-info-openrouter-debug.md for the live verification flow.
Documentation
| Topic | Link |
|---|---|
| Deployment (install, systemd, production) | docs/deployment.md |
| Provider catalog & configuration | docs/providers.md |
| Backup & restore | docs/backup-restore.md |
| Per-account outbound proxy | docs/proxy.md |
| Model context limits | docs/model-limits.md |
| Raspberry Pi setup | docs/raspberry-pi.md |
| Firewall configuration | docs/firewall.md |
| Filesystem layout | docs/filesystem-layout.md |
| Network & DNS diagnostics | docs/network-diagnostics.md |
| Protocol transcoding | docs/transcoding.md |
| Cache & compression operator guide | docs/cache-compression.md |
| Cache & compression profiles | docs/cache-compression-profiles.md |
| Cache & compression troubleshooting | docs/cache-compression-troubleshooting.md |
| OpenCode stream stability | docs/opencode-stream-stability.md |
| Model-info OpenRouter debugging | docs/model-info-openrouter-debug.md |
| Thinking & reasoning | docs/thinking.md |
| Architecture overview | architecture/README.md |
Development
uv sync --extra dev # install dependencies
uv run pytest # run all tests
uv run ruff format --check src/ tests/ scripts/
uv run ruff check src/ tests/ scripts/
uv run pyright src/ scripts/
# Optional `orjson` backend for the JSON helper (transcoding hot paths)
uv sync --extra fast # or: uv pip install 'eggpool[fast]'
# High-concurrency streaming reproducer (no real providers needed)
uv run python scripts/repro_high_concurrency_streams.py --concurrency 50 --cancel-rate 0.25
See AGENTS.md for focused test subset commands.
Agent Configuration
eggpool configsetup generates configuration snippets for popular coding agents:
| Target | Command | Output | --write default |
Model |
|---|---|---|---|---|
| OpenCode | eggpool configsetup opencode |
JSON provider config | N/A (clipboard) | auto |
| Claude Code | eggpool configsetup claude-code |
JSON snippet | N/A (clipboard) | N/A |
| Aider | eggpool configsetup aider |
Shell env exports | .env.eggpool |
recommended |
| Codex | eggpool configsetup codex |
TOML provider block | N/A (printed) | recommended |
| Qwen Code | eggpool configsetup qwen-code |
JSON provider block | N/A (printed) | optional |
| Kilo | eggpool configsetup kilo |
JSON provider block | N/A (printed) | optional |
| Continue | eggpool configsetup continue |
YAML model block | ~/.continue/eggpool.yaml |
usually yes |
| Cline | eggpool configsetup cline |
JSON profile | cline-eggpool.json |
recommended |
| Roo Code | eggpool configsetup roo-code |
JSON profile | roo-eggpool.json |
recommended |
| Goose | eggpool configsetup goose |
Shell env exports | N/A (printed) | recommended |
| OpenHands | eggpool configsetup openhands |
Shell env exports | N/A (printed) | recommended |
Shared options: --host, --base-url, --model, --write, --output, --force, --no-clipboard, --print-secret.
Generated JSON, TOML, YAML, and shell snippets escape catalog/config values for
the target format, including provider-suffixed model IDs.
Examples:
eggpool configsetup aider --model openai/gpt-4 --write
eggpool configsetup continue --model claude-sonnet-4 --output ~/.continue/eggpool.yaml
eggpool configsetup cline --no-clipboard
License
MIT
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file eggpool-0.6.4.tar.gz.
File metadata
- Download URL: eggpool-0.6.4.tar.gz
- Upload date:
- Size: 1.1 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.14.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
65750bb873aee4f6c7d8d00fd04a6a8b3db0e03642e6265b24d83cfa7a723ec8
|
|
| MD5 |
7c901afa8aa00b3ce4f62c6e7228e0d6
|
|
| BLAKE2b-256 |
d66890b46934ac70900cc583990a2751e2b9b0ef0d4cd303f4ca6b12fa373980
|
File details
Details for the file eggpool-0.6.4-py3-none-any.whl.
File metadata
- Download URL: eggpool-0.6.4-py3-none-any.whl
- Upload date:
- Size: 968.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.14.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
370d7fcc06fa675320aebc404ba5bfa39b4e88168f9b1ce07723e275e8b53475
|
|
| MD5 |
c63abd45499eca2ca696b662433fac27
|
|
| BLAKE2b-256 |
e8b4bbf4b0eb4d334e21307290f4a65587ff4d9ebf08834095076a08076774a6
|