Skip to content
dsh marketplace

dsh-autostart-workbuddy

Verified

@zhiqiangme/dsh-autostart-workbuddy · v26.10.14 · MIT · Web UI

DSH 启动时自动拉起 WorkBuddy Panel（wb2api, 127.0.0.1:7863/panel），幂等、静默、退出时只停自己拉起的进程。

Install

dsh plugin add @zhiqiangme/dsh-autostart-workbuddy

Confirm the layer applied with dsh --profile default --dump-config — see the install guide.

Source

Published to npm without a public repository. Inspect the package contents before installing.

Tags

Readme

@zhiqiangme/dsh-autostart-workbuddy

DeepSeek Harness（DSH）插件：DSH 启动时自动拉起 WorkBuddy Panel（workbuddy2api-panel 的 wb2api.exe）， 不用再手动启动它；还可以接管 DSH 里 workbuddy 的模型列表、在插件页管理后端版本。

服务 端点 作用
WorkBuddy Panel（wb2api.exe） 127.0.0.1:7863 profile 里 workbuddy provider 的上游（http://127.0.0.1:7863/v1/）

同一仓库里还有 Tavily 联网搜索插件 @zhiqiangme/dsh-tavily-search：两个插件各自独立开关，任何一个出问题都不影响另一个。

行为

  • 随 DSH 启动：插件加载后在后台拉起服务，不阻塞 DSH 启动。
  • 幂等：启动前先探测端口，已在监听就跳过——重复启动只会端口冲突。
  • 静默：不打开 WorkBuddy 管理面板浏览器窗口（需要时自行访问 http://127.0.0.1:7863/panel/）。
  • 失败不阻断：起不来只写日志，DSH 本身照常可用；失败时会回收自己拉起的进程，不留僵尸进程。
  • 退出即停，但只停自己拉起的：DSH 退出时结束本插件 spawn 的进程；DSH 启动前就已在运行的服务（手动起的、另一个 DSH 实例留下的）不受影响。
  • 只依赖 Node 内置模块：核心工作（拉起进程、改 profile）不注入任何 Host Service，因此不受插件加载顺序影响； Web 面板要用宿主 webserver 时是"用得上就用"——拿不到只少一个面板，其余功能照常。

接管模型列表

除了拉服务，本插件还能接管 WorkBuddy 的模型列表（config.models.enabled: true 时）：

  • 后端就绪后拉一次 GET /v1/models，把后端真实提供的模型写进 llm-pi-ai.providers.workbuddy.models，llm-pi-ai 随即热重载，模型选择器马上就是新清单。
  • 写入走 DSH 自己的 configEditor（设置页用的同一个入口）：持 profile 锁、按 llm-pi-ai 的 schema 校验、原子写、只热重载被改的那一行，失败自动回滚。不再自己改 cordis.patch.yml 的文本， 所以不会和设置页的保存互相覆盖。代价是 llm-pi-ai 那一行会按 DSH 的格式重新排版（行内注释不保留）。
  • workbuddy provider 整段不在时会按原有形状补建（apiKeyEnv: WORKBUDDY_PROXY_KEY，密钥不落明文）。
  • 展示名统一成 <CN|GL> <上游名> <倍率>：cn: → CN、global: → GL； 倍率取上游的 credits（x0.11 → 0.11，x0.00 或缺失 → Free）。
  • 每个模型默认给低/高/最大三个思考档位（efforts: auto 则按上游声明的档位）。
  • models.only 是白名单：留空 = 同步后端全部模型；填了就只保留列出的 id，并按列出顺序展示。
  • 后端返回空列表（面板在上游故障时就是这么降级的）或请求失败时不动现有配置。
  • 宿主没有 configEditor（DSH 版本过旧）时只记一条日志、跳过同步，后端照常拉起。
  • 模型同步默认关闭。在插件页勾选「同步到 DSH 模型列表」并点击「保存并同步」即可开启， 不需要手动编辑 profile；关闭并保存后保留现有模型列表。

命令行只能预览（读 profile 里本插件那一行，打印将要写进去的 models 段，不改任何文件）：

node lib/sync-cli.js

真正的写入只发生在 DSH 里：启动后自动同步一次，或在插件页点「保存」。

⚠️ 一个上游行为要知道：kimi-k3-1 这类模型上游只支持 medium 档，默认的三档是对所有模型统一给的； 要严格对齐上游就配 efforts: auto。

