dsh-llm-codebuddy 1.3.5 → 1.3.6

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/README.md CHANGED
@@ -1,137 +1,141 @@
1
1
  # DSH CodeBuddy Provider
2
2
 
3
- 为 DeepSeek Harness(DSH)增加 `CodeBuddy 中国区` Provider。支持 WorkBuddy
4
- API Key CodeBuddy 中国站账号令牌两种认证方式,并可在 DSH WebUI 中获取、
5
- 选择和调整模型。
3
+ 为 DeepSeek Harness(DSH)增加 `CodeBuddy 中国区` Provider。插件通过
4
+ WorkBuddy 提供的 API Key,或 CodeBuddy 中国站的网页登录令牌调用模型,并在
5
+ DSH WebUI 中管理模型和认证方式。
6
6
 
7
7
  > [!IMPORTANT]
8
- > API Key **WorkBuddy** 提供,本插件使用该 Key 调用供 CodeBuddy 使用的模型服务。
9
- > DSH 中的 Provider 名称仍为 `CodeBuddy 中国区`。本项目是第三方适配器,并非
10
- > WorkBuddy、CodeBuddy 或 DSH 官方插件。
8
+ > API Key 来自 **WorkBuddy**,用于调用供 CodeBuddy 使用的模型服务。本插件是第三方
9
+ > 适配器,不属于 WorkBuddy、CodeBuddy DSH 官方项目。
11
10
 
12
11
  ## 功能
13
12
 
14
- - WebUI 中直接添加 `CodeBuddy 中国区`;
15
- - 支持从 WorkBuddy 获取的 API Key
16
- - API Key 输入框旁可显式切换 `API Key` / `令牌登录`;
17
- - 支持从 WebUI 拉起浏览器登录 CodeBuddy 中国站,并自动复用、刷新登录令牌;
18
- - 自动获取 CodeBuddy 当前可用模型;
19
- - 支持编辑模型 ID、名称、上下文窗口和最大输出 Token;
20
- - 支持添加、删除模型以及重新同步模型目录;
21
- - 按模型目录声明各模型自己的思考能力、可选档位和默认档位;
22
- - 输入新 API Key 可替换旧值,留空保存则保留原值;
23
- - 模型接口暂时不可用时使用内置目录兜底;
24
- - 独立安装,不修改 DSH 全局安装目录。
13
+ - 在 DSH WebUI 中使用 `CodeBuddy 中国区`;
14
+ - 支持 WorkBuddy API Key 和 CodeBuddy 中国站账号令牌;
15
+ - 两种认证模式互相独立,可以随时切换;
16
+ - API Key 支持环境变量、多个 DSH 保存值,并可通过下拉列表切换;
17
+ - 令牌支持浏览器登录、多个账号持久化、账号名称展示和下拉切换;
18
+ - 令牌模式显示剩余积分、今日请求次数和今日积分用量;
19
+ - 自动从 CodeBuddy 获取当前账号可用模型;
20
+ - 支持编辑模型 ID、名称、上下文窗口、最大输出 Token 和模型思考档位;
21
+ - 支持添加、删除模型以及恢复在线模型目录;
22
+ - 不依赖本机 CodeBuddy CLI。
25
23
 
26
24
  ## 环境要求
27
25
 
28
- - Windows、Linux 或 macOS
26
+ - 已安装 DSH
29
27
  - Node.js `>= 22.19.0`;
30
- - 已安装 DSH;
31
- - 已验证 DSH `0.1.0-rc.6`。
32
-
33
- 安装器已自带 DSH 所需的 `pnpm`,无需全局安装;令牌登录也不需要安装 CodeBuddy CLI。
34
-
35
- > DSH 仍处于预发布阶段。未来版本如果调整插件接口,本插件可能需要同步升级;
36
- > DSH 普通更新不会覆盖本插件。
28
+ - Windows、Linux 或 macOS。
37
29
 
38
30
  ## 安装
39
31
 
40
- 推荐使用一键安装命令:
32
+ 在 PowerShell 或终端执行:
41
33
 
42
34
  ```powershell
43
35
  npx --yes dsh-llm-codebuddy@latest install
44
36
  ```
45
37
 
46
- 该命令会为 DSH 的 `web` 和 `headless` Profile 安装插件。完成后重启 DSH。
47
-
48
- 也可以分别安装:
38
+ 安装器会为 DSH 的 `web` 和 `headless` Profile 安装插件。安装完成后重启 DSH。
39
+ 只使用 WebUI 时,也可以单独安装 Web Profile:
49
40
 
