dsh-llm-codebuddy 1.2.1 → 1.3.1

package/README.md

@@ -1,8 +1,7 @@
 # DSH CodeBuddy Provider
 
-为 DeepSeek Harness（DSH）增加
-`CodeBuddy 中国区` Provider。安装后可直接在 DSH WebUI 中填写 API Key、获取模型、
-调整模型参数并使用 CodeBuddy 模型。
+为 DeepSeek Harness（DSH）增加 `CodeBuddy 中国区` Provider。安装后可直接在
+DSH WebUI 中填写 API Key、获取模型、调整模型参数并使用 CodeBuddy 模型。
 
 > [!IMPORTANT]
 > API Key 由 **WorkBuddy** 提供，本插件使用该 Key 调用供 CodeBuddy 使用的模型服务。
@@ -11,62 +10,44 @@
 
 ## 功能
 
-- 在“设置 → 模型 → 添加提供方”中显示 `CodeBuddy 中国区`；
-- WebUI 只需要填写从 WorkBuddy 获取的 API Key，无需配置 API 地址和协议；
-- 从 CodeBuddy `/v3/config` 获取当前 `cli` Agent 可用模型；
-- 支持编辑模型 ID、显示名称、上下文窗口和最大输出 Token；
+- WebUI 中直接添加 `CodeBuddy 中国区`；
+- 只需填写从 WorkBuddy 获取的 API Key；
+- 自动获取 CodeBuddy 当前可用模型；
+- 支持编辑模型 ID、名称、上下文窗口和最大输出 Token；
 - 支持添加、删除模型以及重新同步模型目录；
 - 支持 `minimal / low / medium / high / xhigh / max` 思考程度；
-- 未选择思考程度时，使用 CodeBuddy 对应模型的默认值；
-- API Key 输入新值后保存即可替换，留空保存会保留原值；
-- 模型接口暂时不可用时，使用插件内置目录兜底；
-- 插件独立安装，不修改 DSH 全局安装目录。
+- 输入新 API Key 可替换旧值，留空保存则保留原值；
+- 模型接口暂时不可用时使用内置目录兜底；
+- 独立安装，不修改 DSH 全局安装目录。
 
-## 兼容性
+## 环境要求
 
-- Windows、Linux、macOS；
+- Windows、Linux 或 macOS；
 - Node.js `>= 22.19.0`；
-- 已验证 DSH `0.1.0-rc.6`；
-- 当前版本使用 DSH `llm-pi-ai` 的设置界面，并保留该适配器原有 Provider。
+- 已安装 DSH；
+- 已验证 DSH `0.1.0-rc.6`。
 
-> DSH 仍处于预发布阶段。如果未来版本调整插件接口，本插件可能需要同步升级，
-> 但 DSH 普通更新不会覆盖插件源码。
+> DSH 仍处于预发布阶段。未来版本如果调整插件接口，本插件可能需要同步升级；
+> DSH 普通更新不会覆盖本插件。
 
 ## 安装
 
-### 从 npm 安装
-
-发布到 npm 后执行：
+推荐使用一键安装命令：
 
 ```powershell
-dsh plugin --profile web add dsh-llm-codebuddy
-dsh plugin --profile headless add dsh-llm-codebuddy
+npx --yes dsh-llm-codebuddy@latest install
 ```
 
-只使用 WebUI 时，第一条命令即可。
-
-### 从 GitHub 安装
-
-```powershell
-dsh plugin --profile web add github:Axiaohungry/dsh-llm-codebuddy
-dsh plugin --profile headless add github:Axiaohungry/dsh-llm-codebuddy
-```
+该命令会为 DSH 的 `web` 和 `headless` Profile 安装插件。完成后重启 DSH。
 
-也可以安装指定版本：
+也可以分别安装：
 
 ```powershell
-dsh plugin --profile web add github:Axiaohungry/dsh-llm-codebuddy#v1.2.1
-```
-
-### 从源码安装
-
-```powershell
-git clone https://github.com/Axiaohungry/dsh-llm-codebuddy.git
-cd dsh-llm-codebuddy
-.\install.ps1
+dsh plugin --profile web add dsh-llm-codebuddy@latest
+dsh plugin --profile headless add dsh-llm-codebuddy@latest
 ```
 
-安装或升级后请重启 DSH。
+只使用 WebUI 时，仅执行第一条即可。
 
 ## WebUI 配置
 