Web 面板：在这里勾选模型、看倍率

在 DSH 的插件页打开本插件（组合包页面，或本插件那一行的"配置"），卡片会列出后端 /v1/models 的全部模型，每行带倍率、上下文长度与是否支持视觉：

  • 「同步到 DSH 模型列表」控制 config.models.enabled，与勾选结果 config.models.only 一起经 configEditor 写入。开启后点击「保存并同步」会立即重新生成 llm-pi-ai.providers.workbuddy.models，不用重启，也可以只开启同步、不更改已有勾选。
  • 同步开启时，即使勾选没有变化也能再次「保存并同步」，用于重试同步失败或修复旧清单。 同步关闭时，「保存」只更新开关和勾选结果，不改 DSH 中已有的模型列表。
  • 改白名单（以及 models 段的其它字段）不会重启本插件：插件拦下这类配置变更就地生效， 托管的后端不会被停掉再拉起。端口、exe 等其它字段变了才按常规重启。
  • 倍率就是拼进展示名的那个（x0.11 → x0.11，x0.00 / 缺失 → Free）。
  • 一个都不勾再保存 = 白名单留空 = 同步后端全部模型（既有语义），面板里有提示。
  • 后端不可达时面板照常打开并显示原因，此时不写任何配置。
  • 只有点「保存」才会写 profile；保存后的提示会说明模型清单是否同步成功（失败用错误色并给出原因）。
  • 卡片顶部有一行 后端面板：127.0.0.1:7863/panel 的可点击外链，点了用默认浏览器打开。 地址由宿主按服务规格给出（端口可配），不是写死的。链接用 <a target="_blank" rel="noopener noreferrer">， 宿主主窗口的 setWindowOpenHandler 对 http(s) 会调 shell.openExternal——这也是 DSH 里外链的既有做法。
  • 链接旁边有「复制访问密钥」：后端面板首次打开会要求输入 config.json 里的 api_key。 面板只从浏览器自己的 localStorage 读密钥（按来源隔离），插件替它填不进去，所以改为一键复制、 用户粘贴一次（之后浏览器会记住）。剪贴板不可用时退回显示原文供手动复制。 密钥经 POST /plugins/dsh-autostart-workbuddy/panel-key 取（只接受 loopback 来源，GET 一律 405）， 不放进其它接口的应答里。

数据通路：卡片 fetch('/plugins/dsh-autostart-workbuddy/models')，宿主半侧 （lib/web.js）负责拉后端与读写 profile。必须过宿主是因为：页面够不到 127.0.0.1:7863（跨源，面板不发 CORS 头），也改不了 profile 里的白名单；而 DSH 的 configForms 通道要求宿主声明带 .volatile() 的 schemastery 配置，本插件刻意不引这个依赖。 路由只接受 loopback 来源（无 Origin 或 localhost/127.0.0.1/::1），其它一律 403。

插件更新（卡片最底部）

与上面管 wb2api 的「后端版本」是两回事：这一块管本插件自己。

  • 显示当前运行版本与 npm 最新版本。版本检查走宿主半侧路由 /plugins/dsh-autostart-workbuddy/version （lib/update.js）：同时问 npm 官方源与 npmmirror，取较高者，缓存 10 分钟，「检查更新」绕过缓存。
  • 装了 dshmarket 时出现「更新到 x」按钮，经它的公开更新 API v1 更新并显示进度； 没装时只提示有新版本。本插件不自己跑 pnpm：DSH 自带的插件管理器不支持升级已安装的插件， profile 锁、文件占用、回滚与版本核对都交给 dshmarket。
  • 桌面版更新完成后要重启 DSH 才会换上新代码（桌面版的重启归桌面壳管，卡片不提供重启按钮）。 新版本刚发布时可能被 pnpm 的发布冷却期挡下，卡片会给出「强制更新」。
  • 一键更新只对从 npm 安装的情况有效。从本地目录（file:）装时 dshmarket 把它当作本地拷贝（linked）并拒绝更新， 卡片会先向 dshmarket 查询安装来源，这种情况下不显示更新按钮，改为提示；请用上文的 install-plugins.cmd 更新，或改为从 npm 安装。