50
41
  ```powershell
51
42
  dsh plugin --profile web add dsh-llm-codebuddy@latest
52
- dsh plugin --profile headless add dsh-llm-codebuddy@latest
53
43
  ```
54
44
 
55
- 只使用 WebUI 时,仅执行第一条即可。
45
+ ## WebUI 配置
56
46
 
57
- ## WebUI 配置
58
-
59
- ### CodeBuddy 账号令牌登录(新用户推荐)
60
-
61
- 1. 打开“设置 → 模型”。
62
- 2. 添加或编辑 `CodeBuddy 中国区`。
63
- 3. 点击 API Key 输入框右侧的“令牌登录”。
64
- 4. 在自动打开的浏览器中完成 CodeBuddy 中国站登录。
65
- 5. WebUI 显示“令牌已登录”后即可获取模型并保存自定义目录。
66
-
67
- 如果 WebUI 无法打开浏览器,也可以使用命令行入口:
68
-
69
- ```powershell
70
- npx --yes dsh-llm-codebuddy@latest login
71
- ```
72
-
73
- 插件会调用 CodeBuddy 官方认证流程。完成登录后,插件会自动把
74
- `CodeBuddy 中国区` Provider 切换为令牌模式,无需 API Key。点击同一行的
75
- “API Key”可以切回 API Key 模式;已经保存的 API Key 不会被删除。
76
- 两种凭据彼此独立保留,之后再次点击“令牌登录”会优先复用已保存令牌;仅在没有
77
- 令牌或主动重新登录时才需要再次打开浏览器。
78
-
79
- 插件直接调用 CodeBuddy 中国站官方网页登录和令牌刷新接口,不依赖本机
80
- `codebuddy` 命令。访问令牌和刷新令牌保存在 DSH 凭据服务中,不会写入
81
- `settings.yaml` 或模型目录。
82
-
83
- ### WorkBuddy API Key
84
-
85
- 1. 打开“设置 → 模型”。
86
- 2. 点击“添加提供方”。
87
- 3. 选择 `CodeBuddy 中国区`。
88
- 4. 输入从 WorkBuddy 获取的 API Key 并保存。
89
- 5. 点击该 Provider 的“编辑”,展开“自定义设置”。
90
- 6. 点击“获取可用模型”,选择需要的模型并导入。
91
- 7. 按需修改模型参数,然后保存。
47
+ 打开 **设置 → 模型**,添加或编辑 `CodeBuddy 中国区`。认证区域有两个模式按钮:
48
+
49
+ - `API Key`:只显示 API Key 来源和新增 Key 功能;
50
+ - `令牌登录`:只显示令牌账号、登录、切换以及账号用量信息。
51
+
52
+ 切换模式后,另一种模式的账号或 Key 控件会隐藏,不会同时占用页面空间。
92
53
 
93
- 再次编辑已配置的 Provider 时,会直接显示上次保存的模型目录。
54
+ ### 方式一:WorkBuddy API Key
94
55
 
95
- ## API Key 替换
56
+ #### 使用环境变量中的 Key
96
57
 
97
- - 输入新的 API Key 并保存:替换原 Key;
98
- - API Key 输入框留空并保存:保留原 Key;
99
- - 更换 Key 后建议重新点击“获取可用模型”,同步新账号的模型权限。
58
+ 插件会自动检测:
100
59
 
101
- API Key 由 DSH 凭据服务保存,不会写入模型目录或插件源码。
60
+ ```text
61
+ CODEBUDDY_API_KEY
62
+ ```
63
+
64
+ 如果这个环境变量存在,API Key 来源下拉列表会显示“环境变量 CODEBUDDY_API_KEY”。
65
+ 选择它即可使用;密钥值不会显示在页面中,也不会写入 `settings.yaml`。
66
+
67
+ #### 在 DSH 中保存新的 Key
68
+
69
+ 1. 选择 `API Key` 模式;
70
+ 2. 在“新增 API Key”输入框粘贴 WorkBuddy Key;
71
+ 3. 可填写一个名称,例如“工作账号”或“测试账号”;
72
+ 4. 点击“添加并使用”;
73
+ 5. 新 Key 会出现在“当前 API Key”下拉列表中,并立即切换为当前 Key。
74
+
75
+ DSH 保存的 Key 存放在 DSH 凭据服务中。可以保存多个 Key 并随时切换;环境变量 Key
76
+ 和 DSH 保存的 Key 互不覆盖。删除操作只允许删除 DSH 保存的 Key,不会删除环境变量。
77
+
78
+ ### 方式二:CodeBuddy 账号令牌
102
79
 
