Skip to content

Commit 81bc8be

Browse files
authored
Update README.md
Signed-off-by: TriDefender <nitric.trioxide@gmail.com>
1 parent 0992a61 commit 81bc8be

1 file changed

Lines changed: 5 additions & 60 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -25,57 +25,19 @@
2525
- 🌙 **闲时通道 & 套餐秒抢**(可选)—— 错峰时段的免费额度通道、限量体验套餐自动领取,都是内置功能。
2626
- 🪟 **全平台** —— Windows / macOS / Linux 一份代码直接跑,也能编译成单文件程序或 Docker 部署。
2727

28-
## 🚀 五分钟上手
28+
## 🚀 一分钟上手
2929

30-
### 第 1 步:安装 Bun
30+
### 第 1 步:从[GitHub Releases](https://github.com/TriDefender/zcode-api/releases)下载最新版本的exe
3131

32-
ZCode Proxy 依赖 [Bun](https://bun.sh) 运行(一个更快的 Node.js 替代品,装一次就行):
33-
34-
```bash
35-
# Windows (PowerShell)
36-
powershell -c "irm bun.sh/install.ps1 | iex"
37-
38-
# macOS / Linux
39-
curl -fsSL https://bun.sh/install | bash
40-
```
41-
42-
### 第 2 步:下载并安装
43-
44-
```bash
45-
git clone https://github.com/TriDefender/zcode-api.git
46-
cd zcode-api
47-
bun install
48-
```
49-
50-
### 第 3 步:登录账号
51-
52-
用你买过套餐的账号登录一次(浏览器授权,之后长期有效):
53-
54-
```bash
55-
bun run src/index.ts auth login zai # Z.AI 账号
56-
bun run src/index.ts auth login bigmodel # 或 智谱 Bigmodel 账号
57-
```
58-
59-
会自动打开浏览器完成授权,然后自动拿到 API Key,加密保存在 `~/.zcode-proxy/credentials.json`。
60-
61-
> 💡 **已经在用 ZCode 桌面版?** 可以跳过浏览器授权,直接导入:
62-
> `bun run src/index.ts auth login bigmodel --import`
63-
>
64-
> 💡 **服务器 / Docker 没有浏览器?** 用粘贴模式登录,见[常见问题](#-常见问题)。
65-
66-
### 第 4 步:启动
67-
68-
```bash
69-
bun run src/index.ts
70-
```
32+
没错,这就完了,就是这么简单
7133

7234
启动后进入终端控制面板(这就是主界面):
7335

7436
<img src="docs/images/tui-annotated.png" alt="ZCode Proxy 终端控制面板" width="980" />
7537

7638
面板分三块:**登录与设置**(服务商 / 套餐 / 登录)、**代理服务**(启动停止 / 当前配置)、**日志**(每个请求一行,实时滚动)。按 <kbd>s</kbd> 启动代理,看到 `Status: running` 就绪了。
7739

78-
> 用不惯键盘快捷键?面板上的按钮支持**鼠标点击**。想让它在后台静默运行?`bun run src/index.ts --cli serve`。
40+
> 用不惯键盘快捷键?面板上的按钮支持**鼠标点击**。想让它在后台静默运行?`bun run zcode-proxy --cli serve`。
7941
8042
### 面板快捷键
8143

@@ -154,7 +116,7 @@ Anthropic 格式的工具(如某些 Claude 客户端)地址填 `http://127.0
154116

155117
```bash
156118
curl http://127.0.0.1:8080/v1/chat/completions -H "Content-Type: application/json" -d '{
157-
"model": "glm-4.7",
119+
"model": "glm-5.3-flash",
158120
"messages": [{"role": "user", "content": "你好!"}]
159121
}'
160122
```
@@ -170,23 +132,6 @@ App 与电脑版功能对应:一键启动代理、扫码级简单配置、实
170132

171133
手机和电脑跑的是同一套核心:App 内置了完整的代理引擎,**手机本身就是一个独立的代理服务器**,局域网内的电脑也可以连手机上的代理地址一起用。
172134

173-
> 想自己构建 APK?见 [`Android-APP/AGENTS.md`](Android-APP/AGENTS.md)。
174-
175-
## 📦 换个方式运行
176-
177-
<details>
178-
<summary><b>编译成单文件程序</b>(不需要安装 Bun 也能跑)</summary>
179-
180-
```bash
181-
bun run build # Windows → zcode-proxy.exe
182-
bun run build:linux-x64 # Linux x64
183-
bun run build:darwin-arm64 # macOS Apple Silicon
184-
```
185-
186-
编译产物在项目根目录,双击或命令行运行即可,五平台交叉编译命令见 `package.json`。
187-
188-
</details>
189-
190135
<details>
191136
<summary><b>Docker 部署</b></summary>
192137

0 commit comments

Comments
 (0)