⚠️ 改了 lib/client.js 要重启 DSH 才生效：客户端 bundle 的版本号由文件 mtime/size 派生， 宿主只在启动时扫描一次；lib/*.js 的改动同样不会热重载。

安装到 profile

从 npm 安装：先完全退出 DSH 桌面版，然后在终端运行（dsh 命令随 DSH 桌面版一起安装），重新打开 DSH 生效：

dsh plugin --profile desktop add @zhiqiangme/dsh-autostart-workbuddy
# 更新：dsh plugin --profile desktop update --latest @zhiqiangme/dsh-autostart-workbuddy

装到 Web / CLI 就把 desktop 换成 web / headless。更新要带 --latest：版本号按日期编排（26.10.11）， 跨年时主版本号会变。更多说明见仓库 README。

从源码安装：克隆仓库后双击根目录的 install-plugins.cmd， 按提示选择插件和 profile（说明见仓库 README），完成后重启 DSH 生效。 改了本插件的源码后再运行一次同样的"安装 / 更新"即可换上新代码。

手动安装等价于（先完全退出桌面版）：

dsh plugin --profile desktop add "file:<仓库路径>\dsh-autostart-workbuddy"

⚠️ file: 依赖在 profile 里是拷贝，不是软链：改了本插件的源码后再 add（包括 --force）pnpm 都认为"已是最新"， 要先 dsh plugin --profile desktop remove @zhiqiangme/dsh-autostart-workbuddy 再 add，否则 DSH 跑的还是旧代码。 安装脚本会比对文件哈希自动做这一步。

配置

在 profile 的 cordis.patch.yml 里按行 id 覆盖：

- id: dsh-autostart-workbuddy
  name: '@zhiqiangme/dsh-autostart-workbuddy'   # 包名以 @ 开头，YAML 里必须加引号
  config:
    enabled: true
    readinessTimeoutMs: 30000
    stopTimeoutMs: 5000
    port: 7863
    # exe / cwd 默认指向插件自管的后端目录，通常不用写：
    #   $DSH_HOME/autostart-workbuddy/backend/current/{wb2api.exe,config.json}
    args: ['-config', 'config.json']
    models:
      enabled: true
      only:                     # 留空 = 后端全部模型
        - cn:deepseek-v4.1-flash
        - global:deepseek-v4.1-flash
    backend:
      checkOnStart: true        # 启动时查一次上游 release（只提示，不自动安装）
      keepVersions: 3           # 保留几个历史版本供回滚
字段 说明
enabled 总开关；false 时完全不拉起（默认 true）
title 日志里显示的服务名，默认 WorkBuddy Panel
host / port 就绪探测目标，默认 127.0.0.1:7863
exe 可执行文件，默认 $DSH_HOME/autostart-workbuddy/backend/current/wb2api.exe
args 附加参数，默认 ['-config', 'config.json']
cwd 子进程工作目录，默认 $DSH_HOME/autostart-workbuddy/backend/current
env 追加到子进程环境的键值对（不会改写 DSH 自己的环境）
logDir 日志目录，默认 $DSH_HOME/autostart-workbuddy/logs
logName 日志文件名前缀，默认 wb2api
readinessTimeoutMs 等待端口就绪的上限，默认 30000
stopTimeoutMs 停止时等待退出的上限，默认 5000；超时后强制结束

models 段的字段：

字段 说明
enabled 是否接管模型列表，默认 false（不开就不碰 profile）
only 白名单，按列出顺序写；空 = 后端全部模型
exclude 黑名单，优先级高于 only
efforts 每个模型的思考档位，默认 [low, high, max]；填 auto 用上游声明的档位
panelConfig 读网关密钥的面板配置，默认 <cwd>/config.json
apiKey 显式指定网关密钥，默认依次尝试 WORKBUDDY_PROXY_KEY、面板 config.json 的 api_key
baseURL 模型接口地址，默认 http://<host>:<port>
timeoutMs 拉取超时，默认 60000（面板的模型列表缓存 1h，冷缓存要等上游）

backend 段的字段（后端版本管理）：

字段 说明
enabled 是否允许查更新 / 更新 / 回滚，默认 true
checkOnStart DSH 启动时查一次上游 release 并写日志，默认 true（只提示）
checkTtlMs 查询结果缓存时长，默认 6 小时（GitHub 匿名 API 只有 60 次/小时）
keepVersions 保留几个历史版本供回滚，默认 3
apiBase 覆盖 GitHub API 基址（镜像 / 测试用），默认官方 api.github.com

后端版本管理

后端（wb2api.exe）由插件自己管理安装位置与更新，目录布局在 $DSH_HOME/autostart-workbuddy/：

backend/current/     正在用的 wb2api.exe + config.json + installed.json（版本清单）
backend/versions/    历史版本，回滚用（保留最近 keepVersions 个）
data/                账号凭证与状态：auths/ · state.json · usage.json · request-logs/
cache/               下载的 release 包与查询缓存
logs/                后端 stdout/stderr

程序与数据分离是刻意的：config.json 里的 auth_dir / state_file 指向 data/ 的绝对路径， 所以切换版本时凭证与状态原地不动，更新永远不碰账号。

版本怎么认

后端没有 PE 版本号，/healthz 也不报版本；但 exe 里嵌了 Go buildinfo：

vcs.revision=d66384d9e3d69655f799d7d8f2e5fba1946e00ab
vcs.time=2026-10-08T00:49:09Z

所以"本地版本" = 从 exe 里读 vcs.revision，"上游最新" = GitHub Releases 最新 tag 对应的 commit （不看 main 分支：release 才有打包产物与校验和）。两者不等即提示可更新。

更新流程（只在面板里点，不自动装）

  1. 取最新 release → 选中 *-windows-amd64.zip
  2. 下载到 cache/，算 sha256 与 release 的 checksums.txt 比对——没有校验和就拒绝安装
  3. 解压出 wb2api.exe，校验它自称的 vcs.revision 等于目标 tag 的 commit
  4. 停后端（Windows 下运行中的 exe 被锁）→ 旧版本归档到 backend/versions/<旧版本>/ → 新 exe 落到 current/
  5. 起后端 → 探 /healthz（必须返回 service: workbuddy2api）
  6. 失败自动回滚到上一版本并重启

只停本插件自己拉起的进程：如果 7863 上是你手动启动的实例，会拒绝更新并提示先停掉它，绝不误杀。

安装与卸载

面板那一行按钮按状态切换：没装时显示「安装」，装了时显示「更新 + 卸载（红色）+ 回滚」。

  • 安装：从最新 release 拉 windows-amd64 包装到 backend/current/。已经装了会拒绝—— 那应该用「更新」（安装只认 release 的产物，不接受任意版本）。
  • 卸载：二次确认弹窗之后才执行——停后端，删掉 wb2api.exe、历史版本与下载缓存； 保留 config.json 与 data/（账号凭证与状态）。要连数据一起清就自己删 data/。 宿主 Modal 拿不到时会退回卡片内的行内确认，同样是"再点一次才真的删"。
  • 卸载后插件不再尝试启动后端（启动日志会说明"未安装"），直到你再点「安装」。 例外：在 profile 里显式配了 exe 时，路径不存在仍按老行为尝试启动—— 否则一个拼错的路径会被误报成"未安装"，把配置错误藏起来。

CLI

node lib/backend-cli.js                  # 看本地布局与版本（不联网）
node lib/backend-cli.js --check          # 再查一次上游最新 release
node lib/backend-cli.js --update         # 下载并安装最新版
node lib/backend-cli.js --rollback       # 回滚到上一版本
node lib/backend-cli.js --adopt v1.13.0  # 把现场已有的 exe 纳管（写 installed.json）

--update / --rollback 用的 ManagedService 是 CLI 自己创建的，因此只能停它自己拉起的进程； 后端由 DSH 拉起时请改用面板里的按钮。

任何非法值都会退回默认值，不会让插件加载失败。

排障

# 看插件解析出的实际规格与模型同步配置（只读，不启动任何东西、不联网）
node lib/cli.js

# 额外校验可执行文件 / profile 配置是否存在、端口当前状态
node lib/cli.js --check

# 预览模型列表同步会写什么（只读；真正写入在 DSH 里进行）
node lib/sync-cli.js

日志按时间戳分文件写在 logDir：wb2api.<时间戳>.out.log / .err.log。

测试

node --test test/*.test.mjs

注意别写 node --test test/：Node 24 会把目录参数当成模块去 require，直接报 MODULE_NOT_FOUND。

fixtures/ 下是测试用的假服务；不要把它放进 test/，否则 Node 的测试运行器会把它当成用例执行，而一个正在 listen 的服务器会让整轮测试挂死。