@@ -75,110 +56,91 @@ cd dsh-llm-codebuddy
 3. 选择 `CodeBuddy 中国区`。
 4. 输入从 WorkBuddy 获取的 API Key 并保存。
 5. 点击该 Provider 的“编辑”，展开“自定义设置”。
-6. 点击“获取可用模型”，选择模型并导入。
+6. 点击“获取可用模型”，选择需要的模型并导入。
 7. 按需修改模型参数，然后保存。
 
-已保存的 Provider 再次进入“编辑”时，会直接显示之前保存的模型目录。
+再次编辑已配置的 Provider 时，会直接显示上次保存的模型目录。
 
-## 模型配置规则
+## API Key 替换
 
-- 没有自定义模型目录：使用 CodeBuddy 在线目录，失败时使用内置目录；
-- 保存了自定义目录：只向 DSH 提供目录中保留的模型；
-- 已知模型字段留空：继承 CodeBuddy 在线目录或内置目录中的值；
-- 新模型缺少容量时：上下文窗口默认为 `262144`，最大输出默认为 `32768`；
-- 点击“恢复默认模型”：删除自定义目录，恢复适配器目录。
+- 输入新的 API Key 并保存：替换原 Key；
+- API Key 输入框留空并保存：保留原 Key；
+- 更换 Key 后建议重新点击“获取可用模型”，同步新账号的模型权限。
 
-上下文窗口和最大输出 Token 应根据 CodeBuddy 实际限制填写。配置值超过服务端限制时，
-CodeBuddy 仍可能拒绝请求。
+API Key 由 DSH 凭据服务保存，不会写入模型目录或插件源码。
 
-## 思考程度
+## 模型配置
 
-DSH 负责显示思考程度选项，插件将选中的档位转换为
-`reasoning_effort` 并发送给 CodeBuddy。模型推理由 CodeBuddy 云端执行。
+- 没有自定义目录：使用 CodeBuddy 在线目录，失败时使用内置目录；
+- 保存自定义目录：仅向 DSH 提供目录中保留的模型；
+- 已知模型字段留空：继承在线目录或内置目录中的值；
+- 新模型缺少容量：上下文窗口默认 `262144`，最大输出默认 `32768`；
+- 点击“恢复默认模型”：删除自定义目录并恢复适配器目录。
+
+配置值超过服务端真实限制时，CodeBuddy 仍可能拒绝请求。
+
+## 思考程度
 
-支持档位：
+DSH 显示思考程度选项，插件把选中的档位转换为 `reasoning_effort` 并发送给
+CodeBuddy。模型推理由 CodeBuddy 云端执行。
 
 ```text
 minimal / low / medium / high / xhigh / max
 ```
 
-本插件不提供 `off`，因为当前 CodeBuddy 模型目录中的模型属于推理模型。
+当前不提供 `off`，因为 CodeBuddy 模型目录中的模型属于推理模型。未选择档位时，
+使用 CodeBuddy 对应模型的默认值。
 
 ## 更新
 
-npm 安装：
+重新运行安装命令即可更新到最新版：
 
 ```powershell
-dsh plugin --profile web add dsh-llm-codebuddy@latest
-dsh plugin --profile headless add dsh-llm-codebuddy@latest
+npx --yes dsh-llm-codebuddy@latest install
 ```
 
-GitHub 安装：
-
-```powershell
-dsh plugin --profile web add github:Axiaohungry/dsh-llm-codebuddy#v1.2.1
-dsh plugin --profile headless add github:Axiaohungry/dsh-llm-codebuddy#v1.2.1
-```
+更新完成后重启 DSH。模型配置和 API Key 不会被覆盖。
 
 ## 卸载
 
 ```powershell
-dsh plugin --profile web remove dsh-llm-codebuddy
-dsh plugin --profile headless remove dsh-llm-codebuddy
+npx --yes dsh-llm-codebuddy@latest uninstall
 ```
 
-卸载后重启 DSH。WebUI 中保存的 API Key 和模型配置不会由包管理器自动删除。
-
-## 打包与发布
+卸载命令会：
 
-### 上传到 GitHub
+1. 备份 `~/.dsh/settings.yaml`；
+2. 只删除 `llm-pi-ai.providers.codebuddy-cn` 配置；
+3. 保留其他 Provider 和 DSH 设置；
+4. 从 `web`、`headless` Profile 移除插件；
+5. 保留 API Key 凭据，方便以后重新安装。
 
