prx/.env.example at main · openprx/prx · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# PRX Environment Variables
# Copy this file to `.env` and fill in your local values.
# Never commit `.env` or any real secrets.

# ── Core Runtime ──────────────────────────────────────────────
# Provider key resolution at runtime:
# 1) explicit key passed from config/CLI
# 2) provider-specific env var (OPENROUTER_API_KEY, OPENAI_API_KEY, ...)
# 3) generic fallback env vars below

# Generic fallback API key (used when provider-specific key is absent)
API_KEY=your-api-key-here
# PRX_API_KEY=your-api-key-here

# Default provider/model (can be overridden by CLI flags)
PROVIDER=openrouter
# PRX_PROVIDER=openrouter
# PRX_MODEL=anthropic/claude-sonnet-4-6
# PRX_TEMPERATURE=0.7

# Workspace directory override
# PRX_WORKSPACE=/path/to/workspace

# Reasoning mode (enables extended thinking for supported models)
# PRX_REASONING_ENABLED=false
# REASONING_ENABLED=false

# ── Provider-Specific API Keys ────────────────────────────────
# OpenRouter
# OPENROUTER_API_KEY=sk-or-v1-...

# Anthropic
# ANTHROPIC_OAUTH_TOKEN=...
# ANTHROPIC_API_KEY=sk-ant-...

# OpenAI / Gemini
# OPENAI_API_KEY=sk-...
# GEMINI_API_KEY=...
# GOOGLE_API_KEY=...

# Other supported providers
# VENICE_API_KEY=...
# GROQ_API_KEY=...
# MISTRAL_API_KEY=...
# DEEPSEEK_API_KEY=...
# XAI_API_KEY=...
# TOGETHER_API_KEY=...
# FIREWORKS_API_KEY=...
# PERPLEXITY_API_KEY=...
# COHERE_API_KEY=...
# MOONSHOT_API_KEY=...
# GLM_API_KEY=...
# MINIMAX_OAUTH_TOKEN=...
# MINIMAX_API_KEY=...
# MINIMAX_OAUTH_REFRESH_TOKEN=...
# MINIMAX_OAUTH_REGION=global   # optional: global|cn
# QIANFAN_API_KEY=...
# DASHSCOPE_API_KEY=...
# ZAI_API_KEY=...
# SYNTHETIC_API_KEY=...
# OPENCODE_API_KEY=...
# VERCEL_API_KEY=...
# CLOUDFLARE_API_KEY=...

# ── Gateway ──────────────────────────────────────────────────
# PRX_GATEWAY_PORT=16830
# PRX_GATEWAY_HOST=127.0.0.1
# PRX_ALLOW_PUBLIC_BIND=false

# ── Storage ─────────────────────────────────────────────────
# Backend override for persistent storage (default: sqlite)
# PRX_STORAGE_PROVIDER=sqlite
# PRX_STORAGE_DB_URL=postgres://localhost/prx
# PRX_STORAGE_CONNECT_TIMEOUT_SECS=5

# ── Proxy ──────────────────────────────────────────────────
# Forward provider/service traffic through an HTTP(S) proxy.
# PRX_PROXY_ENABLED=false
# PRX_HTTP_PROXY=http://proxy.example.com:8080
# PRX_HTTPS_PROXY=http://proxy.example.com:8080
# PRX_ALL_PROXY=socks5://proxy.example.com:1080
# PRX_NO_PROXY=localhost,127.0.0.1
# PRX_PROXY_SCOPE=prx               # environment|prx|services
# PRX_PROXY_SERVICES=openai,anthropic

# ── Optional Integrations ────────────────────────────────────
# Pushover notifications (`pushover` tool)
# PUSHOVER_TOKEN=your-pushover-app-token
# PUSHOVER_USER_KEY=your-pushover-user-key

# ── Docker Compose ───────────────────────────────────────────
# Host port mapping (used by docker-compose.yml)
# HOST_PORT=16830

# ── Z.AI GLM Coding Plan ───────────────────────────────────────
# Z.AI provides GLM models through OpenAI-compatible endpoints.
# API key format: id.secret (e.g., abc123.xyz789)
#
# Usage:
#   prx onboard --provider zai --api-key YOUR_ZAI_API_KEY
#
# Or set the environment variable:
# ZAI_API_KEY=your-id.secret
#
# Common models: glm-5, glm-4.7, glm-4-plus, glm-4-flash
# See docs/zai-glm-setup.md for detailed configuration.

# ── Web Search ────────────────────────────────────────────────
# Web search tool for finding information on the internet.
# Enabled by default with DuckDuckGo (free, no API key required).
#
# WEB_SEARCH_ENABLED=true
# WEB_SEARCH_PROVIDER=duckduckgo
# WEB_SEARCH_MAX_RESULTS=5
# WEB_SEARCH_TIMEOUT_SECS=15
#
# Agent read-only tool scheduler (advanced)
# READ_ONLY_TOOL_CONCURRENCY_WINDOW=2
# READ_ONLY_TOOL_TIMEOUT_SECS=30
# PRIORITY_SCHEDULING_ENABLED=false
# CONCURRENCY_KILL_SWITCH_FORCE_SERIAL=false
# CONCURRENCY_ROLLOUT_STAGE=off
# CONCURRENCY_ROLLOUT_SAMPLE_PERCENT=0
# CONCURRENCY_ROLLOUT_CHANNELS=telegram,discord
# CONCURRENCY_AUTO_ROLLBACK_ENABLED=true
# CONCURRENCY_ROLLBACK_TIMEOUT_RATE_THRESHOLD=0.20
# CONCURRENCY_ROLLBACK_CANCEL_RATE_THRESHOLD=0.20
# CONCURRENCY_ROLLBACK_ERROR_RATE_THRESHOLD=0.20
#
# Optional: Brave Search (requires API key from https://brave.com/search/api)
# WEB_SEARCH_PROVIDER=brave
# BRAVE_API_KEY=your-brave-search-api-key