前言¶
DSH 插件生态里,很多工作围绕智能体与本地环境协作展开。dsh-document-review 针对一个具体场景:在 DSH 中审阅 Markdown 文档。
它把 Markdown 渲染到本地浏览器,让人选中文字添加评论、建议替换或建议删除;agent 读取这些注释后,再通过正常文件编辑工具修改源文件。下面介绍它的定位、安装和用法。
这是什么¶
dsh-document-review 是一个 DeepSeek Harness 插件,由 yabo083 维护,许可证为 MIT,要求 Node >=20。
它支持审阅单个 Markdown 文件,也支持审阅整个目录。浏览器审阅页只读渲染 Markdown,并在侧栏显示注释;页面不直接编辑 Markdown 源文件。
注释集中保存在:
~/.dsh-document-review/annotations.jsonl
这是 append-only 存储。注释带有 textQuote 锚点和 SHA-256 源文件哈希,用于校验 stale。
核心功能¶
先说能力边界。这个插件提供以下能力:
- 在本地浏览器中审阅 Markdown 文档。
- 支持选中文本添加评论、建议替换和建议删除。
- 支持单个 Markdown 文件和整个目录审阅。
- 提供
document_review_start、document_review_list、document_review_update、document_review_stop工具。
目录模式下,它会递归列出 .md/.markdown 文件,跳过 node_modules、.git 和构建产物目录,最多处理 500 个文件。
设置方面,它提供全局设置和当前工作区设置,并分层覆盖 cordis.yml 配置:
默认值 → cordis.yml → 全局设置 → 当前工作区设置
全局设置持久化到:
~/.dsh-document-review/config.json
当前工作区设置持久化到:
~/.dsh-document-review/workspace-configs.json
入口方面,它会在 DSH 侧栏 Workspace 行菜单中提供「文档审阅」入口,并提供 /api/v2/document-review/start 等 HTTP 路由供 GUI 启动器使用。
安装与启用¶
先安装插件:
dsh plugin --profile web add dsh-document-review
如果是从本地 checkout 做开发安装,先指定 cordis.yml 的绝对路径:
dsh web --patch /absolute/path/to/dsh-document-review/cordis.yml
路径需要按你的 checkout 位置修改。
经过上面的步骤后,可以打开:
http://127.0.0.1:3080
然后要求 agent:
Review the document at /path/to/file.md word by word.
也可以打开 Workspace 行的 ⋯ 菜单,选择「文档审阅」进入审阅页。
典型用法¶
单文件流程:
1、打开 DSH Web 页面。
2、把要审阅的 Markdown 路径告诉 agent,例如:
Review the document at /path/to/file.md word by word.
3、在渲染文档中选中一段文字。
4、选择添加评论、建议替换或建议删除。
5、注释出现在侧栏;agent 读取注释后,通过正常文件编辑工具应用修改。
目录流程:
1、将目录路径传给 document_review_start。
2、页面列出目录中的 .md/.markdown 文件;递归列出,跳过 node_modules、.git 和构建产物目录,最多 500 个文件。
3、逐个打开文档并添加注释。
如果需要由 GUI 启动器拉起,可以调用 HTTP 路由:
POST /api/v2/document-review/start
适用场景与注意¶
适合场景:
- 在 DSH 工作流中审阅单个 Markdown 文件。
- 审阅一个目录内的多篇 Markdown 文档。
- 人负责标注,agent 负责读取注释并执行修改。
注意:
- 浏览器审阅页不直接编辑 Markdown 源文件;修改由 agent 通过正常文件编辑工具应用。
- 插件以当前
dsh进程权限运行,安装前应检查源码与许可证。 - 目录模式有文件数量上限,最多 500 个文件,并跳过
node_modules、.git和构建产物目录。 - 运行环境需要 Node >=20。
资源¶
GitHub:
https://github.com/yabo083/dsh-document-review
插件目录页:
https://www.skillhub.cn/plugins/yabo083/dsh-document-review