Skip to content

Commit 39f3444

Browse files
committed
chore: doc update
1 parent db1583e commit 39f3444

6 files changed

Lines changed: 15 additions & 12 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,7 @@ body:
149149
options:
150150
- OpenAI(POST /v1/chat/completions)
151151
- Anthropic(POST /v1/messages)
152+
- Responses(POST /v1/responses,Codex 等)
152153
validations:
153154
required: true
154155

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
blank_issues_enabled: false
22
contact_links:
33
- name: 📖 使用文档
4-
url: https://github.com/tridefender/zcode-proxy/blob/master/README.md
4+
url: https://github.com/TriDefender/zcode-api/blob/master/README.md
55
about: 先看 README,大部分配置问题(auth / provider / plan / 端点 / 模型列表)都在这里有答案。

‎Android-APP/README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,9 @@ cd Android-APP
5858
- `Android-APP/app/src/main/assets/server_bundle/` — generated `server.cjs`
5959
plus `captcha-worker-entry.cjs` (start-plan captchas are solved strictly in
6060
worker processes on Android); the web UI, system prompt and config template
61-
are inlined into the bundle. It is gitignored build output — regenerate via
61+
are inlined into the bundle. `server.cjs` is gitignored build output;
62+
`captcha-worker-entry.cjs` is committed to the repo (a regenerated copy
63+
must be re-committed) — regenerate via
6264
`bun run build:android-bundle` + copy both files from `dist/android/` into
6365
it before building (Gradle's `checkServerBundle` preBuild task fails with a
6466
hint if either is missing).

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
- 💬 **自带网页聊天** —— 打开 `/webui` 就是一个本地 ChatGPT 风格聊天页,随手测试模型。
2727
- 🌙 **闲时通道 & 套餐秒抢**(可选)—— 错峰时段的免费额度通道、限量体验套餐自动领取,都是内置功能。
2828
- 🔌 **套餐内 MCP 聚合端点** —— ZCode 官方插件 MCP(天眼查 / Wind / 同花顺 iFinD…,134+ 工具)聚合到**单一** `/mcp` 端点(streamable HTTP,工具名 `{plugin}__{tool}` 命名空间化——客户端只配一个 MCP server 即可,需 coding-plan 登录,浏览器 `GET /mcp` 查看目录);自带网页聊天还能外挂你自己的 MCP 服务器给模型当工具用。
29+
- 🎨 **套餐内 Seed 系媒体接口** —— 生图(Seedream)、生视频(SeedDance 任务式)、语音识别 / 语音合成(Seed-ASR / Seed-Audio)以火山方舟同形状的 `/api/v3/*` REST 端点暴露在本机(默认开启,翻译到官方 ToolHub / video_edit 网关;需 coding-plan 登录,消耗套餐内额度,端点与体限详见 [`config.example.yaml`](config.example.yaml))。
2930
- 🪟 **全平台** —— Windows / macOS / Linux 一份代码直接跑,也能编译成单文件程序或 Docker 部署。
3031

3132
## 🚀 一分钟上手
@@ -47,8 +48,7 @@
4748
| 按键 | 作用 |
4849
|------|------|
4950
| <kbd>s</kbd> | 启动 / 停止代理 |
50-
| <kbd>l</kbd> | 登录当前服务商(打开浏览器授权) |
51-
| <kbd>L</kbd> | bigmodel 粘贴登录(回退模式;`l` 登录本身就免回调,无头可用) |
51+
| <kbd>l</kbd> | 打开登录页(选 Z.ai 国际版 / 中国版,浏览器完成授权后自动回填;需先停代理) |
5252
| <kbd>o</kbd> | 退出登录 |
5353
| <kbd>p</kbd> / <kbd>t</kbd> | 切换服务商(Z.AI ↔ 智谱)/ 套餐(coding-plan ↔ start-plan) |
5454
| <kbd>r</kbd> | 刷新套餐用量 |
@@ -242,7 +242,7 @@ ssh -N -L 8090:127.0.0.1:8090 user@host
242242
## ❓ 常见问题
243243

244244
**启动就退出,提示 Not logged in?**
245-
先登录:`bun run src/index.ts auth login zai`(或 bigmodel)。登录一次即可,凭据加密保存。
245+
先登录:`bun run src/index.ts auth login zai`(或 `zai_cn`——BigModel / 智谱账号请用中国版,账号互链自动识别订阅)。登录一次即可,凭据加密保存。
246246

247247
**端口 8080 被占了?**
248248
环境变量换一个:`ZCODE_PROXY_PORT=8081 bun run src/index.ts`,或改 `config.yaml` 的 `server.port`。
@@ -254,7 +254,7 @@ ssh -N -L 8090:127.0.0.1:8090 user@host
254254
要。凭据加密时绑定了本机信息。跨机器迁移可以两边都设 `ZCODE_PROXY_CREDENTIAL_SECRET` 为同一个值再登录/拷贝 `~/.zcode-proxy/credentials.json`。
255255

256256
**服务器上没有浏览器怎么登录?**
257-
直接登录即可:`bun run src/index.ts auth login zai`(或 bigmodel)。登录链接在任何设备的浏览器打开都行,授权后本机自动完成(无需回调页面)。若想手动交换,也有粘贴模式:`auth login bigmodel --paste`,把跳转后的完整网址粘回来即可。
257+
直接登录即可:`bun run src/index.ts auth login zai`(或 `zai_cn`)。登录链接在任何设备的浏览器打开都行,授权后本机自动完成(无需回调页面)。存量 bigmodel API key 可用 `auth login bigmodel --import` 导入(bigmodel OAuth 登录与粘贴模式已移除)。
258258

