dsh-plugin-dev-kb 1.8.0 → 1.8.1

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.
Files changed (229) hide show
  1. package/CHANGELOG.md +186 -178
  2. package/README.en.md +172 -172
  3. package/README.md +183 -183
  4. package/kb/INDEX.md +236 -234
  5. package/kb/README.md +88 -88
  6. package/kb/extra/AGENTS.md +77 -77
  7. package/kb/extra/deepseek-llm-api-wire-extensions.md +162 -162
  8. package/kb/extra/deepseek-llm-api-wire-extensions.zh.md +162 -162
  9. package/kb/extra/defensive-patterns/package-surface.md +233 -232
  10. package/kb/extra/defensive-patterns/package-surface.zh.md +233 -232
  11. package/kb/extra/defensive-patterns/remote-and-api.md +117 -117
  12. package/kb/extra/defensive-patterns/remote-and-api.zh.md +117 -117
  13. package/kb/extra/development.md +221 -221
  14. package/kb/extra/development.zh.md +228 -228
  15. package/kb/extra/event-producer-consumer.md +133 -123
  16. package/kb/extra/event-producer-consumer.zh.md +135 -125
  17. package/kb/extra/module-graph.md +1961 -1888
  18. package/kb/extra/module-graph.zh.md +1963 -1890
  19. package/kb/extra/persistence-changes/2026-11-05-timeline-priority-notice.md +60 -0
  20. package/kb/extra/persistence-changes/2026-11-05-timeline-priority-notice.zh.md +60 -0
  21. package/kb/extra/persistence-changes/README.md +92 -92
  22. package/kb/extra/persistence-changes/README.zh.md +92 -92
  23. package/kb/extra/persistence-changes/historical-formats/README.md +75 -75
  24. package/kb/extra/persistence-changes/historical-formats/README.zh.md +75 -75
  25. package/kb/extra/persistence-changes/releases/README.md +103 -103
  26. package/kb/extra/persistence-changes/releases/README.zh.md +103 -103
  27. package/kb/extra/rescope.md +55 -55
  28. package/kb/extra/rescope.zh.md +55 -55
  29. package/kb/extra/subsystems/boot.md +631 -621
  30. package/kb/extra/subsystems/boot.zh.md +631 -621
  31. package/kb/extra/subsystems/computer-use.md +179 -137
  32. package/kb/extra/subsystems/computer-use.zh.md +179 -137
  33. package/kb/extra/subsystems/extensions.md +387 -384
  34. package/kb/extra/subsystems/extensions.zh.md +387 -384
  35. package/kb/extra/subsystems/feedback.md +418 -400
  36. package/kb/extra/subsystems/feedback.zh.md +418 -400
  37. package/kb/extra/subsystems/forge.md +2169 -1226
  38. package/kb/extra/subsystems/forge.zh.md +2171 -1226
  39. package/kb/extra/subsystems/liveshare.md +167 -158
  40. package/kb/extra/subsystems/liveshare.zh.md +167 -158
  41. package/kb/extra/subsystems/mcp.md +237 -234
  42. package/kb/extra/subsystems/mcp.zh.md +237 -234
  43. package/kb/extra/subsystems/office-kit.md +122 -0
  44. package/kb/extra/subsystems/office-kit.zh.md +122 -0
  45. package/kb/extra/subsystems/working-directory.md +95 -64
  46. package/kb/extra/subsystems/working-directory.zh.md +95 -64
  47. package/kb/extra/subsystems/worktrees.md +187 -127
  48. package/kb/extra/subsystems/worktrees.zh.md +187 -127
  49. package/kb/extra/upgrade-guide/v0.2.1-alpha.1/python-ptc-sandbox/guide.md +21 -21
  50. package/kb/extra/upgrade-guide/v0.2.1-alpha.1/python-ptc-sandbox/guide.zh.md +21 -21
  51. package/kb/extra/upgrade-guide/v0.2.1-rc.4/sandbox-unsupported-policy-error/guide.md +18 -0
  52. package/kb/extra/upgrade-guide/v0.2.1-rc.4/sandbox-unsupported-policy-error/guide.zh.md +18 -0
  53. package/kb/extra/upgrade-guide/v0.2.2-alpha.2/llm-error-builtin-codes/guide.md +18 -0
  54. package/kb/extra/upgrade-guide/v0.2.2-alpha.2/llm-error-builtin-codes/guide.zh.md +18 -0
  55. package/kb/extra/upgrade-guide/v0.2.2-alpha.3/office-kit-package/guide.md +34 -0
  56. package/kb/extra/upgrade-guide/v0.2.2-alpha.3/office-kit-package/guide.zh.md +34 -0
  57. package/kb/extra/upgrade-guide/v0.2.2-alpha.3/office-operation-tools/guide.md +49 -0
  58. package/kb/extra/upgrade-guide/v0.2.2-alpha.3/office-operation-tools/guide.zh.md +49 -0
  59. package/kb/extra/upgrade-guide/v0.2.2-alpha.3/office-skill-resources/guide.md +36 -0
  60. package/kb/extra/upgrade-guide/v0.2.2-alpha.3/office-skill-resources/guide.zh.md +36 -0
  61. package/kb/extra/upgrade-guide/v0.2.2-rc.1/account-notification-fields/guide.md +26 -0
  62. package/kb/extra/upgrade-guide/v0.2.2-rc.1/account-notification-fields/guide.zh.md +26 -0
  63. package/kb/extra/upgrade-guide/v0.2.2-rc.1/account-remote-provider/guide.md +22 -0
  64. package/kb/extra/upgrade-guide/v0.2.2-rc.1/account-remote-provider/guide.zh.md +22 -0
  65. package/kb/extra/upgrade-guide/v0.2.2-rc.1/archive-worktrees/guide.md +21 -0
  66. package/kb/extra/upgrade-guide/v0.2.2-rc.1/archive-worktrees/guide.zh.md +21 -0
  67. package/kb/extra/upgrade-guide/v0.2.2-rc.1/attachment-error-codes/guide.md +23 -0
  68. package/kb/extra/upgrade-guide/v0.2.2-rc.1/attachment-error-codes/guide.zh.md +23 -0
  69. package/kb/extra/upgrade-guide/v0.2.2-rc.1/cua-ax-read-limits/guide.md +20 -0
  70. package/kb/extra/upgrade-guide/v0.2.2-rc.1/cua-ax-read-limits/guide.zh.md +20 -0
  71. package/kb/extra/upgrade-guide/v0.2.2-rc.1/cua-hover-ax-only/guide.md +18 -0
  72. package/kb/extra/upgrade-guide/v0.2.2-rc.1/cua-hover-ax-only/guide.zh.md +18 -0
  73. package/kb/extra/upgrade-guide/v0.2.2-rc.1/cua-native-platform/guide.md +23 -0
  74. package/kb/extra/upgrade-guide/v0.2.2-rc.1/cua-native-platform/guide.zh.md +23 -0
  75. package/kb/extra/upgrade-guide/v0.2.2-rc.1/dsh-doc-skill/guide.md +35 -0
  76. package/kb/extra/upgrade-guide/v0.2.2-rc.1/dsh-doc-skill/guide.zh.md +35 -0
  77. package/kb/extra/upgrade-guide/v0.2.2-rc.1/forge-change-request-overview/guide.md +26 -0
  78. package/kb/extra/upgrade-guide/v0.2.2-rc.1/forge-change-request-overview/guide.zh.md +26 -0
  79. package/kb/extra/upgrade-guide/v0.2.2-rc.1/forge-pinned-diff/guide.md +26 -0
  80. package/kb/extra/upgrade-guide/v0.2.2-rc.1/forge-pinned-diff/guide.zh.md +26 -0
  81. package/kb/extra/upgrade-guide/v0.2.2-rc.1/forge-review-reads/guide.md +19 -0
  82. package/kb/extra/upgrade-guide/v0.2.2-rc.1/forge-review-reads/guide.zh.md +19 -0
  83. package/kb/extra/upgrade-guide/v0.2.2-rc.1/package-export-cleanup/guide.md +26 -0
  84. package/kb/extra/upgrade-guide/v0.2.2-rc.1/package-export-cleanup/guide.zh.md +26 -0
  85. package/kb/extra/upgrade-guide/v0.2.2-rc.1/plugin-update-method/guide.md +22 -0
  86. package/kb/extra/upgrade-guide/v0.2.2-rc.1/plugin-update-method/guide.zh.md +22 -0
  87. package/kb/extra/upgrade-guide/v0.2.2-rc.1/ptc-bootstrap-protocol/guide.md +25 -0
  88. package/kb/extra/upgrade-guide/v0.2.2-rc.1/ptc-bootstrap-protocol/guide.zh.md +25 -0
  89. package/kb/extra/upgrade-guide/v0.2.2-rc.1/ptc-inspect-output/guide.md +48 -0
  90. package/kb/extra/upgrade-guide/v0.2.2-rc.1/ptc-inspect-output/guide.zh.md +48 -0
  91. package/kb/extra/upgrade-guide/v0.2.2-rc.1/ptc-scoped-repl-default/guide.md +45 -0
  92. package/kb/extra/upgrade-guide/v0.2.2-rc.1/ptc-scoped-repl-default/guide.zh.md +45 -0
  93. package/kb/extra/upgrade-guide/v0.2.2-rc.1/runtime-context-reminders/guide.md +19 -0
  94. package/kb/extra/upgrade-guide/v0.2.2-rc.1/runtime-context-reminders/guide.zh.md +19 -0
  95. package/kb/extra/upgrade-guide/v0.2.2-rc.1/session-append-overloads/guide.md +17 -0
  96. package/kb/extra/upgrade-guide/v0.2.2-rc.1/session-append-overloads/guide.zh.md +17 -0
  97. package/kb/extra/upgrade-guide/v0.2.2-rc.1/subagent-interrupt-default/guide.md +27 -0
  98. package/kb/extra/upgrade-guide/v0.2.2-rc.1/subagent-interrupt-default/guide.zh.md +27 -0
  99. package/kb/extra/upgrade-guide/v0.2.2-rc.1/terminal-backend-cleanup-error/guide.md +20 -0
  100. package/kb/extra/upgrade-guide/v0.2.2-rc.1/terminal-backend-cleanup-error/guide.zh.md +20 -0
  101. package/kb/extra/upgrade-guide/v0.2.2-rc.1/terminal-bundle-sidebar-backend/guide.md +19 -0
  102. package/kb/extra/upgrade-guide/v0.2.2-rc.1/terminal-bundle-sidebar-backend/guide.zh.md +19 -0
  103. package/kb/extra/upgrade-guide/v0.2.2-rc.1/web-fetch-transport-error-codes/guide.md +18 -0
  104. package/kb/extra/upgrade-guide/v0.2.2-rc.1/web-fetch-transport-error-codes/guide.zh.md +18 -0
  105. package/kb/extra/upgrade-guide/v0.2.2-rc.1/web-search-billing/guide.md +41 -0
  106. package/kb/extra/upgrade-guide/v0.2.2-rc.1/web-search-billing/guide.zh.md +41 -0
  107. package/kb/extra/upgrade-guide/v0.2.2-rc.1/window-drag-regions/guide.md +21 -0
  108. package/kb/extra/upgrade-guide/v0.2.2-rc.1/window-drag-regions/guide.zh.md +21 -0
  109. package/kb/extra/upgrade-guide/v0.2.2-rc.2/client-module-metadata/guide.md +29 -0
  110. package/kb/extra/upgrade-guide/v0.2.2-rc.2/client-module-metadata/guide.zh.md +29 -0
  111. package/kb/extra/upgrade-guide/v0.2.2-rc.2/connection-page-peer/guide.md +25 -0
  112. package/kb/extra/upgrade-guide/v0.2.2-rc.2/connection-page-peer/guide.zh.md +25 -0
  113. package/kb/extra/upgrade-guide/v0.2.2-rc.2/cordis-root-and-intercept-metadata/guide.md +31 -0
  114. package/kb/extra/upgrade-guide/v0.2.2-rc.2/cordis-root-and-intercept-metadata/guide.zh.md +31 -0
  115. package/kb/extra/upgrade-guide/v0.2.2-rc.2/cua-agents-without-preset/guide.md +24 -0
  116. package/kb/extra/upgrade-guide/v0.2.2-rc.2/cua-agents-without-preset/guide.zh.md +24 -0
  117. package/kb/extra/upgrade-guide/v0.2.2-rc.2/cua-macos-provider/guide.md +24 -0
  118. package/kb/extra/upgrade-guide/v0.2.2-rc.2/cua-macos-provider/guide.zh.md +24 -0
  119. package/kb/extra/upgrade-guide/v0.2.2-rc.2/cua-partial-observations/guide.md +19 -0
  120. package/kb/extra/upgrade-guide/v0.2.2-rc.2/cua-partial-observations/guide.zh.md +19 -0
  121. package/kb/extra/upgrade-guide/v0.2.2-rc.2/deepseek-files-timeout/guide.md +15 -0
  122. package/kb/extra/upgrade-guide/v0.2.2-rc.2/deepseek-files-timeout/guide.zh.md +15 -0
  123. package/kb/extra/upgrade-guide/v0.2.2-rc.2/experimental-tool-error-codes/guide.md +28 -0
  124. package/kb/extra/upgrade-guide/v0.2.2-rc.2/experimental-tool-error-codes/guide.zh.md +28 -0
  125. package/kb/extra/upgrade-guide/v0.2.2-rc.2/package-export-cleanup/guide.md +36 -0
  126. package/kb/extra/upgrade-guide/v0.2.2-rc.2/package-export-cleanup/guide.zh.md +36 -0
  127. package/kb/extra/upgrade-guide/v0.2.2-rc.2/python-ptc-removal/guide.md +22 -0
  128. package/kb/extra/upgrade-guide/v0.2.2-rc.2/python-ptc-removal/guide.zh.md +22 -0
  129. package/kb/extra/upgrade-guide/v0.2.2-rc.2/session-status-package/guide.md +31 -0
  130. package/kb/extra/upgrade-guide/v0.2.2-rc.2/session-status-package/guide.zh.md +31 -0
  131. package/kb/extra/upgrade-guide/v0.2.2-rc.2/shared-search-filter/guide.md +18 -0
  132. package/kb/extra/upgrade-guide/v0.2.2-rc.2/shared-search-filter/guide.zh.md +18 -0
  133. package/kb/extra/upgrade-guide/v0.2.2-rc.2/shell-fs-tool-error-codes/guide.md +30 -0
  134. package/kb/extra/upgrade-guide/v0.2.2-rc.2/shell-fs-tool-error-codes/guide.zh.md +30 -0
  135. package/kb/extra/web-styling.md +57 -57
  136. package/kb/extra/web-styling.zh.md +57 -57
  137. package/kb/meta/search-index.json +4508 -3980
  138. package/kb/meta/source.json +18 -18
  139. package/kb/site/develop/practice/llm-adapter.md +192 -192
  140. package/kb/site/en/develop/practice/llm-adapter.md +192 -192
  141. package/kb/site/en/guide/desktop-uninstall-cleanup.md +63 -0
  142. package/kb/site/en/guide/plugin-market.md +153 -151
  143. package/kb/site/en/guide/providers.md +234 -234
  144. package/kb/site/en/guide/quickstart.md +35 -34
  145. package/kb/site/en/reference/capability-seams.md +789 -767
  146. package/kb/site/en/reference/config-catalog.md +5432 -5128
  147. package/kb/site/en/reference/cookbook/adding-a-package.md +175 -175
  148. package/kb/site/en/reference/cookbook/adding-a-tool.md +105 -104
  149. package/kb/site/en/reference/cookbook/extension-cookbook.md +178 -135
  150. package/kb/site/en/reference/cordis-api/context.md +373 -369
  151. package/kb/site/en/reference/cordis-api/fiber.md +457 -433
  152. package/kb/site/en/reference/cordis-api/inherited.md +44 -44
  153. package/kb/site/en/reference/cordis-api/service.md +118 -107
  154. package/kb/site/en/reference/experimental-persistence-catalog.md +36 -23
  155. package/kb/site/en/reference/index.md +174 -174
  156. package/kb/site/en/reference/persistence-catalog.md +9453 -9432
  157. package/kb/site/en/reference/subsystems/compaction.md +288 -288
  158. package/kb/site/en/reference/subsystems/core.md +1172 -1171
  159. package/kb/site/en/reference/subsystems/credentials.md +526 -497
  160. package/kb/site/en/reference/subsystems/filesystem.md +708 -708
  161. package/kb/site/en/reference/subsystems/index.md +82 -82
  162. package/kb/site/en/reference/subsystems/llm-streaming.md +1290 -1288
  163. package/kb/site/en/reference/subsystems/lsp.md +230 -206
  164. package/kb/site/en/reference/subsystems/persistence.md +451 -432
  165. package/kb/site/en/reference/subsystems/plan.md +91 -91
  166. package/kb/site/en/reference/subsystems/ptc-runtime.md +295 -261
  167. package/kb/site/en/reference/subsystems/sandbox.md +250 -232
  168. package/kb/site/en/reference/subsystems/session-query.md +525 -515
  169. package/kb/site/en/reference/subsystems/session-reference.md +231 -229
  170. package/kb/site/en/reference/subsystems/session.md +1478 -1431
  171. package/kb/site/en/reference/subsystems/sidebar-right.md +165 -165
  172. package/kb/site/en/reference/subsystems/skills.md +356 -356
  173. package/kb/site/en/reference/subsystems/slots.md +235 -231
  174. package/kb/site/en/reference/subsystems/terminal.md +188 -188
  175. package/kb/site/en/reference/subsystems/tools.md +902 -891
  176. package/kb/site/en/reference/subsystems/user-questions.md +330 -327
  177. package/kb/site/en/reference/subsystems/web-client.md +161 -104
  178. package/kb/site/en/reference/subsystems/web-server.md +434 -351
  179. package/kb/site/en/reference/subsystems/web.md +268 -268
  180. package/kb/site/en/reference/subsystems/workflow.md +287 -282
  181. package/kb/site/en/reference/subsystems/workspace.md +743 -651
  182. package/kb/site/en/reference/tool-catalog.md +2867 -2704
  183. package/kb/site/guide/desktop-uninstall-cleanup.md +63 -0
  184. package/kb/site/guide/plugin-market.md +153 -151
  185. package/kb/site/guide/providers.md +234 -234
  186. package/kb/site/guide/quickstart.md +35 -34
  187. package/kb/site/reference/capability-seams.md +789 -767
  188. package/kb/site/reference/config-catalog.md +5432 -5128
  189. package/kb/site/reference/cookbook/adding-a-package.md +175 -175
  190. package/kb/site/reference/cookbook/adding-a-tool.md +107 -106
  191. package/kb/site/reference/cookbook/extension-cookbook.md +182 -139
  192. package/kb/site/reference/cordis-api/context.md +373 -369
  193. package/kb/site/reference/cordis-api/fiber.md +459 -435
  194. package/kb/site/reference/cordis-api/inherited.md +44 -44
  195. package/kb/site/reference/cordis-api/service.md +118 -107
  196. package/kb/site/reference/experimental-persistence-catalog.md +36 -23
  197. package/kb/site/reference/index.md +178 -178
  198. package/kb/site/reference/persistence-catalog.md +9453 -9432
  199. package/kb/site/reference/subsystems/compaction.md +288 -288
  200. package/kb/site/reference/subsystems/core.md +1184 -1183
  201. package/kb/site/reference/subsystems/credentials.md +526 -497
  202. package/kb/site/reference/subsystems/filesystem.md +708 -708
  203. package/kb/site/reference/subsystems/index.md +82 -82
  204. package/kb/site/reference/subsystems/llm-streaming.md +1296 -1294
  205. package/kb/site/reference/subsystems/lsp.md +230 -206
  206. package/kb/site/reference/subsystems/persistence.md +451 -432
  207. package/kb/site/reference/subsystems/plan.md +91 -91
  208. package/kb/site/reference/subsystems/ptc-runtime.md +295 -261
  209. package/kb/site/reference/subsystems/sandbox.md +250 -232
  210. package/kb/site/reference/subsystems/session-query.md +525 -515
  211. package/kb/site/reference/subsystems/session-reference.md +231 -229
  212. package/kb/site/reference/subsystems/session.md +1482 -1435
  213. package/kb/site/reference/subsystems/sidebar-right.md +165 -165
  214. package/kb/site/reference/subsystems/skills.md +356 -356
  215. package/kb/site/reference/subsystems/slots.md +239 -235
  216. package/kb/site/reference/subsystems/terminal.md +188 -188
  217. package/kb/site/reference/subsystems/tools.md +902 -891
  218. package/kb/site/reference/subsystems/user-questions.md +330 -327
  219. package/kb/site/reference/subsystems/web-client.md +161 -104
  220. package/kb/site/reference/subsystems/web-server.md +434 -351
  221. package/kb/site/reference/subsystems/web.md +268 -268
  222. package/kb/site/reference/subsystems/workflow.md +287 -282
  223. package/kb/site/reference/subsystems/workspace.md +743 -651
  224. package/kb/site/reference/tool-catalog.md +2872 -2709
  225. package/lib/index.js +359 -359
  226. package/package.json +68 -68
  227. package/skills/dsh-plugin-dev-kb.md +71 -70
  228. package/kb/extra/subsystems/office-to-pdf.md +0 -87
  229. package/kb/extra/subsystems/office-to-pdf.zh.md +0 -87