103
- ## 模型配置
80
+ 1. 选择 `令牌登录` 模式;
81
+ 2. 点击“登录 CodeBuddy”,插件会打开 CodeBuddy 中国站;
82
+ 3. 在浏览器完成账号登录;
83
+ 4. 返回 DSH 后,账号会保存到本地凭据并自动启用。
104
84
 
105
- - 没有自定义目录:使用 CodeBuddy 在线目录,失败时使用内置目录;
106
- - 保存自定义目录:仅向 DSH 提供目录中保留的模型;
107
- - 已知模型字段留空:继承在线目录或内置目录中的值;
108
- - 新模型缺少容量:上下文窗口默认 `262144`,最大输出默认 `32768`;
109
- - 点击“恢复默认模型”:删除自定义目录并恢复适配器目录。
85
+ 再次打开页面时,可以在“令牌账号”下拉列表中切换账号。点击“添加账号”可以登录
86
+ 另一个账号,点击“删除账号”会移除当前账号的本地令牌。令牌登录不需要安装
87
+ `codebuddy` 命令行工具。
110
88
 
111
- 配置值超过服务端真实限制时,CodeBuddy 仍可能拒绝请求。
89
+ 令牌模式下,插件会尝试显示:
90
+
91
+ - 剩余积分或企业账号的“不限量”;
92
+ - 今日请求次数;
93
+ - 今日请求消耗的积分。
94
+
95
+ 积分接口属于 CodeBuddy 中国站的账号服务,仅令牌模式使用;API Key 模式不会调用该
96
+ 接口。如果服务暂时不可用,页面会保留账号登录状态并显示“暂不可用”。
97
+
98
+ ## 获取和编辑模型
99
+
100
+ 1. 在 `CodeBuddy 中国区` 的自定义设置中点击“获取可用模型”;
101
+ 2. 插件会使用当前选中的 API Key 或令牌请求 CodeBuddy 模型目录;
102
+ 3. 选择要使用的模型并保存;
103
+ 4. 再次编辑时,可以直接修改模型 ID、显示名称、上下文窗口和最大输出 Token。
104
+
105
+ 模型目录按当前账号权限返回。更换 API Key 或令牌账号后,建议重新点击“获取可用模型”。
106
+ 如果在线目录暂时失败,插件会使用内置目录作为兜底。
112
107
 
113
108
  ## 思考程度
114
109
 
115
- DSH 显示的思考程度来自当前模型自身的能力声明,插件把选中的档位转换为
116
- `reasoning_effort` 并发送给 CodeBuddy。模型推理由 CodeBuddy 云端执行。
110
+ 思考档位按模型分别决定,插件不会给所有模型强行使用同一套选项。在线模型目录会声明
111
+ 每个模型是否支持思考、支持哪些档位以及默认档位,WebUI 会据此显示可用选项。
112
+
113
+ 常见档位包括:
117
114
 
118
115
  ```text
119
116
  off / minimal / low / medium / high / xhigh / max
120
117
  ```
121
118
 
122
- 实际显示哪些档位由 `/v3/config` 中该模型的 `supportsReasoning`、`onlyReasoning`、
123
- `thinkingLevelMap` 和 `reasoning.effort` 决定,不能跨模型共用一套固定档位。未手动
124
- 选择时,使用 CodeBuddy 为该模型返回的默认档位;服务端没有声明时则不强行指定。
119
+ 实际选项可能因模型不同而不同。未手动指定时,使用 CodeBuddy 返回的默认档位;服务端
120
+ 没有声明思考能力时,插件不会额外发送思考参数。
121
+
122
+ ## 认证和请求说明
123
+
124
+ - API Key 请求使用 WorkBuddy/CodeBuddy 的 OpenAI-compatible 接口;
125
+ - 令牌请求使用 CodeBuddy 中国站的登录令牌,并在过期前自动刷新;
126
+ - DSH 负责 Agent 循环、上下文、工具调用和权限;
127
+ - CodeBuddy 负责模型推理并返回结果;
128
+ - 访问令牌、刷新令牌和 DSH 保存的 API Key 不会写入模型目录或 `settings.yaml`。
125
129
 
126
130
  ## 更新
127
131
 
128
- 重新运行安装命令即可更新到最新版:
132
+ 重新执行安装命令即可更新:
129
133
 
130
134
  ```powershell
131
135
  npx --yes dsh-llm-codebuddy@latest install
132
136
  ```
133
137
 
134
- 更新完成后重启 DSH。模型配置和 API Key 不会被覆盖。
138
+ 更新后重启 DSH。已有的模型配置、API Key 和登录令牌会保留。
135
139
 
