dsh-dev-rules · Felix 项目开发规则
DSH(DeepSeek Harness)个人插件:把你自己的一套项目开发规则交给 DSH,让 agent 在开发项目时自动遵守。
- 面板:Web GUI 右侧栏新增「开发规则」页(与「Docker 容器」并列,走 DSH 原生
sidebarRightTabs+sidebar.right.pane.tab契约),可视化维护规则(全局 + 按项目)。 - 自动注入:每个会话组装系统提示时,按该会话的工作目录解析生效规则并注入,无需手工提醒。
- 对话内维护:另带
dev_rules模型工具,直接说「把这条记进开发规则」也能落库。 - 即时生效:保存后正在运行的会话下一步就生效,不用重启 DSH。
一、功能
| 能力 | 说明 |
|---|---|
| 全局规则 | 对所有会话生效,是「凡项目都适用」的底线约定 |
| 项目规则 | 会话工作目录落在项目路径之下即命中;多个命中时取路径最长(最具体)的一个;工作目录走软链时自动用 realpath 再匹配一次 |
| 追加 / 覆盖 | 项目可「追加」(全局 + 本项目)或「覆盖」(只生效本项目规则);覆盖模式下注入文本会写明被挡掉了多少条全局规则 |
| 分组 | 每条规则可填分组名;面板按分组筛选,注入文本里作为 ### 组 小标题(不改动规则顺序) |
| 搜索 | 按标题 / 正文 / 分组过滤当前页签(筛选时禁用上移下移,避免顺序错乱) |
| 单条开关 | 每条规则可单独停用(保留内容、不注入);总开关可整体关闭注入 |
| 删除保护 | 删除规则 / 项目条目需要二次确认(3 秒内不确认自动还原) |
| 保存冲突检测 | /save 带 revision;磁盘被别的会话或手工编辑改过时返回 409,面板提示「载入磁盘版本」或「用我的改动覆盖」,不会静默覆盖 |
| 外部改动同步 | 面板在后台按 revision 轮询:没有未保存改动就静默跟上,有改动就明确提示 |
| 备份 | 每次保存前把上一版写到 dev-rules.json.bak |
| 导入 / 导出 | 导出 JSON / Markdown;导入 Markdown / JSON(可替换或合并,按 id 与标题+正文去重) |
| 成本提示 | 注入预览显示字符数与估算 token,并列出最占预算的 5 条规则;每条规则卡片还标出它给每轮对话增加的字符数 |
| 注入预览 | 输入任意目录,看该目录下真正注入的文本(含未保存修改、命中项目、是否被截断) |
| 上限保护 | 单次注入文本上限 12000 字符,超出在行边界截断并附提示,避免吃光提示预算 |
dev_rules 工具 |
action = list / add / update / remove,支持 global / project 归属与分组 |
| 插件更新 | 面板顶部有更新时才出现一条细提示,点「更新」即可更新本插件(走插件市场公布的同源更新 API,含进度、失败原因与回滚);没装插件市场时整块隐藏 |
| 接口硬化 | 所有接口校验 Origin / Sec-Fetch-Site(跨站 403),POST 要求 Content-Type: application/json(否则 415) |
没有生效规则时注入空串 —— 等于这个插件「隐身」。
二、安装
本插件是标准的 DSH profile bundle(双半体:宿主 + 浏览器),需要已安装 dsh CLI(npm install -g @deepseek-ai/dsh)与 pnpm。按你的网络从下面两条来源里选一条:
# 能直连 GitHub
dsh plugin --profile web add github:Grant-Felix/dev-rules
# 国内走 Gitee 镜像(pnpm 没有 gitee: 简写,用完整地址)
dsh plugin --profile web add git+https://gitee.com/Grant-Felix/dev-rules.git
# 仓库开发调试:链到本地检出
dsh plugin --profile web add link:$PWD
dsh plugin 就是 pnpm 的透传:装完它会按包名把插件自动登记进 dsh.profile.bundles,不必手工改 profile 的 package.json。装完重启该 profile(侧边栏底部 ↻),右侧栏页面列表里就会出现「开发规则」。
为什么没有 npm 包名可以
add:dev-rules这个包名在 npm 上已被别人占用;改名的dsh-dev-rules首发受 npm 现行的 2FA 发布策略阻挡(细粒度令牌那条路 2027 年 1 月还要再收窄)。所以对外以 git 来源分发:GitHub 给直连用户,Gitee 给国内用户。
改动生效范围(本部署实测):
| 改了什么 | 怎么生效 |
|---|---|
宿主半体 lib/index.js、lib/rules.js |
重启 profile(侧边栏底部 ↻) |
浏览器半体 lib/client.js |
同样是重启 profile |
为什么客户端改动也要重启:DSH 的
client-modules在启动时把每个插件的 client bundle 读进内存(readFileSync+ 内容哈希当rev),之后只按「已登记的 URL」出字节;文件内容变化要经 HMR watcher 的rebuilt(id)才会重新登记,而 watcher 只有在源码检出里跑着pnpm run dev:web时才装得上。本机是安装版部署、没有跑 dev watcher,所以硬刷新页面拿不到新 bundle,必须重启一次 profile。
升级:面板顶部在有新版本时会自动出现一条提示,点「更新」即可(走插件市场公布的同源更新 API;没装插件市场时这条提示不出现)。也可在插件市场的「更新」里做(它按 profile 的 lockfile 锁定的提交与远端 HEAD 比对,并自带 git 更新的回滚),或命令行 dsh plugin --profile web update dsh-dev-rules(重新解析到分支最新提交)。卸载:dsh plugin --profile web remove dsh-dev-rules,重启。规则文件会留在 $DSH_HOME/dev-rules.json。
三、数据
规则存在 $DSH_HOME/dev-rules.json(默认 ~/.dsh/dev-rules.json),原子写入(临时文件 + rename);保存前上一版留在 dev-rules.json.bak。
这份文件属于使用者本人,不在本仓、不受本仓许可约束(见
NOTICE.md)。插件只读写本机这一份文件,不联网、不上传。
{
"version": 1,
"enabled": true,
"global": [
{ "id": "g1", "title": "提交前跑测试", "content": "npm test 必须绿", "group": "提交", "enabled": true }
],
"projects": [
{
"id": "p1",
"path": "~/项目/foo",
"label": "示例项目",
"enabled": true,
"mode": "append",
"rules": [
{ "id": "r1", "title": "本项目用 pnpm", "content": "禁止 npm install", "group": "依赖", "enabled": true }
]
}
]
}
mode:append(默认)或override。- 路径支持
~;保存时统一规范化成绝对路径,尾部分隔符会被去掉;Windows 风格路径(C:\…)无论宿主平台都按 Windows 规则收敛。 - 目录为空的项目条目不会被保存 —— 面板保存前会提示补全或删除。
- 手工编辑该文件会被宿主自动重载(监听目录 + 15 秒轮询兜底)。
四、面板
位置:右侧栏的页面列表里点「开发规则」(与「文件 / 终端 / 浏览器 / Docker 容器」并列),内容在右列打开。
打开就能用的三步
- 面板顶部吸顶条写明「这里是干什么的」+ 当前共几条规则;右侧永远只有一个主动作 保存并生效(有改动才可点,
Ctrl/Cmd + S同效)。 - 一条规则都没有时,面板给出两步上手说明 + 「先插入 4 条虚构示例」(同一目录风格一致 / 依赖升级单独提交 / 配置项集中管理 / 发布前核对版本号),插进来直接改成自己的。
- 页签只有三个:全局规则 / 项目规则 / 效果预览,各自顶部一行说明什么时候该用它。
日常操作
- 规则卡片:标题(一句话)→ 正文(具体怎么做)→ 分组(可选)+ 「生效」开关 + 上移下移 + 二次确认删除;卡片只标「约 N 字」(这条规则给每轮对话增加的上下文量)。
- 「效果预览」:选一个目录点「查看」,用大白话告诉你:命中了哪个项目、用了几条规则、全局规则有没有被挡掉、一共多少字 / 约多少 token、是否被截断,下面给出实际注入的原文。
- 顶部「生效中 / 已停用」小胶囊就是总开关(点一下切换),不用去翻设置。
- 冲突与导入都弹横幅并给出明确选择:「载入磁盘版本(放弃我的修改)/用我的修改覆盖」、「替换现有规则/合并进来/算了」。
- **更多(折叠)**里是低频功能:插件更新(手动查一次本插件有没有新版本)、导出备份(Markdown / JSON)、从备份导入、放弃修改并重新载入、文件位置、使用说明。
- 搜索与分组筛选只在规则较多(> 6 条)时才出现,避免一上来就堆控件;但只要筛选条件还在,这行就不会消失 —— 否则规则会被静默藏起来,连清空条件的地方都没有。
- 面板渲染若抛错,会就地显示错误原文(错误边界),而不是整块空白。
五、注入形态
系统提示 section 名 plugin:dev-rules(order 100,紧跟 persona 之后、工具说明之前),正文是常量 {{dev_rules_body}};真正的规则文本由同名提示变量提供。
为什么要绕一道变量:DSH 会对 section 正文做严格的
{{变量}}插值,遇到未知 / 畸形引用会直接抛错,而这一步发生在插件回调之外——用户规则里的{{placeholder}}会把整个模型步打挂。变量值不会被二次扫描,所以用户写什么都不会破坏提示组装。
渲染形如:
# 项目开发规则(Felix 项目开发规则)
以下是本机用户维护的开发规则……如有冲突,以后者为准。
适用项目:示例项目(~/项目/foo)
规则来源:全局规则 + 项目追加规则
## 全局规则
### 提交
1. **提交前跑测试**
npm test 必须绿
## 项目规则
### 依赖
2. **本项目用 pnpm**
禁止 npm install
项目命中时文本里写明「适用项目 / 规则来源」,未命中时明确写「当前目录未匹配到项目规则集」,覆盖模式写明被挡掉的全局规则条数 —— 避免 agent 误以为规则不存在。
六、接口
| 方法 | 路径 | 作用 |
|---|---|---|
| GET | /dev-rules/state |
读当前文档 + 元信息(文件、备份、revision、规模、错误) |
| GET | /dev-rules/workspaces |
项目路径下拉的数据源(工作区注册表 + 活动会话目录) |
| POST | /dev-rules/save |
{ doc, revision } 保存;revision 过期 → 409 + 当前文档 |
| POST | /dev-rules/reload |
从磁盘重新读取 |
| POST | /dev-rules/preview |
{ doc?, path } 渲染注入文本 + 字符 / token / 逐条体积 |
| POST | /dev-rules/export |
{ doc } → Markdown 与 JSON 文本 |
| POST | /dev-rules/import |
{ text } → 解析 Markdown 或 JSON 得到文档 |
排障示例:curl -s 127.0.0.1:3080/dev-rules/state | head -c 400
安全边界:以上接口只接受同源请求(跨站 Origin / Sec-Fetch-Site 直接 403),POST 必须 Content-Type: application/json。但同机的其它本地进程仍可无凭据访问(DSH 的 webServer 不对插件路由做登录鉴权)——规则内容会进模型提示,别把不能外发的东西写进去。
七、开发
node --test # 42 个用例
npm run check # 语法检查 + 全部测试
改完先在隔离沙箱里验,别拿日常在用的那个 profile 试。 宿主半体是在 profile 启动时加载的:一个有问题的改动足以让整个 DSH 起不来,那时你连界面都进不去,只能去终端里拆插件。
npm run sandbox # 在 .sandbox/home 里装本地检出并起一个实例(默认 :3199,Ctrl-C 结束)
npm run sandbox:check # 只做自检 + profile 组装,不启动(提交前跑这个最快)
npm run sandbox:clean # 删掉沙箱
# 想验「使用者装到的到底是什么」:把来源换成发布的那份再起
DSH_SANDBOX_SOURCE=github:Grant-Felix/dev-rules npm run sandbox
DSH_SANDBOX_SOURCE=git+https://gitee.com/Grant-Felix/dev-rules.git npm run sandbox
沙箱有独立的 DSH_HOME,所以它读写的是自己的 dev-rules.json,不会碰你的真实规则文件;脚本还会拒绝把沙箱 home 指到真实 home。默认端口可用 DSH_SANDBOX_PORT 改。
lib/rules.js纯逻辑(规范化 / 路径匹配 / 生效规则 / 渲染 / 分组 / token 估算 / Markdown 往返),宿主、面板与测试共用;路径匹配的 win32 分支通过 platform 参数可测。lib/index.js宿主半体:存储、提示变量注入、/dev-rules/*接口、dev_rules工具。lib/client.js浏览器半体:手写的window.__ModuleLoader__.load({ id, factory })bundle,只依赖react,不需要打包器;纯函数内部件(token 估算 / 导入合并 / 更新提示判定)通过exports.__internal暴露给测试。scripts/sandbox.sh:上面那套隔离环境的实现(独立DSH_HOME+ 独立端口 + 安全闸)。- 测试:
test/rules.test.mjs(逻辑)、test/host.test.mjs(接口 / 备份 / 409 / 403 / 415 / 软链回退 / 工具)、test/client.test.mjs(槽位接线 / 服务晚出现 / 内部件)。 - CI:
.github/workflows/ci.yml在 node 20 / 22 / 24 上跑语法检查 + 测试。
八、代码托管
本仓遵循「本地 Forgejo 开发 / GitHub 与 Gitee 对外并受理反馈」的三平台分工:代码与提交历史以本地 Forgejo 为准,两个公开平台只做对外窗口与镜像。
| 平台 | 角色 | 状态 |
|---|---|---|
| 本地 Forgejo(私有,走回环) | 开发主仓,代码与历史以它为准 | 已建仓并推送(默认分支 main) |
| GitHub https://github.com/Grant-Felix/dev-rules | 对外窗口 + 反馈受理 | 已发布(公开,MIT) |
| Gitee https://gitee.com/Grant-Felix/dev-rules | 国内镜像 + 同样受理反馈 | 已发布(由 GitHub 单向同步) |
代码单向流动:本地 Forgejo → GitHub → Gitee,禁止把某个平台的提交反向直推到另一个平台(会造成历史分叉与重复改动)。两个平台上的 Issue 与 PR 都一样受理,但同一个问题只在先提出的那一侧开正式讨论,另一侧贴链接引导过去,避免两边各说各话。
推送凭据按平台分开配置:每个 host 各有一个 git credential helper,且都校验 host=、只对自己那一个平台应答,其它 host 一律静默退出 —— 否则会把 A 平台的令牌回给 B 平台。
发版版本号用发布日期式:<YY>.<M>.<D>-<当日序号>,如 26.9.21-1(2026-09-21 当天第 1 个版本),同日第 2 个是 26.9.21-2;年月日不补零(26.09.21-1 不合法——semver 禁止数字标识符带前导零)。标签、清单 version、Release 标题与产物名用同一串(tag 加 v 前缀),三个平台推同一个 tag。
-x在 semver 里是 prerelease,两点要记住:一直用它、别与不带序号的26.9.21混用(排序上26.9.21-1 < 26.9.21,混用会把「第几个」和「新旧」搞反);发布到 npm 必须显式给 tag(npm publish --tag latest),否则 npm 拒绝发布 prerelease。
代码与规则内容分开。 本仓只装插件(开源,MIT);作者本人维护的规则内容不在本仓、也不随本仓分发,只存在于作者本机。这条边界由文件位置本身保证,不靠约定去守 —— 详见
NOTICE.md。
九、许可
代码开源、规则内容闭源:
| 范围 | 许可 |
|---|---|
本仓源代码(lib/、test/ 等) |
MIT(见 LICENSE) |
| 本仓内的示例规则 | 随代码 MIT —— 全部虚构,不是作者的真实规则 |
| 作者本人的规则内容 | 不开源,也不在本仓:只存在于作者本机的 ~/.dsh/dev-rules.json |
| 使用者自己的规则内容 | 归使用者所有,与本项目许可无关 |
范围与边界见 NOTICE.md。
No comments yet. Be the first to write one.