Skip to content

Commit f99a563

Browse files
author
echoVic
committed
docs: 更新文档内容,添加自定义Provider和OAuth命令说明
- 在quick-start.md中添加自定义OpenAI兼容Provider的配置步骤 - 更新tool-list.md中Edit和Shell工具的详细参数说明 - 在slash-commands.md中新增/login和/logout命令文档 - 在config-system.md中补充自定义Provider的配置流程
1 parent 60fce5a commit f99a563

4 files changed

Lines changed: 92 additions & 12 deletions

File tree

docs/configuration/config-system.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,45 @@ Step 3: 选择模型(从内置列表选择)
7979
└─────────────────────────────────────┘
8080
```
8181

82+
### 自定义 Provider
83+
84+
如果你的 Provider 不在列表中,选择 **🔧 自定义 OpenAI Compatible**
85+
86+
```
87+
Step 1: 选择 "🔧 自定义 OpenAI Compatible"
88+
┌─────────────────────────────────────┐
89+
│ 📡 选择 Provider [搜索] │
90+
│ 🚀 Google Antigravity │
91+
│ 🐙 GitHub Copilot │
92+
│ ▶ 🔧 自定义 OpenAI Compatible │
93+
│ 🤖 Anthropic │
94+
│ ... 更多 │
95+
└─────────────────────────────────────┘
96+
97+
Step 2: 输入 API Key
98+
┌─────────────────────────────────────┐
99+
│ 🔑 输入 API Key │
100+
│ ▶ sk-_____________________________ │
101+
└─────────────────────────────────────┘
102+
103+
Step 3: 输入 Base URL(必填)
104+
┌─────────────────────────────────────┐
105+
│ 🌐 输入 Base URL │
106+
│ ▶ https://api.example.com/v1______ │
107+
└─────────────────────────────────────┘
108+
109+
Step 4: 输入模型名称
110+
┌─────────────────────────────────────┐
111+
│ 🤖 输入模型名称 │
112+
│ ▶ gpt-4o-mini_____________________ │
113+
└─────────────────────────────────────┘
114+
```
115+
116+
适用于任何兼容 OpenAI API 格式的服务,如:
117+
- 私有部署的 LLM 服务
118+
- 企业内部 API 网关
119+
- 其他未列出的第三方服务
120+
82121
## config.json(基础配置)
83122

84123
### 多模型配置

docs/getting-started/quick-start.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,17 @@ blade "帮我分析这个项目的架构"
6767

6868
配置完成后,使用 `/model` 命令切换模型。
6969

70+
### 自定义 Provider
71+
72+
如果你的 Provider 不在列表中,选择 **🔧 自定义 OpenAI Compatible**
73+
74+
1. 选择 "🔧 自定义 OpenAI Compatible"
75+
2. 输入 API Key
76+
3. 输入 Base URL(必填,例如 `https://api.example.com/v1`
77+
4. 输入模型名称
78+
79+
适用于任何兼容 OpenAI API 格式的服务。
80+
7081
## 基本交互
7182

7283
### 对话

docs/guides/slash-commands.md

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ Slash 命令是 Blade 的快捷操作入口,输入 `/` 触发建议,`Tab`
2424
| `/resume` | - | 恢复历史会话 |
2525
| `/compact` | - | 手动压缩上下文 |
2626
| `/git` | `/g` | Git 操作 |
27+
| `/login` | - | 登录 OAuth 服务 |
28+
| `/logout` | - | 登出 OAuth 服务 |
2729

2830
## 命令详解
2931

@@ -43,9 +45,14 @@ Slash 命令是 Blade 的快捷操作入口,输入 `/` 触发建议,`Tab`
4345
模型管理命令:
4446

4547
```bash
46-
/model # 打开模型选择器
47-
/model add # 添加新模型配置
48-
/model remove <name> # 删除指定模型
48+
/model # 打开模型选择器(交互式切换)
49+
/model add # 添加新模型配置(交互式向导)
50+
/model remove <名称> # 删除指定模型(按名称模糊匹配)
51+
```
52+
53+
示例:
54+
```bash
55+
/model remove 千问 # 删除名称包含"千问"的模型
4956
```
5057

5158
### /git
@@ -89,6 +96,29 @@ Git 仓库查询和 AI 辅助:
8996
/compact
9097
```
9198

99+
### /login
100+
101+
登录 OAuth 服务(Antigravity / Copilot):
102+
103+
```bash
104+
/login # 默认登录 Google Antigravity
105+
/login copilot # 登录 GitHub Copilot
106+
/login gemini # 登录 Gemini CLI
107+
```
108+
109+
支持的服务:
110+
- **Google Antigravity** - 通过 Google OAuth 认证,支持 Claude、Gemini 模型(需 Code Assist 订阅)
111+
- **GitHub Copilot** - 通过 GitHub OAuth 认证,支持 GPT、Claude、Gemini 模型(需 Copilot 订阅)
112+
113+
### /logout
114+
115+
登出 OAuth 服务:
116+
117+
```bash
118+
/logout # 默认登出 Google Antigravity
119+
/logout copilot # 登出 GitHub Copilot
120+
```
121+
92122
### /permissions
93123

94124
打开权限管理器,编辑 `.blade/settings.local.json`

docs/reference/tool-list.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,18 @@
3535

3636
### Edit
3737

38-
按字符串或正则表达式替换文件内容
38+
执行精确字符串替换
3939

4040
| 参数 | 类型 | 必填 | 说明 |
4141
|------|------|------|------|
4242
| `file_path` | string || 文件绝对路径 |
43-
| `old_string` | string | | 要替换的字符串 |
44-
| `new_string` | string | | 替换后的字符串 |
45-
| `pattern` | string | | 正则表达式模式 |
46-
| `max_replacements` | number | | 最大替换次数 |
43+
| `old_string` | string || 要替换的字符串(不能为空) |
44+
| `new_string` | string || 替换后的字符串(可以为空) |
45+
| `replace_all` | boolean | | 是否替换所有匹配(默认仅替换第一个) |
4746

4847
**类型**: Write
49-
**特性**: 支持回滚、预览、并发文件锁
48+
**特性**: 支持回滚、预览、并发文件锁
49+
**注意**: 使用前必须先用 Read 工具读取文件
5050

5151
### NotebookEdit
5252

@@ -103,11 +103,11 @@
103103
| `command` | string || 要执行的命令 |
104104
| `cwd` | string | | 工作目录 |
105105
| `env` | object | | 环境变量 |
106-
| `background` | boolean | | 后台运行 |
107-
| `timeout` | number | | 超时时间(毫秒) |
106+
| `run_in_background` | boolean | | 后台运行(适用于长时间运行的命令) |
107+
| `timeout` | number | | 超时时间(毫秒,默认 30000|
108108

109109
**类型**: Execute
110-
**返回**: 后台运行时返回 `bash_id`,可用于后续查询
110+
**返回**: 后台运行时返回 `bash_id``shell_id`,可用于 KillShell 或 TaskOutput 查询
111111

112112
### KillShell
113113

0 commit comments

Comments
 (0)