136
140
  ## 卸载
137
141
 
@@ -139,82 +143,48 @@ npx --yes dsh-llm-codebuddy@latest install
139
143
  npx --yes dsh-llm-codebuddy@latest uninstall
140
144
  ```
141
145
 
142
- 卸载命令会:
143
-
144
- 1. 备份 `~/.dsh/settings.yaml`;
145
- 2. 只删除 `llm-pi-ai.providers.codebuddy-cn` 配置;
146
- 3. 保留其他 Provider 和 DSH 设置;
147
- 4. 从 `web`、`headless` Profile 移除插件;
148
- 5. 保留 API Key 和登录令牌凭据,方便以后重新安装。
149
-
150
- 完成后重启 DSH。备份文件名类似:
151
-
152
- ```text
153
- settings.yaml.codebuddy-backup-2026-08-14T12-00-00-000Z
154
- ```
155
-
156
- 源码仓库、本地安装包和 API Key 不会被删除。
146
+ 卸载会移除 `CodeBuddy 中国区` 的 Provider 和插件包,并备份 DSH 设置文件。为方便以后
147
+ 重新安装,API Key 和登录令牌默认保留在 DSH 凭据服务中。
157
148
 
158
149
  ## 常见问题
159
150
 
160
- ### 安装后看不到 CodeBuddy
151
+ ### 看不到 CodeBuddy Provider
161
152
 
162
- 确认已经重启 DSH,并检查 Web Profile:
153
+ 重启 DSH 后重新打开 **设置 → 模型**。也可以检查:
163
154
 
164
155
  ```powershell
165
156
  dsh plugin --profile web list --depth 0
166
157
  ```
167
158
 
159
+ ### API Key 下拉列表只有环境变量
160
+
161
+ 不要使用 DSH 原生的旧密钥输入框提交。选择 `API Key` 模式,在插件自己的“新增 API Key”
162
+ 区域粘贴 Key 并点击“添加并使用”。成功后新 Key 会出现在“当前 API Key”下拉列表。
163
+
168
164
  ### 获取模型失败
169
165
 
170
- 确认 API Key 来自 WorkBuddy 且仍然有效,然后重新输入 Key 并点击“获取可用模型”。
171
- 接口临时不可用时,插件仍会提供内置模型目录。
166
+ 确认当前选中的 Key 来自 WorkBuddy 且仍然有效,或确认令牌账号登录状态正常。更换认证
167
+ 凭据后重新获取模型目录。
172
168
 
173
- ### 为什么别人能看到某个模型,我这里看不到
169
+ ### 令牌登录后没有积分
174
170
 
175
- 模型权限与 API Key 绑定。插件只导入 `/v3/config` 中 `agents[name=cli].models` 为
176
- 当前 Key 返回的模型;更换 Key 后请重新点击“获取可用模型”。插件不会强行显示
177
- 当前 Key 未授权的模型。
178
-
179
- ### 调用时报 `500 status code (no body)`
180
-
181
- 先更新到最新版并重启 DSH:
182
-
183
- ```powershell
184
- npx --yes dsh-llm-codebuddy@latest install
185
- ```
186
-
187
- 旧版本可能被 DSH 覆盖 CodeBuddy 请求标识,导致服务端拒绝请求;最新版已在插件请求层
188
- 恢复 CodeBuddy 官方标识,同时适用于 API Key 和令牌模式。
189
-
190
- ### 卸载后仍显示旧页面
191
-
192
- 关闭正在运行的 DSH,再重新启动。已经运行的进程不会自动卸载内存中的插件。
193
-
194
- ## 开发文档
195
-
196
- 需要开发其他 Agent 或 Provider 时,请阅读
197
- [反向代理调用 WorkBuddy API 开发文档](./docs/反向代理调用WorkBuddy-API开发文档.md)。
171
+ 积分查询只支持令牌模式,并依赖 CodeBuddy 中国站 billing 接口。网络、账号类型或接口
172
+ 暂时不可用时,页面会显示“暂不可用”,不影响模型调用。
198
173
 
199
- ## 工作原理
174
+ ### 调用时报 `500 status code (no body)`
200
175
 
201
- ```text
202
- WorkBuddy 提供 API Key
203
-
204
- DSH Agent 本插件 → CodeBuddy /v2/chat/completions
205
- ↘ CodeBuddy /v3/config(获取模型)
206
-
207
- CodeBuddy 中国站网页登录 → 本插件保存并刷新 DSH 登录凭据
208
- ↓ 当前 access token
209
- DSH Agent → 本插件 → CodeBuddy API(Authorization: Bearer)
176
+ 先更新插件并重启 DSH:
177
+
178
+ ```powershell
179
+ npx --yes dsh-llm-codebuddy@latest install
210
180
  ```