259259
**它在后台到底做了什么?**
260260
它就是一个"翻译官 + 传话员":把你的工具发出的标准请求翻译成官方客户端的同款请求转发上去,再把回复原样翻译回来。所有流量都只在你本机和官方服务器之间,不经过任何第三方。

‎README_EN.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Codex, Silly Tavern … can all use your plan quota directly.
2727
- 💬 **Web chat included** — open `/webui` for a local ChatGPT-style chat page to try out models.
2828
- 🌙 **Off-peak channel & plan grabber** (optional) — a free-quota channel for off-peak hours and automatic claiming of limited trial plans are both built in.
2929
- 🔌 **In-plan MCP aggregate endpoint** — official ZCode plugin MCPs (Tianyancha / Wind / iFinD…, 134+ tools) are merged behind a **single** `/mcp` endpoint (streamable HTTP, tools namespaced `{plugin}__{tool}` — clients configure just one MCP server; requires a coding-plan login, `GET /mcp` in a browser shows the catalogue); the built-in web chat can also attach your own MCP servers as tools for the model.
30+
- 🎨 **In-plan Seed media endpoints** — image generation (Seedream), video generation (SeedDance task-based), speech recognition / synthesis (Seed-ASR / Seed-Audio) are exposed as Volcano Ark-shaped `/api/v3/*` REST endpoints on the local proxy (on by default; translated to the official ToolHub / video_edit gateways — requires a coding-plan login and spends plan entitlements; endpoints and body limits are documented in [`config.example.yaml`](config.example.yaml)).
3031
- 🪟 **Cross-platform** — Windows / macOS / Linux run from one codebase; can also be compiled into a single-file executable or deployed with Docker.
3132

3233
## 🚀 Quick Start
@@ -48,8 +49,7 @@ The panel has four cards: **Login & Settings** (provider / plan / login), **Quot
4849
| Key | Action |
4950
|------|------|
5051
| <kbd>s</kbd> | Start / stop the proxy |
51-
| <kbd>l</kbd> | Log in to the current provider (opens the browser for authorization) |
52-
| <kbd>L</kbd> | bigmodel paste login (fallback mode; the `l` login itself is callback-free and works headless) |
52+
| <kbd>l</kbd> | Open the login page (pick Z.ai International / China, authorize in the browser; stop the proxy first) |
5353
| <kbd>o</kbd> | Log out |
5454
| <kbd>p</kbd> / <kbd>t</kbd> | Switch provider (Z.AI ↔ Zhipu) / plan (coding-plan ↔ start-plan) |
5555
| <kbd>r</kbd> | Refresh the quota card |
@@ -243,7 +243,7 @@ The table below is for reference only:
243243
## ❓ FAQ
244244

245245
**It exits right after startup saying "Not logged in"?**
246-
Log in first: `bun run src/index.ts auth login zai` (or bigmodel). Logging in once is enough; credentials are stored encrypted.
246+
Log in first: `bun run src/index.ts auth login zai` (or `zai_cn` — BigModel / Zhipu accounts use the China option; linked accounts get their plan recognized automatically). Logging in once is enough; credentials are stored encrypted.
247247

248248
**Port 8080 is already taken?**
249249
Pick another one via an environment variable: `ZCODE_PROXY_PORT=8081 bun run src/index.ts`, or change `server.port` in `config.yaml`.
@@ -255,7 +255,7 @@ If you've set `ZCODE_PROXY_API_KEY`, your tool must send the same value; without
255255
Yes. Credentials are encrypted with machine-bound information. To migrate across machines, set the same `ZCODE_PROXY_CREDENTIAL_SECRET` on both sides, then log in / copy `~/.zcode-proxy/credentials.json`.
256256

257257
**No browser on my server — how do I log in?**
258-
Just log in directly: `bun run src/index.ts auth login zai` (or bigmodel). The login link can be opened in any device's browser; after you authorize, the local side completes automatically (no callback page needed). If you prefer a manual exchange, there's also a paste mode: `auth login bigmodel --paste` — paste back the full URL you're redirected to.
258+
Just log in directly: `bun run src/index.ts auth login zai` (or `zai_cn`). The login link can be opened in any device's browser; after you authorize, the local side completes automatically (no callback page needed). An existing bigmodel API key can be imported with `auth login bigmodel --import` (bigmodel OAuth login and the paste mode have been removed).
259259

260260
**What does it actually do in the background?**
261261
It's a "translator + courier": it translates the standard requests from your tools into the same requests the official client sends, forwards them, and translates the responses back as-is. All traffic stays between your machine and the official servers — it never passes through any third party.

‎config.example.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ auth:
88
proxyApiKey: "your-proxy-secret"
99

1010
# Upstream credentials come from the OAuth login flow — run this first:
11-
# bun run src/index.ts auth login <zai|bigmodel>
11+
# bun run src/index.ts auth login <zai|zai_cn>
1212
# Parsed but currently not honored — the credential store path is fixed at
1313
# ~/.zcode-proxy/credentials.json:
1414
# oauthCredentialsPath: "~/.zcode-proxy/credentials.json"
@@ -170,7 +170,7 @@ async:
170170
# client version or the server rejects with `ineligible` — an app_version
171171
# below the floor can also surface as a silently empty preview list
172172
# (measured floor 3.14.0 for the 2026-09 campaign; the built-in appVersion
173-
# "3.17.1" satisfies it).
173+
# "3.18.2" satisfies it).
174174
#
175175
# Env overrides: ZCODE_CLAIM_ENABLED, ZCODE_CLAIM_AUTO, ZCODE_CLAIM_ORIGIN,
176176
# ZCODE_CLAIM_POLL_INTERVAL_MS.

0 commit comments

Comments
 (0)