@tencent-ai/agent-sdk 0.3.100 → 0.3.101
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cli/CHANGELOG.md +24 -0
- package/cli/dist/codebuddy-headless.js +128 -119
- package/cli/dist/web-ui/assets/{index-BoMlEqUE.js → index-CIqmZV3y.js} +109 -108
- package/cli/dist/web-ui/docs/cn/cli/bash-sandboxing.md +4 -4
- package/cli/dist/web-ui/docs/cn/cli/common-workflows.md +1 -1
- package/cli/dist/web-ui/docs/cn/cli/gitlab-ci-cd.md +2 -2
- package/cli/dist/web-ui/docs/cn/cli/iam.md +3 -3
- package/cli/dist/web-ui/docs/cn/cli/release-notes/README.md +1 -0
- package/cli/dist/web-ui/docs/cn/cli/release-notes/v2.68.0.md +28 -0
- package/cli/dist/web-ui/docs/cn/cli/sdk-python.md +1 -1
- package/cli/dist/web-ui/docs/cn/cli/sdk-typescript.md +1 -1
- package/cli/dist/web-ui/docs/cn/cli/security.md +2 -2
- package/cli/dist/web-ui/docs/cn/cli/settings.md +5 -5
- package/cli/dist/web-ui/docs/en/cli/bash-sandboxing.md +0 -67
- package/cli/dist/web-ui/docs/en/cli/common-workflows.md +4 -2
- package/cli/dist/web-ui/docs/en/cli/iam.md +4 -0
- package/cli/dist/web-ui/docs/en/cli/release-notes/README.md +1 -0
- package/cli/dist/web-ui/docs/en/cli/release-notes/v2.68.0.md +28 -0
- package/cli/dist/web-ui/docs/en/cli/sdk-python.md +0 -14
- package/cli/dist/web-ui/docs/en/cli/sdk-typescript.md +0 -11
- package/cli/dist/web-ui/docs/en/cli/security.md +0 -1
- package/cli/dist/web-ui/docs/search-index-en.json +1 -1
- package/cli/dist/web-ui/docs/search-index-zh.json +1 -1
- package/cli/dist/web-ui/docs/sidebar-en.json +1 -1
- package/cli/dist/web-ui/docs/sidebar-zh.json +1 -1
- package/cli/dist/web-ui/index.html +1 -1
- package/cli/package.json +1 -1
- package/cli/product.cloudhosted.json +2 -2
- package/cli/product.internal.json +2 -2
- package/cli/product.ioa.json +2 -2
- package/cli/product.json +3 -2
- package/cli/product.selfhosted.json +2 -2
- package/lib/query.d.ts.map +1 -1
- package/lib/query.js +5 -1
- package/lib/query.js.map +1 -1
- package/lib/transport/index.d.ts +1 -1
- package/lib/transport/index.d.ts.map +1 -1
- package/lib/transport/process-transport.d.ts +1 -1
- package/lib/transport/process-transport.d.ts.map +1 -1
- package/lib/transport/process-transport.js +5 -1
- package/lib/transport/process-transport.js.map +1 -1
- package/lib/types.d.ts +3 -0
- package/lib/types.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -70,7 +70,7 @@ CodeBuddy Code 具有原生沙箱功能,为智能体执行提供更安全的
|
|
|
70
70
|
|
|
71
71
|
### 配置沙箱
|
|
72
72
|
|
|
73
|
-
通过 `settings.json` 文件自定义沙箱行为。完整的配置参考请参阅[设置](settings.md#bash
|
|
73
|
+
通过 `settings.json` 文件自定义沙箱行为。完整的配置参考请参阅[设置](settings.md#bash沙箱设置)。
|
|
74
74
|
|
|
75
75
|
<Tip>
|
|
76
76
|
并非所有命令都能开箱即用地与沙箱兼容。以下一些注意事项可能帮助你充分利用沙箱:
|
|
@@ -83,7 +83,7 @@ CodeBuddy Code 具有原生沙箱功能,为智能体执行提供更安全的
|
|
|
83
83
|
<Note>
|
|
84
84
|
CodeBuddy Code 包含一个有意设置的逃生舱机制,允许在必要时在沙箱外运行命令。当命令因沙箱限制(如网络连接问题或不兼容的工具)而失败时,CodeBuddy 会被提示分析失败,并可能使用 `dangerouslyDisableSandbox` 参数重试命令。使用此参数的命令会经过正常的 CodeBuddy Code 权限流程,需要用户权限才能执行。这允许 CodeBuddy Code 处理某些工具或网络操作无法在沙箱约束内运行的边缘情况。
|
|
85
85
|
|
|
86
|
-
你可以通过在[沙箱设置](settings.md#bash
|
|
86
|
+
你可以通过在[沙箱设置](settings.md#bash沙箱设置)中设置 `"allowUnsandboxedCommands": false` 来禁用此逃生舱。禁用后,`dangerouslyDisableSandbox` 参数会被完全忽略,所有命令必须在沙箱中运行或明确列在 `excludedCommands` 中。
|
|
87
87
|
</Note>
|
|
88
88
|
|
|
89
89
|
## 沙箱自动批准
|
|
@@ -164,7 +164,7 @@ git push
|
|
|
164
164
|
* 无法修改关键配置文件,如 `~/.bashrc`
|
|
165
165
|
* 无法修改 `/bin/` 中的系统级文件
|
|
166
166
|
* 无法修改 CodeBuddy 配置文件(`settings.json`、`settings.local.json`),防止通过注入 hooks 实现沙箱逃逸
|
|
167
|
-
* 无法读取在 [CodeBuddy 权限设置](iam.md
|
|
167
|
+
* 无法读取在 [CodeBuddy 权限设置](iam.md#配置权限)中被拒绝的文件
|
|
168
168
|
|
|
169
169
|
**网络保护:**
|
|
170
170
|
|
|
@@ -252,7 +252,7 @@ git push
|
|
|
252
252
|
|
|
253
253
|
* **IAM 策略**:与[权限设置](iam.md)结合使用以实现深度防御
|
|
254
254
|
* **开发容器**:与 devcontainers 一起使用以实现额外隔离
|
|
255
|
-
* **企业策略**:通过[管理设置](settings.md
|
|
255
|
+
* **企业策略**:通过[管理设置](settings.md#设置优先级)强制执行沙箱配置
|
|
256
256
|
|
|
257
257
|
## 最佳实践
|
|
258
258
|
|
|
@@ -251,7 +251,7 @@ CodeBuddy 定位 Bug,实现修复,并更新分支或创建新的 MR。
|
|
|
251
251
|
- 验证 API 密钥是否有效且未过期
|
|
252
252
|
- 确认复制 API 密钥时没有包含额外的空格或换行符
|
|
253
253
|
- 检查 API 密钥的权限范围是否足够
|
|
254
|
-
- 查看 [设置配置文档](settings.md
|
|
254
|
+
- 查看 [设置配置文档](settings.md#认证配置) 了解详细配置方法
|
|
255
255
|
|
|
256
256
|
**API 连接失败:**
|
|
257
257
|
- 检查 `CODEBUDDY_BASE_URL` 是否配置正确(如使用自定义端点)
|
|
@@ -297,7 +297,7 @@ CodeBuddy Code 在 CI/CD 环境中使用以下环境变量:
|
|
|
297
297
|
- `AI_FLOW_CONTEXT`:上下文信息(如 Issue ID、MR ID 等)
|
|
298
298
|
- `AI_FLOW_EVENT`:触发事件类型(如 note、issue、merge_request)
|
|
299
299
|
|
|
300
|
-
> 📖 关于各环境变量的详细说明和配置示例,请参考 [设置配置文档](settings.md
|
|
300
|
+
> 📖 关于各环境变量的详细说明和配置示例,请参考 [设置配置文档](settings.md#环境变量)
|
|
301
301
|
|
|
302
302
|
**命令行参数:**
|
|
303
303
|
|
|
@@ -169,7 +169,7 @@ export CODEBUDDY_AUTH_TOKEN="eyJhbGciOiJSUzI1NiIs..."
|
|
|
169
169
|
vault read -field=api_key secret/codebuddy/api-key
|
|
170
170
|
```
|
|
171
171
|
|
|
172
|
-
详细的认证配置请参考[设置文档 - 环境变量](settings.md
|
|
172
|
+
详细的认证配置请参考[设置文档 - 环境变量](settings.md#环境变量)。
|
|
173
173
|
|
|
174
174
|
## 访问控制和权限
|
|
175
175
|
|
|
@@ -201,7 +201,7 @@ CodeBuddy Code 使用分层权限系统来平衡功能和安全性:
|
|
|
201
201
|
|
|
202
202
|
#### 权限模式
|
|
203
203
|
|
|
204
|
-
CodeBuddy Code 支持几种权限模式,可以在[设置文件](settings.md
|
|
204
|
+
CodeBuddy Code 支持几种权限模式,可以在[设置文件](settings.md#配置文件)中设置为 `defaultMode`:
|
|
205
205
|
|
|
206
206
|
| 模式 | 描述 |
|
|
207
207
|
|:----|:-----|
|
|
@@ -220,7 +220,7 @@ CodeBuddy Code 支持几种权限模式,可以在[设置文件](settings.md#
|
|
|
220
220
|
|
|
221
221
|
* **启动时**:使用 `--add-dir <path>` CLI 参数
|
|
222
222
|
* **会话期间**:使用 `/add-dir` 斜杠命令
|
|
223
|
-
* **持久配置**:添加到[设置文件](settings.md
|
|
223
|
+
* **持久配置**:添加到[设置文件](settings.md#配置文件)的 `additionalDirectories`
|
|
224
224
|
|
|
225
225
|
附加目录中的文件遵循与原始工作目录相同的权限规则 - 它们可以无提示读取,文件编辑权限遵循当前权限模式。
|
|
226
226
|
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# 🚀 CodeBuddy Code v2.68.0 发布
|
|
2
|
+
|
|
3
|
+
## ✨ 新功能
|
|
4
|
+
|
|
5
|
+
### Web UI 文档查看器
|
|
6
|
+
|
|
7
|
+
在 Web UI 中新增文档浏览功能,无需离开工作界面即可查阅 CLI 使用文档:
|
|
8
|
+
|
|
9
|
+
- 支持全文搜索,快速定位所需内容
|
|
10
|
+
- 中英文切换,满足不同语言偏好
|
|
11
|
+
- 目录导航和 TOC,方便浏览长文档
|
|
12
|
+
- API Reference 快捷链接,直接跳转到 Swagger UI
|
|
13
|
+
- 支持在新标签页中独立全屏打开
|
|
14
|
+
- 构建时自动打包 CLI 文档,支持离线查看
|
|
15
|
+
|
|
16
|
+
## 🔧 改进优化
|
|
17
|
+
|
|
18
|
+
- **HTTP API 标准化**:所有公开端点统一到 `/api/v1/` 前缀,支持版本控制;内部端点迁移到 `/internal/`,结构更清晰
|
|
19
|
+
- **API 文档**:新增 Swagger UI(`/api/docs`)和 OpenAPI 规范(`/api/openapi.json`),方便开发者探索和调试 API
|
|
20
|
+
- **统一响应格式**:公开端点采用标准 `{ data }` / `{ error: { code, message } }` 信封格式,提升 API 一致性
|
|
21
|
+
- **ACP 端点迁移**:ACP 协议端点从 `/acp` 迁移到 `/api/v1/acp`,与 REST API 统一路由前缀
|
|
22
|
+
- **凭证存储优化**:WeChat 和 WeCom 凭证统一为单文件 `instances.json` 格式,支持自动迁移旧格式
|
|
23
|
+
- **API 响应兼容**:Web UI 适配统一信封格式,确保 REST 端点响应正确解析
|
|
24
|
+
|
|
25
|
+
## 🐛 问题修复
|
|
26
|
+
|
|
27
|
+
- **确认框显示**:修复 AskUserQuestion 确认框偶发不显示的问题,解决路由导航中的竞态条件
|
|
28
|
+
- **文档链接格式**:修正 Channels 文档中 localhost 链接的格式
|
|
@@ -38,7 +38,7 @@ CodeBuddy Code 只拥有您授予它的权限。您有责任在批准之前审
|
|
|
38
38
|
* **权限系统**:敏感操作需要明确批准
|
|
39
39
|
* **上下文感知分析**:通过分析完整请求检测潜在有害指令
|
|
40
40
|
* **输入清理**:通过处理用户输入防止命令注入
|
|
41
|
-
* **命令阻止列表**:默认阻止从网络获取任意内容的风险命令,如 `curl` 和 `wget`。当明确允许时,请注意[权限模式限制](iam.md
|
|
41
|
+
* **命令阻止列表**:默认阻止从网络获取任意内容的风险命令,如 `curl` 和 `wget`。当明确允许时,请注意[权限模式限制](iam.md#工具特定的权限规则)
|
|
42
42
|
|
|
43
43
|
### 隐私保护
|
|
44
44
|
|
|
@@ -58,7 +58,7 @@ CodeBuddy Code 只拥有您授予它的权限。您有责任在批准之前审
|
|
|
58
58
|
* **命令注入检测**:可疑的 bash 命令即使之前已加入白名单也需要手动批准
|
|
59
59
|
* **失败关闭匹配**:不匹配的命令默认需要手动批准
|
|
60
60
|
* **自然语言描述**:复杂的 bash 命令包含解释以便用户理解
|
|
61
|
-
* **安全凭据存储**: API 密钥和令牌经过加密。参见[凭据管理](iam.md
|
|
61
|
+
* **安全凭据存储**: API 密钥和令牌经过加密。参见[凭据管理](iam.md#凭据管理)
|
|
62
62
|
|
|
63
63
|
<Warning>
|
|
64
64
|
**Windows WebDAV 安全风险**: 在 Windows 上运行 CodeBuddy Code 时,我们建议不要启用 WebDAV 或允许 CodeBuddy Code 访问可能包含 WebDAV 子目录的路径,如 `\\*`。[WebDAV 已被 Microsoft 弃用](https://learn.microsoft.com/en-us/windows/whats-new/deprecated-features#:~:text=The%20Webclient%20\(WebDAV\)%20service%20is%20deprecated)由于安全风险。启用 WebDAV 可能允许 CodeBuddy Code 触发对远程主机的网络请求,绕过权限系统。
|
|
@@ -85,8 +85,8 @@ CodeBuddy Code 使用分层配置系统,让您能够在不同级别进行个
|
|
|
85
85
|
| `allow` | [权限规则](iam.md#配置权限)数组,允许工具使用。**注意:** Bash 规则使用前缀匹配,不是正则表达式 | `[ "Bash(git diff:*)" ]` |
|
|
86
86
|
| `ask` | [权限规则](iam.md#配置权限)数组,在工具使用时询问确认 | `[ "Bash(git push:*)" ]` |
|
|
87
87
|
| `deny` | [权限规则](iam.md#配置权限)数组,拒绝工具使用。用于排除 CodeBuddy Code 访问敏感文件。**注意:** Bash 模式是前缀匹配,可以被绕过(参见 [Bash 权限限制](iam.md#工具特定的权限规则)) | `[ "WebFetch", "Bash(curl:*)", "Read(./.env)", "Read(./secrets/**)" ]` |
|
|
88
|
-
| `additionalDirectories` | CodeBuddy 可以访问的额外[工作目录](iam.md
|
|
89
|
-
| `defaultMode` | 打开 CodeBuddy Code 时的默认[权限模式](iam.md
|
|
88
|
+
| `additionalDirectories` | CodeBuddy 可以访问的额外[工作目录](iam.md#工作目录) | `[ "../docs/" ]` |
|
|
89
|
+
| `defaultMode` | 打开 CodeBuddy Code 时的默认[权限模式](iam.md#权限模式) | `"acceptEdits"` |
|
|
90
90
|
| `disableBypassPermissionsMode` | 设置为 `"disable"` 以防止激活 `bypassPermissions` 模式。这会禁用 `-y` 和 `--dangerously-skip-permissions` 命令行标志 | `"disable"` |
|
|
91
91
|
|
|
92
92
|
### 记忆功能配置(Experimental)
|
|
@@ -492,7 +492,7 @@ CodeBuddy Code 可以访问一组强大的工具,帮助它理解和修改您
|
|
|
492
492
|
| **NotebookEdit** | 修改 Jupyter notebook 单元格 | 是 |
|
|
493
493
|
| **Read** | 读取文件内容 | 否 |
|
|
494
494
|
| **Skill** | 在主对话中执行技能 | 是 |
|
|
495
|
-
| **SlashCommand** | 运行[自定义斜杠命令](slash-commands.md#slashcommand
|
|
495
|
+
| **SlashCommand** | 运行[自定义斜杠命令](slash-commands.md#slashcommand-工具) | 是 |
|
|
496
496
|
| **Task** | 运行子代理以处理复杂的多步骤任务 | 否 |
|
|
497
497
|
| **TaskOutput** | 从正在运行或已完成的后台任务检索输出 | 否 |
|
|
498
498
|
| **TaskCreate** | 创建任务以跟踪工作进度 | 否 |
|
|
@@ -503,7 +503,7 @@ CodeBuddy Code 可以访问一组强大的工具,帮助它理解和修改您
|
|
|
503
503
|
| **WebSearch** | 执行带域过滤的网络搜索 | 是 |
|
|
504
504
|
| **Write** | 创建或覆盖文件 | 是 |
|
|
505
505
|
|
|
506
|
-
权限规则可以使用 `/permissions` 或在[权限设置](
|
|
506
|
+
权限规则可以使用 `/permissions` 或在[权限设置](#权限设置)中配置。另见[工具特定的权限规则](iam.md#工具特定的权限规则)。
|
|
507
507
|
|
|
508
508
|
### 使用 hooks 扩展工具
|
|
509
509
|
|
|
@@ -593,7 +593,7 @@ CodeBuddy Code 可以访问一组强大的工具,帮助它理解和修改您
|
|
|
593
593
|
|
|
594
594
|
## 另见
|
|
595
595
|
|
|
596
|
-
* [身份和访问管理](iam.md
|
|
596
|
+
* [身份和访问管理](iam.md#配置权限) - 了解 CodeBuddy Code 的权限系统
|
|
597
597
|
* [Bash 沙箱](bash-sandboxing.md) - 了解沙箱隔离功能
|
|
598
598
|
* [故障排除](troubleshooting.md) - 常见配置问题的解决方案
|
|
599
599
|
|
|
@@ -153,73 +153,6 @@ Sandbox auto-approval improves efficiency while maintaining security:
|
|
|
153
153
|
3. **Review regularly**: Check logs to see which commands are being auto-approved
|
|
154
154
|
4. **Use in combination**: Use together with IAM permission rules for defense in depth
|
|
155
155
|
|
|
156
|
-
## Sandbox Auto-Approval
|
|
157
|
-
|
|
158
|
-
In AcceptEdits permission mode, CodeBuddy Code provides sandbox auto-approval functionality to further reduce permission prompts:
|
|
159
|
-
|
|
160
|
-
### How It Works
|
|
161
|
-
|
|
162
|
-
When sandbox auto-approval is enabled, Bash commands that meet all of the following conditions will be automatically approved for execution without user confirmation:
|
|
163
|
-
|
|
164
|
-
1. **Currently in AcceptEdits permission mode**
|
|
165
|
-
2. **Sandbox is enabled** (`sandbox.enabled = true`)
|
|
166
|
-
3. **Auto-approval configuration is on** (`sandbox.autoAllowBashIfSandboxed = true`)
|
|
167
|
-
4. **Command will run in sandbox** (not in `excludedCommands` list)
|
|
168
|
-
5. **Not using dangerouslyDisableSandbox parameter**
|
|
169
|
-
|
|
170
|
-
### Configuration Example
|
|
171
|
-
|
|
172
|
-
Enable sandbox auto-approval in `.codebuddy/settings.json`:
|
|
173
|
-
|
|
174
|
-
```json
|
|
175
|
-
{
|
|
176
|
-
"sandbox": {
|
|
177
|
-
"enabled": true,
|
|
178
|
-
"autoAllowBashIfSandboxed": true,
|
|
179
|
-
"excludedCommands": ["git", "docker"]
|
|
180
|
-
}
|
|
181
|
-
}
|
|
182
|
-
```
|
|
183
|
-
|
|
184
|
-
### Usage Scenarios
|
|
185
|
-
|
|
186
|
-
**Auto-approved** (no user confirmation needed):
|
|
187
|
-
```bash
|
|
188
|
-
# In AcceptEdits mode, these commands are auto-approved
|
|
189
|
-
npm test
|
|
190
|
-
npm run build
|
|
191
|
-
ls -la
|
|
192
|
-
grep "pattern" file.txt
|
|
193
|
-
```
|
|
194
|
-
|
|
195
|
-
**Requires approval** (the following situations still require user confirmation):
|
|
196
|
-
```bash
|
|
197
|
-
# 1. Excluded commands (in excludedCommands)
|
|
198
|
-
git push
|
|
199
|
-
|
|
200
|
-
# 2. Commands explicitly disabling sandbox
|
|
201
|
-
# (using dangerouslyDisableSandbox parameter)
|
|
202
|
-
|
|
203
|
-
# 3. All commands in non-AcceptEdits mode
|
|
204
|
-
```
|
|
205
|
-
|
|
206
|
-
### Security Guarantees
|
|
207
|
-
|
|
208
|
-
Sandbox auto-approval improves efficiency while maintaining security:
|
|
209
|
-
|
|
210
|
-
* ✅ **Only within sandbox environment**: Only sandboxed commands can be auto-approved
|
|
211
|
-
* ✅ **File system isolation**: Commands can only access allowed directories
|
|
212
|
-
* ✅ **Network isolation**: Commands can only access approved domains
|
|
213
|
-
* ✅ **Configurable boundaries**: Exclude high-risk commands via `excludedCommands`
|
|
214
|
-
* ✅ **Security first**: Any configuration errors or anomalies fall back to requiring user approval
|
|
215
|
-
|
|
216
|
-
### Best Practices
|
|
217
|
-
|
|
218
|
-
1. **Use cautiously**: Only enable auto-approval when you understand sandbox limitations
|
|
219
|
-
2. **Exclude high-risk commands**: Add dangerous operations like `git push`, `rm -rf` to `excludedCommands`
|
|
220
|
-
3. **Review regularly**: Check logs to see which commands are being auto-approved
|
|
221
|
-
4. **Use in combination**: Use together with IAM permission rules for defense in depth
|
|
222
|
-
|
|
223
156
|
## Security Benefits
|
|
224
157
|
|
|
225
158
|
### Protection Against Prompt Injection
|
|
@@ -175,9 +175,11 @@ Plan mode instructs CodeBuddy to create a plan by analyzing the codebase through
|
|
|
175
175
|
|
|
176
176
|
**Enable plan mode during a session**
|
|
177
177
|
|
|
178
|
-
You can toggle to plan mode during a session using
|
|
178
|
+
You can toggle to plan mode during a session using the shortcut key to toggle permission modes:
|
|
179
|
+
- **macOS/Linux**: Press **Shift+Tab**
|
|
180
|
+
- **Windows**: Press **Alt+M**
|
|
179
181
|
|
|
180
|
-
If you're in normal mode,
|
|
182
|
+
If you're in normal mode, pressing the shortcut will first toggle to auto-accept mode, showing `⏵⏵ accept edits on` at the bottom of the terminal. Pressing it again will toggle to plan mode, showing `⏸ plan mode on`.
|
|
181
183
|
|
|
182
184
|
**Start a new session in plan mode**
|
|
183
185
|
|
|
@@ -24,6 +24,8 @@ Suitable for enterprise/team integration, obtaining tokens via OAuth 2.0.
|
|
|
24
24
|
|
|
25
25
|
> Currently only introducing the Client Credentials authorization method, suitable for server-side applications and CI/CD scenarios.
|
|
26
26
|
|
|
27
|
+
> **Prerequisite**: Enterprise users need to purchase CodeBuddy Premium before using OAuth authentication. See the [CodeBuddy Premium Purchase Guide](https://cloud.tencent.com/document/product/1749/110012) for details.
|
|
28
|
+
|
|
27
29
|
**Step 1: Create Application, Get Client ID and Secret**
|
|
28
30
|
|
|
29
31
|
Refer to the [Enterprise Developer Quick Start](https://copilot.tencent.com/apiDocs/open-platform.html) to complete:
|
|
@@ -69,6 +71,8 @@ After configuration, you can use the `codebuddy` command.
|
|
|
69
71
|
|
|
70
72
|
Suitable for using third-party model services like OpenRouter.
|
|
71
73
|
|
|
74
|
+
> **Note:** When using third-party model services, there is no need to set the `CODEBUDDY_INTERNET_ENVIRONMENT` environment variable, as requests are sent directly to the third-party service endpoint.
|
|
75
|
+
|
|
72
76
|
```bash
|
|
73
77
|
export CODEBUDDY_API_KEY="sk-or-v1-xxx"
|
|
74
78
|
export CODEBUDDY_BASE_URL="https://openrouter.ai/api/v1"
|
|
@@ -17,6 +17,7 @@ Difference from [CHANGELOG.md](../../CHANGELOG.md):
|
|
|
17
17
|
|
|
18
18
|
<!-- New versions are automatically added here -->
|
|
19
19
|
|
|
20
|
+
- [v2.68.0](./v2.68.0.md) - 2026-03-30
|
|
20
21
|
- [v2.67.0](./v2.67.0.md) - 2026-03-28
|
|
21
22
|
- [v2.66.2](./v2.66.2.md) - 2026-03-26
|
|
22
23
|
- [v2.66.1](./v2.66.1.md) - 2026-03-26
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# 🚀 CodeBuddy Code v2.68.0 Release
|
|
2
|
+
|
|
3
|
+
## ✨ New Features
|
|
4
|
+
|
|
5
|
+
### Web UI Documentation Viewer
|
|
6
|
+
|
|
7
|
+
Added a documentation browsing feature in the Web UI, allowing you to access CLI documentation without leaving your workspace:
|
|
8
|
+
|
|
9
|
+
- Full-text search for quickly locating the content you need
|
|
10
|
+
- Language switching between Chinese and English to suit different preferences
|
|
11
|
+
- Table of contents navigation and TOC for easy browsing of long documents
|
|
12
|
+
- API Reference quick links for direct access to Swagger UI
|
|
13
|
+
- Support for opening in a new tab as a standalone full-screen view
|
|
14
|
+
- CLI documentation is automatically bundled at build time, supporting offline viewing
|
|
15
|
+
|
|
16
|
+
## 🔧 Improvements
|
|
17
|
+
|
|
18
|
+
- **HTTP API Standardization**: All public endpoints unified under the `/api/v1/` prefix with version control support; internal endpoints migrated to `/internal/` for a clearer structure
|
|
19
|
+
- **API Documentation**: Added Swagger UI (`/api/docs`) and OpenAPI specification (`/api/openapi.json`) for developers to explore and debug APIs
|
|
20
|
+
- **Unified Response Format**: Public endpoints adopt the standard `{ data }` / `{ error: { code, message } }` envelope format, improving API consistency
|
|
21
|
+
- **ACP Endpoint Migration**: ACP protocol endpoints migrated from `/acp` to `/api/v1/acp`, unifying the routing prefix with REST APIs
|
|
22
|
+
- **Credential Storage Optimization**: WeChat and WeCom credentials consolidated into a single `instances.json` file format, with automatic migration from legacy formats
|
|
23
|
+
- **API Response Compatibility**: Web UI adapted to the unified envelope format, ensuring correct parsing of REST endpoint responses
|
|
24
|
+
|
|
25
|
+
## 🐛 Bug Fixes
|
|
26
|
+
|
|
27
|
+
- **Confirmation Dialog Display**: Fixed an issue where the AskUserQuestion confirmation dialog occasionally failed to appear, resolving a race condition in route navigation
|
|
28
|
+
- **Documentation Link Format**: Corrected the format of localhost links in the Channels documentation
|
|
@@ -4,20 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
This document provides a complete API reference for the Python SDK. For quick start and usage examples, please refer to [SDK Overview](sdk.md).
|
|
6
6
|
|
|
7
|
-
## Table of Contents
|
|
8
|
-
|
|
9
|
-
- [Requirements](#requirements)
|
|
10
|
-
- [Installation](#installation)
|
|
11
|
-
- [Functions](#functions)
|
|
12
|
-
- [Client Class](#client-class)
|
|
13
|
-
- [Authentication](#authentication)
|
|
14
|
-
- [Unstable API](#unstable-api)
|
|
15
|
-
- [Types](#types)
|
|
16
|
-
- [Message Types](#message-types)
|
|
17
|
-
- [Input Types](#input-types)
|
|
18
|
-
- [Errors](#errors)
|
|
19
|
-
- [Auth Types](#auth-types)
|
|
20
|
-
|
|
21
7
|
## Requirements
|
|
22
8
|
|
|
23
9
|
| Dependency | Version Requirement |
|
|
@@ -4,17 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
This document provides a complete API reference for the TypeScript SDK. For quick start and usage examples, please refer to [SDK Overview](sdk.md).
|
|
6
6
|
|
|
7
|
-
## Table of Contents
|
|
8
|
-
|
|
9
|
-
- [Requirements](#requirements)
|
|
10
|
-
- [Installation](#installation)
|
|
11
|
-
- [Functions](#functions)
|
|
12
|
-
- [Unstable V2 API](#unstable-v2-api)
|
|
13
|
-
- [Types](#types)
|
|
14
|
-
- [Message Types](#message-types)
|
|
15
|
-
- [Input Types](#input-types)
|
|
16
|
-
- [Related Documentation](#related-documentation)
|
|
17
|
-
|
|
18
7
|
## Requirements
|
|
19
8
|
|
|
20
9
|
| Dependency | Version Requirement |
|
|
@@ -46,7 +46,6 @@ We implement multiple protections to safeguard your data, including:
|
|
|
46
46
|
|
|
47
47
|
* Limited retention periods for sensitive information
|
|
48
48
|
* Restricted access to user session data
|
|
49
|
-
* User-controlled data training preferences
|
|
50
49
|
|
|
51
50
|
For full details, please review our [Terms of Service](https://cloud.tencent.com/document/product/301/106125) and [Privacy Policy](https://privacy.qq.com/document/preview/284d799a07164d09bfc7cedd0ec3e089).
|
|
52
51
|
|