package/README.md CHANGED
@@ -1,183 +1,183 @@
1
- <p align="center">
2
- <img src="docs/banner.svg" alt="dsh-plugin-dev-kb banner" width="100%">
3
- </p>
4
-
5
- # dsh-plugin-dev-kb
6
-
7
- ![npm version](https://img.shields.io/npm/v/dsh-plugin-dev-kb)
8
- ![npm downloads](https://img.shields.io/npm/dm/dsh-plugin-dev-kb)
9
- ![License](https://img.shields.io/github/license/Pasumao/dsh-plugin-dev-kb)
10
- ![Stars](https://img.shields.io/github/stars/Pasumao/dsh-plugin-dev-kb?style=social)
11
- ![AI Assisted](https://img.shields.io/badge/AI-Assisted-8A2BE2)
12
- ![kb sync](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2FPasumao%2Fdsh-plugin-dev-kb%2Fmaster%2Fkb%2Fmeta%2Fsource.json)
13
-
14
- [**中文**](./README.md) | [English](./README.en.md)
15
-
16
- > **192 页官方镜像 · 468 篇独占补充文档 · 每周自动同步上游 · 0 运行时依赖**
17
-
18
- **写 dsh 插件时的随身辅助**:① 把 DeepSeek Harness 官方文档站点
19
- <https://deepseek-harness.github.io/deepseek-harness/> 的全部内容整理为 dsh 原生可用的形态——
20
- 装了这个插件,agent 写插件时自动加载知识库,按任务场景定位文档,不用再翻网页;
21
- ② 附带 `dsh-dev-sandbox` 技能:自建独立沙箱 profile 开发沙箱工作流(沙箱名由 agent 按任务自定),
22
- 开发中的插件隔离运行,agent 自主启动 / 重启 / 冒烟验证,插件崩了不影响主力 dsh;
23
- ③ `dsh_kb_search` 工具(1.6.0 起):知识库本地打分检索,一次调用返回命中文件 + 行号 + 上下文片段;
24
- ④ `dsh-upgrade-assistant` 技能(1.7.0 起):升级 dsh 版本时,agent 自动读官方升级指南与持久化变更记录,
25
- 生成迁移检查清单、预判插件兼容闸门与回滚方案;
26
- ⑤ 版本感知横幅 + `dsh_kb_read` 工具(1.8.0 起):工具输出自动标注「知识库快照 vs 宿主 dsh 版本」差异
27
- 并给出对应升级指南;按路径 + 行号窗口局部阅读原文,防大文件整读、自动提示中英对照;
28
- ⑥ `dsh-plugin-starter` 技能(1.8.0 起):从零新建合规 dsh 插件的脚手架指南(骨架清单 / 收录门槛 / 验证闭环)。
29
-
30
- ## 这是什么
31
-
32
- - **站点完整镜像**:官方文档(VitePress)由仓库 `deepseek-ai/deepseek-harness` 的 `docs/` 原始 Markdown
33
- 投影生成(链接已按站点路由重写,与线上逐字一致)。中英双语共 192 页。
34
- - **补充文档**:仓库 `docs/` 中未发布到站点的 468 篇开发参考(术语表、防御模式、模块图、测试策略、事故复盘、i18n 规范、升级指南、持久化变更等)——这部分是**官方仓库独占内容,线上站点看不到**。
35
- - **agent 友好**:`skills/dsh-plugin-dev-kb.md` 技能让 dsh 在插件开发任务中自动加载,获知知识库位置、
36
- 主题导航与检索策略;`kb/meta/topics.md` 按任务场景映射要读的文件;`kb/meta/search-index.json` 提供全量检索。
37
- - **开发沙箱**:`skills/dsh-dev-sandbox.md` 技能提供自建独立沙箱 profile 工作流(沙箱名 agent 按任务
38
- 自定,不与主力 profile 重名)——初始化(兼容闸门 / link: 挂载)、后台启动(自选空闲端口)、自主重启、headless 冒烟验证,
39
- 全程 agent 闭环,不要求用户重启。
40
- - **本地检索工具**:`dsh_kb_search` 工具在知识库上做打分检索(标题 / 路径 / 正文多词加权),
41
- 一次调用返回命中文件路径、行号与上下文片段;支持 `scope: api`(只搜 API 签名/目录类文档)、
42
- `lang: en`、空 query 返回主题导航。索引惰性构建于内存(约 60ms / 314 文件),只读不写。
43
- - **版本感知(1.8.0 起)**:工具输出自带横幅——宿主 dsh 版本 vs 知识库 master 快照可能存在的
44
- API 差异,并给出对应的 `extra/upgrade-guide/<vX.Y.Z>` 指南路径;探测失败自动降级(无横幅不报错)。
45
- - **局部阅读工具(1.8.0 起)**:`dsh_kb_read` 按 `path`/`offset`/`limit` 行号窗口读原文,
46
- 带行号输出、防大文件整读、拒绝越界路径,自动提示中英对照路径与续读位置。
47
-
48
- ## 功能
49
-
50
- - **官方文档完整镜像**:deepseek-ai/deepseek-harness 官方文档站全部内容整理为 dsh 原生可用的形态,
51
- 中英双语共 192 页,链接按站点路由重写,与线上逐字一致;
52
- - **仓库补充文档**:未发布到站点的 468 篇开发参考(术语表、防御模式、模块图、测试策略、事故复盘、i18n 规范、升级指南、持久化变更等);
53
- - **每周自动同步**:GitHub Action 定时从上游 master 刷新(见顶部「kb sync」badge 可查同步日期与 commit);
54
- - **agent 友好**:`dsh-plugin-dev-kb` 技能让 dsh 在插件开发任务中自动加载知识库;
55
- `dsh_kb_search` 工具一次调用完成检索定位;`kb/meta/topics.md` 按任务场景映射要读的文件,`kb/meta/search-index.json` 提供全量检索;
56
- - **人侧可用**:直接浏览 `kb/` 目录,或打开 `kb/INDEX.md` 按 URL 对照查阅;
57
- - 零运行时依赖;两个工具(`dsh_kb_search` / `dsh_kb_read`)为纯 Node 本地实现(不联网、不写文件)。
58
-
59
- ## 30 秒验证装好了
60
-
61
- 安装挂载后,随便开个会话问 agent:
62
-
63
- > dsh 0.2.0 的设置子系统(SettingsForms)和以前有什么不一样?
64
-
65
- - agent 用 `dsh_kb_search` 检索并答出 `SettingsForms` / `.volatile()` / 修订号冲突检测等细节 = **装好了**;
66
- - 答不上来或检索工具不存在 = 挂载没生效,回看「安装 / 挂载」一步。
67
-
68
- ## 配置
69
-
70
- 默认零配置,安装即用:
71
-
72
- - 不读取环境变量,不需要 API Key / token,不写配置文件;
73
- - 挂载后 `skills/dsh-plugin-dev-kb.md` 技能在会话启动时进入可用技能列表,自动生效;
74
- - `dsh_kb_search` 工具随宿主启动注册,首次调用时构建索引(毫秒级);如需关闭,
75
- 在 profile 的插件配置里设 `searchTool: false`(只保留技能,不注册工具);
76
- - 知识库更新走 `npm run rebuild-index`(见「更新知识库」)。
77
-
78
- ## 安装 / 挂载
79
-
80
- ```powershell
81
- # npm(推荐)
82
- dsh plugin --profile web add dsh-plugin-dev-kb
83
- # 或 GitHub
84
- dsh plugin --profile web add github:Pasumao/dsh-plugin-dev-kb
85
- ```
86
-
87
- 源码安装(本地开发 / 调试):
88
-
89
- ```bash
90
- git clone https://github.com/Pasumao/dsh-plugin-dev-kb.git
91
- cd dsh-plugin-dev-kb
92
- npm install
93
- # 以 link: 方式挂载进 profile
94
- ```
95
-
96
- 本插件是「纯数据 + 技能」插件,不自带 bundle 自动挂载,装完后在 profile 的
97
- `cordis.patch.yml` 末尾加一行手动挂载(**唯一的一次性步骤,复制即用**;
98
- 挂载为 profile 根层插件行,其 `skills/` 技能进入全局层):
99
-
100
- ```yaml
101
- - insert:
102
- - id: dsh-plugin-dev-kb
103
- name: dsh-plugin-dev-kb
104
- ```
105
-
106
- > 重新启动 / 新建 dsh 会话后,`dsh-plugin-dev-kb` 技能才会出现在可用技能列表中(技能清单在会话启动时快照)。
107
-
108
- ## 5 分钟验证
109
-
110
- 重启后开一个新会话,直接问:
111
-
112
- > 帮我写一个最小的 dsh 插件
113
-
114
- agent 会自动加载 `dsh-plugin-dev-kb` 技能(技能清单里可见),调用 `dsh_kb_search`
115
- (或读 `kb/meta/topics.md`)定位文档后再动手——看到它引用 `kb/site/...` 路径即验证通过。
116
-
117
- ## 目录结构
118
-
119
- ```
120
- dsh-plugin-dev-kb/
121
- ├── cordis.patch.yml 挂载声明
122
- ├── package.json 插件元数据
123
- ├── skills/
124
- │ └── dsh-plugin-dev-kb.md ★ 知识库使用指南(agent 加载此技能)
125
- ├── kb/
126
- │ ├── site/ 站点镜像:guide/ develop/ reference/(+ en/ 英文站)
127
- │ ├── extra/ 仓库补充文档:glossary、defensive-patterns、module-graph、upgrade-guide/、persistence-changes/、postmortem/、i18n/ …
128
- │ ├── meta/
129
- │ │ ├── topics.md ★ 主题导航:任务场景 → 文件
130
- │ │ ├── search-index.json 全量索引(373 文件)
131
- │ │ ├── source.json 来源 commit / 时间 / 统计
132
- │ │ └── site-pages.txt 线上页面清单
133
- │ ├── INDEX.md 站点 URL ↔ 本地文件 对照
134
- │ └── README.md 知识库总览与更新方法
135
- └── LICENSE
136
- ```
137
-
138
- ## 使用
139
-
140
- - **agent 侧**:写插件 / Tool / 配置 / 服务 / 事件 / 打包 / LLM 适配器时,加载
141
- `dsh-plugin-dev-kb` 技能 → 首选调 `dsh_kb_search` 工具检索(一次拿命中文件 + 行号 + 片段,
142
- `scope: api` 查 `ctx.*` API 签名)→ 用 read 按行号局部读原文;工具不可用时退回
143
- grep `kb/` 兜底。
144
- - **人侧**:直接浏览 `kb/` 目录,或打开 `kb/INDEX.md` 按 URL 对照查阅。
145
-
146
- ## 自检
147
-
148
- 发布前跑结构自检(离线、零依赖):
149
-
150
- ```powershell
151
- npm run selfcheck # 结构完整 + 入口 / bundle patch 存在性
152
- ```
153
-
154
- ## 更新知识库
155
-
156
- 见 `kb/README.md`:重新克隆 `deepseek-ai/deepseek-harness`(master 分支),安装投影依赖后
157
- 在仓库内调用 `scripts/project-doc-site.ts` 的 `projectDocs()` 生成 `website/.generated/`,
158
- 覆盖本插件的 `kb/site/`(并按发布清单同步 `kb/extra/`),再在本插件根目录运行
159
- `node scripts/rebuild-index.mjs` 重建索引与 INDEX.md。
160
-
161
- ## 相关插件
162
-
163
- 本插件属于 **Pasumao 的 dsh 插件生态**,同系列已发布插件可搭配使用:
164
-
165
- | 插件(npm) | GitHub | 说明 |
166
- |---|---|---|
167
- | [dsh-notify](https://www.npmjs.com/package/dsh-notify) | [GitHub 仓库](https://github.com/Pasumao/dsh-plugin-notify) | Windows 原生通知 |
168
- | [dsh-plugin-choice-refresh](https://www.npmjs.com/package/dsh-plugin-choice-refresh) | [GitHub 仓库](https://github.com/Pasumao/dsh-plugin-choice-refresh) | 选择增强:重新生成选项 / 更多选项 |
169
- | [dsh-plugin-image-tools](https://www.npmjs.com/package/dsh-plugin-image-tools) | [GitHub 仓库](https://github.com/Pasumao/dsh-plugin-image-tools) | 图片选择卡 + 回复内嵌图片 + 盲模型收图 |
170
- | [dsh-plugin-table-zoom](https://www.npmjs.com/package/dsh-plugin-table-zoom) | [GitHub 仓库](https://github.com/Pasumao/dsh-plugin-table-zoom) | 聊天长表格浮窗查看 + 一键复制 Markdown |
171
- | [dsh-plugin-windows-guard](https://www.npmjs.com/package/dsh-plugin-windows-guard) | [GitHub 仓库](https://github.com/Pasumao/dsh-plugin-windows-guard) | Windows 环境防坑:守则技能 + 乱码检测 / 危险写拦截 / 编码诊断修复 |
172
- | [dsh-plugin-context-trim](https://www.npmjs.com/package/dsh-plugin-context-trim) | [GitHub 仓库](https://github.com/Pasumao/dsh-plugin-context-trim) | 会话注入门控:skill / tool / 提示词段落按会话裁剪 |
173
- | [dsh-plugin-future-session](https://www.npmjs.com/package/dsh-plugin-future-session) | [GitHub 仓库](https://github.com/Pasumao/dsh-plugin-future-session) | 现实/未来会话:工具调用由继承全部上下文的未来会话代执行,主上下文只保留「一次调用+一份结论」 |
174
- > 本系列其余插件见 [Pasumao · dsh 插件](https://github.com/Pasumao);觉得好用欢迎到 GitHub 点 ⭐。
175
-
176
- ## AI 生成声明
177
-
178
- 知识库内容为官方文档的镜像整理(来源标注于 `kb/meta/source.json`),索引与
179
- 导航由 AI 辅助生成(DeepSeek Harness),均经人工核对。
180
-
181
- ## License
182
-
183
- [MIT](./LICENSE)
1
+ <p align="center">
2
+ <img src="docs/banner.svg" alt="dsh-plugin-dev-kb banner" width="100%">
3
+ </p>
4
+
5
+ # dsh-plugin-dev-kb
6
+
7
+ ![npm version](https://img.shields.io/npm/v/dsh-plugin-dev-kb)
8
+ ![npm downloads](https://img.shields.io/npm/dm/dsh-plugin-dev-kb)
9
+ ![License](https://img.shields.io/github/license/Pasumao/dsh-plugin-dev-kb)
10
+ ![Stars](https://img.shields.io/github/stars/Pasumao/dsh-plugin-dev-kb?style=social)
11
+ ![AI Assisted](https://img.shields.io/badge/AI-Assisted-8A2BE2)
12
+ ![kb sync](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2FPasumao%2Fdsh-plugin-dev-kb%2Fmaster%2Fkb%2Fmeta%2Fsource.json)
13
+
14
+ [**中文**](./README.md) | [English](./README.en.md)
15
+
16
+ > **194 页官方镜像 · 554 篇独占补充文档 · 每周自动同步上游 · 0 运行时依赖**
17
+
18
+ **写 dsh 插件时的随身辅助**:① 把 DeepSeek Harness 官方文档站点
19
+ <https://deepseek-harness.github.io/deepseek-harness/> 的全部内容整理为 dsh 原生可用的形态——
20
+ 装了这个插件,agent 写插件时自动加载知识库,按任务场景定位文档,不用再翻网页;
21
+ ② 附带 `dsh-dev-sandbox` 技能:自建独立沙箱 profile 开发沙箱工作流(沙箱名由 agent 按任务自定),
22
+ 开发中的插件隔离运行,agent 自主启动 / 重启 / 冒烟验证,插件崩了不影响主力 dsh;
23
+ ③ `dsh_kb_search` 工具(1.6.0 起):知识库本地打分检索,一次调用返回命中文件 + 行号 + 上下文片段;
24
+ ④ `dsh-upgrade-assistant` 技能(1.7.0 起):升级 dsh 版本时,agent 自动读官方升级指南与持久化变更记录,
25
+ 生成迁移检查清单、预判插件兼容闸门与回滚方案;
26
+ ⑤ 版本感知横幅 + `dsh_kb_read` 工具(1.8.0 起):工具输出自动标注「知识库快照 vs 宿主 dsh 版本」差异
27
+ 并给出对应升级指南;按路径 + 行号窗口局部阅读原文,防大文件整读、自动提示中英对照;
28
+ ⑥ `dsh-plugin-starter` 技能(1.8.0 起):从零新建合规 dsh 插件的脚手架指南(骨架清单 / 收录门槛 / 验证闭环)。
29
+
30
+ ## 这是什么
31
+
32
+ - **站点完整镜像**:官方文档(VitePress)由仓库 `deepseek-ai/deepseek-harness` 的 `docs/` 原始 Markdown
33
+ 投影生成(链接已按站点路由重写,与线上逐字一致)。中英双语共 194 页。
34
+ - **补充文档**:仓库 `docs/` 中未发布到站点的 554 篇开发参考(术语表、防御模式、模块图、测试策略、事故复盘、i18n 规范、升级指南、持久化变更等)——这部分是**官方仓库独占内容,线上站点看不到**。
35
+ - **agent 友好**:`skills/dsh-plugin-dev-kb.md` 技能让 dsh 在插件开发任务中自动加载,获知知识库位置、
36
+ 主题导航与检索策略;`kb/meta/topics.md` 按任务场景映射要读的文件;`kb/meta/search-index.json` 提供全量检索。
37
+ - **开发沙箱**:`skills/dsh-dev-sandbox.md` 技能提供自建独立沙箱 profile 工作流(沙箱名 agent 按任务
38
+ 自定,不与主力 profile 重名)——初始化(兼容闸门 / link: 挂载)、后台启动(自选空闲端口)、自主重启、headless 冒烟验证,
39
+ 全程 agent 闭环,不要求用户重启。
40
+ - **本地检索工具**:`dsh_kb_search` 工具在知识库上做打分检索(标题 / 路径 / 正文多词加权),
41
+ 一次调用返回命中文件路径、行号与上下文片段;支持 `scope: api`(只搜 API 签名/目录类文档)、
42
+ `lang: en`、空 query 返回主题导航。索引惰性构建于内存(约 60ms / 314 文件),只读不写。
43
+ - **版本感知(1.8.0 起)**:工具输出自带横幅——宿主 dsh 版本 vs 知识库 master 快照可能存在的
44
+ API 差异,并给出对应的 `extra/upgrade-guide/<vX.Y.Z>` 指南路径;探测失败自动降级(无横幅不报错)。
45
+ - **局部阅读工具(1.8.0 起)**:`dsh_kb_read` 按 `path`/`offset`/`limit` 行号窗口读原文,
46
+ 带行号输出、防大文件整读、拒绝越界路径,自动提示中英对照路径与续读位置。
47
+
48
+ ## 功能
49
+
50
+ - **官方文档完整镜像**:deepseek-ai/deepseek-harness 官方文档站全部内容整理为 dsh 原生可用的形态,
51
+ 中英双语共 194 页,链接按站点路由重写,与线上逐字一致;
52
+ - **仓库补充文档**:未发布到站点的 554 篇开发参考(术语表、防御模式、模块图、测试策略、事故复盘、i18n 规范、升级指南、持久化变更等);
53
+ - **每周自动同步**:GitHub Action 定时从上游 master 刷新(见顶部「kb sync」badge 可查同步日期与 commit);
54
+ - **agent 友好**:`dsh-plugin-dev-kb` 技能让 dsh 在插件开发任务中自动加载知识库;
55
+ `dsh_kb_search` 工具一次调用完成检索定位;`kb/meta/topics.md` 按任务场景映射要读的文件,`kb/meta/search-index.json` 提供全量检索;
56
+ - **人侧可用**:直接浏览 `kb/` 目录,或打开 `kb/INDEX.md` 按 URL 对照查阅;
57
+ - 零运行时依赖;两个工具(`dsh_kb_search` / `dsh_kb_read`)为纯 Node 本地实现(不联网、不写文件)。
58
+
59
+ ## 30 秒验证装好了
60
+
61
+ 安装挂载后,随便开个会话问 agent:
62
+
63
+ > dsh 0.2.0 的设置子系统(SettingsForms)和以前有什么不一样?
64
+
65
+ - agent 用 `dsh_kb_search` 检索并答出 `SettingsForms` / `.volatile()` / 修订号冲突检测等细节 = **装好了**;
66
+ - 答不上来或检索工具不存在 = 挂载没生效,回看「安装 / 挂载」一步。
67
+
68
+ ## 配置
69
+
70
+ 默认零配置,安装即用:
71
+
72
+ - 不读取环境变量,不需要 API Key / token,不写配置文件;
73
+ - 挂载后 `skills/dsh-plugin-dev-kb.md` 技能在会话启动时进入可用技能列表,自动生效;
74
+ - `dsh_kb_search` 工具随宿主启动注册,首次调用时构建索引(毫秒级);如需关闭,
75
+ 在 profile 的插件配置里设 `searchTool: false`(只保留技能,不注册工具);
76
+ - 知识库更新走 `npm run rebuild-index`(见「更新知识库」)。
77
+
78
+ ## 安装 / 挂载
79
+
80
+ ```powershell
81
+ # npm(推荐)
82
+ dsh plugin --profile web add dsh-plugin-dev-kb
83
+ # 或 GitHub
84
+ dsh plugin --profile web add github:Pasumao/dsh-plugin-dev-kb
85
+ ```
86
+
87
+ 源码安装(本地开发 / 调试):
88
+
89
+ ```bash
90
+ git clone https://github.com/Pasumao/dsh-plugin-dev-kb.git
91
+ cd dsh-plugin-dev-kb
92
+ npm install
93
+ # 以 link: 方式挂载进 profile
94
+ ```
95
+
96
+ 本插件是「纯数据 + 技能」插件,不自带 bundle 自动挂载,装完后在 profile 的
97
+ `cordis.patch.yml` 末尾加一行手动挂载(**唯一的一次性步骤,复制即用**;
98
+ 挂载为 profile 根层插件行,其 `skills/` 技能进入全局层):
99
+
100
+ ```yaml
101
+ - insert:
102
+ - id: dsh-plugin-dev-kb
103
+ name: dsh-plugin-dev-kb
104
+ ```
105
+
106
+ > 重新启动 / 新建 dsh 会话后,`dsh-plugin-dev-kb` 技能才会出现在可用技能列表中(技能清单在会话启动时快照)。
107
+
108
+ ## 5 分钟验证
109
+
110
+ 重启后开一个新会话,直接问:
111
+
112
+ > 帮我写一个最小的 dsh 插件
113
+
114
+ agent 会自动加载 `dsh-plugin-dev-kb` 技能(技能清单里可见),调用 `dsh_kb_search`
115
+ (或读 `kb/meta/topics.md`)定位文档后再动手——看到它引用 `kb/site/...` 路径即验证通过。
116
+
117
+ ## 目录结构
118
+
119
+ ```
120
+ dsh-plugin-dev-kb/
121
+ ├── cordis.patch.yml 挂载声明
122
+ ├── package.json 插件元数据
123
+ ├── skills/
124
+ │ └── dsh-plugin-dev-kb.md ★ 知识库使用指南(agent 加载此技能)
125
+ ├── kb/
126
+ │ ├── site/ 站点镜像:guide/ develop/ reference/(+ en/ 英文站)
127
+ │ ├── extra/ 仓库补充文档:glossary、defensive-patterns、module-graph、upgrade-guide/、persistence-changes/、postmortem/、i18n/ …
128
+ │ ├── meta/
129
+ │ │ ├── topics.md ★ 主题导航:任务场景 → 文件
130
+ │ │ ├── search-index.json 全量索引(751 文件)
131
+ │ │ ├── source.json 来源 commit / 时间 / 统计
132
+ │ │ └── site-pages.txt 线上页面清单
133
+ │ ├── INDEX.md 站点 URL ↔ 本地文件 对照
134
+ │ └── README.md 知识库总览与更新方法
135
+ └── LICENSE
136
+ ```
137
+
138
+ ## 使用
139
+
140
+ - **agent 侧**:写插件 / Tool / 配置 / 服务 / 事件 / 打包 / LLM 适配器时,加载
141
+ `dsh-plugin-dev-kb` 技能 → 首选调 `dsh_kb_search` 工具检索(一次拿命中文件 + 行号 + 片段,
142
+ `scope: api` 查 `ctx.*` API 签名)→ 用 read 按行号局部读原文;工具不可用时退回
143
+ grep `kb/` 兜底。
144
+ - **人侧**:直接浏览 `kb/` 目录,或打开 `kb/INDEX.md` 按 URL 对照查阅。
145
+
146
+ ## 自检
147
+
148
+ 发布前跑结构自检(离线、零依赖):
149
+
150
+ ```powershell
151
+ npm run selfcheck # 结构完整 + 入口 / bundle patch 存在性
152
+ ```
153
+
154
+ ## 更新知识库
155
+
156
+ 见 `kb/README.md`:重新克隆 `deepseek-ai/deepseek-harness`(master 分支),安装投影依赖后
157
+ 在仓库内调用 `scripts/project-doc-site.ts` 的 `projectDocs()` 生成 `website/.generated/`,
158
+ 覆盖本插件的 `kb/site/`(并按发布清单同步 `kb/extra/`),再在本插件根目录运行
159
+ `node scripts/rebuild-index.mjs` 重建索引与 INDEX.md。
160
+
161
+ ## 相关插件
162
+
163
+ 本插件属于 **Pasumao 的 dsh 插件生态**,同系列已发布插件可搭配使用:
164
+
165
+ | 插件(npm) | GitHub | 说明 |
166
+ |---|---|---|
167
+ | [dsh-notify](https://www.npmjs.com/package/dsh-notify) | [GitHub 仓库](https://github.com/Pasumao/dsh-plugin-notify) | Windows 原生通知 |
168
+ | [dsh-plugin-choice-refresh](https://www.npmjs.com/package/dsh-plugin-choice-refresh) | [GitHub 仓库](https://github.com/Pasumao/dsh-plugin-choice-refresh) | 选择增强:重新生成选项 / 更多选项 |
169
+ | [dsh-plugin-image-tools](https://www.npmjs.com/package/dsh-plugin-image-tools) | [GitHub 仓库](https://github.com/Pasumao/dsh-plugin-image-tools) | 图片选择卡 + 回复内嵌图片 + 盲模型收图 |
170
+ | [dsh-plugin-table-zoom](https://www.npmjs.com/package/dsh-plugin-table-zoom) | [GitHub 仓库](https://github.com/Pasumao/dsh-plugin-table-zoom) | 聊天长表格浮窗查看 + 一键复制 Markdown |
171
+ | [dsh-plugin-windows-guard](https://www.npmjs.com/package/dsh-plugin-windows-guard) | [GitHub 仓库](https://github.com/Pasumao/dsh-plugin-windows-guard) | Windows 环境防坑:守则技能 + 乱码检测 / 危险写拦截 / 编码诊断修复 |
172
+ | [dsh-plugin-context-trim](https://www.npmjs.com/package/dsh-plugin-context-trim) | [GitHub 仓库](https://github.com/Pasumao/dsh-plugin-context-trim) | 会话注入门控:skill / tool / 提示词段落按会话裁剪 |
173
+ | [dsh-plugin-future-session](https://www.npmjs.com/package/dsh-plugin-future-session) | [GitHub 仓库](https://github.com/Pasumao/dsh-plugin-future-session) | 现实/未来会话:工具调用由继承全部上下文的未来会话代执行,主上下文只保留「一次调用+一份结论」 |
174
+ > 本系列其余插件见 [Pasumao · dsh 插件](https://github.com/Pasumao);觉得好用欢迎到 GitHub 点 ⭐。
175
+
176
+ ## AI 生成声明
177
+
178
+ 知识库内容为官方文档的镜像整理(来源标注于 `kb/meta/source.json`),索引与
179
+ 导航由 AI 辅助生成(DeepSeek Harness),均经人工核对。
180
+
181
+ ## License
182
+
183
+ [MIT](./LICENSE)