-先在 GitHub 创建一个空仓库 `dsh-llm-codebuddy`，然后在插件目录执行：
+完成后重启 DSH。备份文件名类似：
 
-```powershell
-git init
-git add .
-git commit -m "发布 dsh-llm-codebuddy v1.2.1"
-git branch -M main
-git remote add origin git@github.com:Axiaohungry/dsh-llm-codebuddy.git
-git push -u origin main
-git tag v1.2.1
-git push origin v1.2.1
+```text
+settings.yaml.codebuddy-backup-2026-08-14T12-00-00-000Z
 ```
 
-### 生成安装包
+源码仓库、本地安装包和 API Key 不会被删除。
 
-本地检查并生成 npm 安装包：
+## 常见问题
 
-```powershell
-npm ci --ignore-scripts
-npm run check
-npm pack
-```
+### 安装后看不到 CodeBuddy
 
-会生成类似 `dsh-llm-codebuddy-1.2.1.tgz` 的文件。可以直接测试：
+确认已经重启 DSH，并检查 Web Profile：
 
 ```powershell
-dsh plugin --profile web add .\dsh-llm-codebuddy-1.2.1.tgz
+dsh plugin --profile web list --depth 0
 ```
 
-### 发布到 npm
-
-首次发布：
-
-```powershell
-npm login
-npm publish
-```
+### 获取模型失败
 
-建议在 GitHub 创建与 `package.json` 版本一致的 Release 和 Tag，例如 `v1.2.1`。
+确认 API Key 来自 WorkBuddy 且仍然有效，然后重新输入 Key 并点击“获取可用模型”。
+接口临时不可用时，插件仍会提供内置模型目录。
 
-## 安全说明
+### 卸载后仍显示旧页面
 
-- 不要把 API Key 写进仓库、README、Issue 或截图；
-- API Key 由 DSH 凭据服务保存，插件不把密钥写入模型目录；
-- npm 包只包含 `package.json` 中 `files` 指定的运行文件和文档；
-- 发布前务必使用 `npm pack --dry-run` 检查包内容。
+关闭正在运行的 DSH，再重新启动。已经运行的进程不会自动卸载内存中的插件。
 
 ## 工作原理
 
@@ -190,7 +152,7 @@ DSH Agent → 本插件 → CodeBuddy /v2/chat/completions
 ```
 
 - DSH：负责 Agent 循环、上下文、工具调用和权限；
-- WorkBuddy：提供本插件使用的 API Key；
+- WorkBuddy：提供 API Key；
 - 插件：负责 Provider 注册、模型目录转换和请求兼容；
 - CodeBuddy：负责模型推理并返回结果。
 

package/cli.js