211
181
 
212
- - DSH:负责 Agent 循环、上下文、工具调用和权限;
213
- - WorkBuddy:提供 API Key;
214
- - 插件:负责 Provider 注册、模型目录转换和请求兼容;
215
- - CodeBuddy:负责模型推理并返回结果。
216
- <img width="1885" height="853" alt="image" src="https://github.com/user-attachments/assets/eda31b48-8412-414d-b552-1b7ce0a7c3a0" />
182
+ 最新版会恢复 CodeBuddy 官方请求标识,兼容 API Key 和令牌模式。
183
+
184
+ ### 修改后页面仍显示旧布局
217
185
 
218
- ## License
186
+ 浏览器执行 `Ctrl+F5` 强制刷新;如果 DSH 进程已经运行较久,再关闭并重新启动 DSH。
187
+
188
+ ## License
219
189
 
220
190
  [MIT](./LICENSE)
package/cli.js CHANGED
@@ -6,7 +6,17 @@ import { createRequire } from "node:module";
6
6
  import { delimiter, dirname, join, resolve } from "node:path";
7
7
  import { spawnSync } from "node:child_process";
8
8
  import { parseDocument } from "yaml";
9
- import { CODEBUDDY_SESSION_REF, loginCodeBuddy, parseCodeBuddySession, serializeCodeBuddySession } from "./codebuddy-auth.js";
9
+ import {
10
+ CODEBUDDY_SESSION_REF,
11
+ CODEBUDDY_SESSIONS_REF,
12
+ createCodeBuddySessionStore,
13
+ loginCodeBuddy,
14
+ parseCodeBuddySession,
15
+ parseCodeBuddySessions,
16
+ serializeCodeBuddySession,
17
+ serializeCodeBuddySessions,
18
+ upsertCodeBuddySession,
19
+ } from "./codebuddy-auth.js";
10
20
 
11
21
  const PACKAGE = "dsh-llm-codebuddy";
12
22
  const PACKAGE_VERSION = JSON.parse(readFileSync(new URL("./package.json", import.meta.url), "utf8")).version;
@@ -129,7 +139,11 @@ function storeLoginSession(session, home = dshHome()) {
129
139
  const file = join(home, ".credentials.yaml");
130
140
  const document = parseDocument(existsSync(file) ? readFileSync(file, "utf8") : "{}\n");
131
141
  if (document.errors.length) throw new Error(`无法解析 ${file}:${document.errors[0].message}`);
132
- document.set(CODEBUDDY_SESSION_REF, serializeCodeBuddySession(session));
142
+ const stored = document.get(CODEBUDDY_SESSIONS_REF) ?? document.get(CODEBUDDY_SESSION_REF);
143
+ const current = stored ? parseCodeBuddySessions(stored) : createCodeBuddySessionStore();
144
+ const next = upsertCodeBuddySession(current, session);
145
+ document.set(CODEBUDDY_SESSIONS_REF, serializeCodeBuddySessions(next));
146
+ document.set(CODEBUDDY_SESSION_REF, serializeCodeBuddySession(next.sessions.find((entry) => entry.id === next.activeId)));
133
147
  if (existsSync(file)) {
134
148
  const stamp = new Date().toISOString().replace(/[:.]/g, "-");
135
149
  copyFileSync(file, `${file}.codebuddy-backup-${stamp}`);
@@ -198,6 +212,11 @@ function selfTest() {
198
212
  if (parseCodeBuddySession(storedSession).account.userId !== "test-user") {
199
213
  throw new Error("token credential storage self-test failed");
200
214
  }
215
+ const storedSessions = parseDocument(readFileSync(join(root, ".credentials.yaml"), "utf8")).get(CODEBUDDY_SESSIONS_REF);
216
+ const sessionStore = parseCodeBuddySessions(storedSessions);
217
+ if (sessionStore.sessions.length !== 1 || sessionStore.activeId !== sessionStore.sessions[0].id) {
218
+ throw new Error("token account list self-test failed");
219
+ }
201
220
  const workspace = join(root, "pnpm-workspace.yaml");
202
221
  writeFileSync(workspace, "packages:\n - .\nallowBuilds:\n '@google/genai': true\n protobufjs: pending\n", "utf8");
203
222
  withPnpmBuildPolicy(workspace, () => {