@@ -0,0 +1,88 @@
+#!/usr/bin/env node
+
+import { copyFileSync, existsSync, mkdtempSync, readFileSync, renameSync, rmSync, writeFileSync } from "node:fs";
+import { homedir, tmpdir } from "node:os";
+import { dirname, join, resolve } from "node:path";
+import { spawnSync } from "node:child_process";
+import { parseDocument } from "yaml";
+
+const PACKAGE = "dsh-llm-codebuddy";
+const PROVIDER_PATH = ["llm-pi-ai", "providers", "codebuddy-cn"];
+
+function dshHome() {
+  return resolve(process.env.DSH_HOME || join(homedir(), ".dsh"));
+}
+
+function profileHasPlugin(home, profile) {
+  const file = join(home, "profiles", profile, "package.json");
+  if (!existsSync(file)) return false;
+  const json = JSON.parse(readFileSync(file, "utf8"));
+  return Boolean(json.dependencies?.[PACKAGE] || json.devDependencies?.[PACKAGE]);
+}
+
+function runDsh(args) {
+  const result = spawnSync(process.platform === "win32" ? "dsh.cmd" : "dsh", args, {
+    stdio: "inherit",
+    shell: process.platform === "win32",
+  });
+  if (result.error) throw result.error;
+  if (result.status !== 0) throw new Error(`dsh ${args.join(" ")} 执行失败（退出码 ${result.status}）`);
+}
+
+function cleanSettings(file) {
+  if (!existsSync(file)) return undefined;
+  const source = readFileSync(file, "utf8");
+  const document = parseDocument(source);
+  if (document.errors.length) throw new Error(`无法解析 ${file}：${document.errors[0].message}`);
+  if (!document.hasIn(PROVIDER_PATH)) return undefined;
+
+  document.deleteIn(PROVIDER_PATH);
+  const stamp = new Date().toISOString().replace(/[:.]/g, "-");
+  const backup = `${file}.codebuddy-backup-${stamp}`;
+  const temporary = join(dirname(file), `.settings-codebuddy-${process.pid}.tmp`);
+  copyFileSync(file, backup);
+  writeFileSync(temporary, String(document), "utf8");
+  renameSync(temporary, file);
+  return backup;
+}
+
+function install() {
+  for (const profile of ["web", "headless"]) {
+    runDsh(["plugin", "--profile", profile, "add", `${PACKAGE}@latest`]);
+  }
+  console.log("CodeBuddy Provider 已安装。请重启 DSH 后进行配置。");
+}
+
+function uninstall(home = dshHome()) {
+  const backup = cleanSettings(join(home, "settings.yaml"));
+  for (const profile of ["web", "headless"]) {
+    if (profileHasPlugin(home, profile)) runDsh(["plugin", "--profile", profile, "remove", PACKAGE]);
+  }
+  console.log(backup ? `CodeBuddy 配置已清理，备份：${backup}` : "未发现 CodeBuddy Provider 配置。");
+  console.log("插件已卸载，API Key 凭据保持不变。请重启 DSH。");
+}
+
+function selfTest() {
+  const root = mkdtempSync(join(tmpdir(), "dsh-codebuddy-cli-"));
+  try {
+    const file = join(root, "settings.yaml");
+    writeFileSync(file, "llm-pi-ai:\n  providers:\n    opencode-go:\n      apiKeyEnv: OPENCODE_GO_API_KEY\n    codebuddy-cn:\n      apiKeyEnv: CODEBUDDY_CN_API_KEY\n", "utf8");
+    const backup = cleanSettings(file);
+    const result = parseDocument(readFileSync(file, "utf8"));
+    if (!backup || !existsSync(backup) || result.hasIn(PROVIDER_PATH) || !result.hasIn(["llm-pi-ai", "providers", "opencode-go"])) {
+      throw new Error("uninstall settings cleanup self-test failed");
+    }
+    console.log("CLI-SELF-TEST-OK");
+  } finally {
+    rmSync(root, { recursive: true, force: true });
+  }
+}
+
+const command = process.argv[2];
+if (command === "install") install();
+else if (command === "uninstall") uninstall();
+else if (command === "--self-test") selfTest();
+else {
+  console.log("用法：dsh-llm-codebuddy <install|uninstall>");
+  process.exitCode = 1;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-llm-codebuddy",
-  "version": "1.2.1",
+  "version": "1.3.1",
   "description": "使用 WorkBuddy API Key 为 DeepSeek Harness 接入 CodeBuddy 模型",
   "author": "Axiaohungry",
   "keywords": [
@@ -16,6 +16,9 @@
   "exports": {
     ".": "./index.js"
   },
+  "bin": {
+    "dsh-llm-codebuddy": "cli.js"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Axiaohungry/dsh-llm-codebuddy.git"
@@ -26,13 +29,13 @@
   },
   "files": [
     "index.js",
+    "cli.js",
     "cordis.patch.yml",
-    "install.ps1",
     "README.md",
     "LICENSE"
   ],
   "scripts": {
-    "check": "node --check index.js"
+    "check": "node --check index.js && node --check cli.js && node cli.js --self-test"
   },
   "dsh": {
     "bundle": {
@@ -45,7 +48,8 @@
     "@deepseek-ai/dsh-llm": "0.1.0-rc.6",
     "@deepseek-ai/dsh-llm-pi-ai": "0.1.0-rc.6",
     "@deepseek-ai/dsh-settings": "0.1.0-rc.6",
-    "@earendil-works/pi-ai": "0.82.1"
+    "@earendil-works/pi-ai": "0.82.1",
+    "yaml": "2.8.1"
   },
   "engines": {
     "node": ">=22.19.0"

package/install.ps1

@@ -1,13 +0,0 @@
-$ErrorActionPreference = 'Stop'
-
-Push-Location $PSScriptRoot
-try {
-    npm install --ignore-scripts --no-audit --no-fund
-    dsh plugin --profile web add $PSScriptRoot
-    dsh plugin --profile headless add $PSScriptRoot
-}
-finally {
-    Pop-Location
-}
-
-Write-Host 'CodeBuddy Provider 已安装。请重启 DSH，然后在“设置 → 模型 → 添加提供方”中选择 CodeBuddy 中国区。'