dsh-mnemon 0.1.4 → 0.1.6

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 (215) hide show
  1. package/README.md +19 -5
  2. package/README.zh-CN.md +19 -5
  3. package/cordis.patch.yml +3 -2
  4. package/lib/client.js +380 -348
  5. package/lib/index.js +203 -82
  6. package/lib/types/activity.d.ts +2 -18
  7. package/lib/types/channels.d.ts +1 -4
  8. package/lib/types/client/MnemonLogo.d.ts +0 -1
  9. package/lib/types/client/MnemonPackSection.d.ts +1 -2
  10. package/lib/types/client/MnemonSaveAction.d.ts +1 -2
  11. package/lib/types/client/MnemonSettingsCard.d.ts +1 -3
  12. package/lib/types/client/MnemonTurnTail.d.ts +1 -2
  13. package/lib/types/client/MnemonView.d.ts +1 -3
  14. package/lib/types/client/MnemonViewAppearance.d.ts +0 -1
  15. package/lib/types/client/anchor.d.ts +0 -1
  16. package/lib/types/client/api.d.ts +1 -9
  17. package/lib/types/client/dsh-compat.d.ts +0 -1
  18. package/lib/types/client/index.d.ts +0 -1
  19. package/lib/types/client/locales.d.ts +14 -1
  20. package/lib/types/client/settings.d.ts +1 -2
  21. package/lib/types/client/sidebar-entry.d.ts +0 -1
  22. package/lib/types/client/workspace-controller.d.ts +0 -1
  23. package/lib/types/client/workspace-mount.d.ts +1 -3
  24. package/lib/types/commands.d.ts +0 -1
  25. package/lib/types/config-values.d.ts +0 -1
  26. package/lib/types/config.d.ts +6 -80
  27. package/lib/types/contracts.d.ts +2 -60
  28. package/lib/types/documents.d.ts +2 -79
  29. package/lib/types/guidance.d.ts +0 -1
  30. package/lib/types/index.d.ts +0 -1
  31. package/lib/types/lifecycle.d.ts +3 -45
  32. package/lib/types/live-runtime.d.ts +0 -1
  33. package/lib/types/memory-bodies.d.ts +3 -20
  34. package/lib/types/pack.d.ts +2 -48
  35. package/lib/types/process.d.ts +0 -1
  36. package/lib/types/review-activity.d.ts +2 -16
  37. package/lib/types/rpc.d.ts +0 -1
  38. package/lib/types/runner.d.ts +22 -12
  39. package/lib/types/runtime-memory.d.ts +2 -59
  40. package/lib/types/service.d.ts +3 -149
  41. package/lib/types/settings.d.ts +1 -4
  42. package/lib/types/shared/contracts.d.ts +609 -0
  43. package/lib/types/storage-scope.d.ts +2 -29
  44. package/lib/types/subagent.d.ts +2 -15
  45. package/lib/types/tools.d.ts +0 -1
  46. package/lib/types/version-updates.d.ts +2 -26
  47. package/package.json +8 -7
  48. package/docs/README.md +0 -8
  49. package/docs/assets/diagrams/en/memory-system-flow.png +0 -0
  50. package/docs/assets/diagrams/en/project-architecture.svg +0 -182
  51. package/docs/assets/diagrams/zh-CN/memory-system-flow.png +0 -0
  52. package/docs/assets/diagrams/zh-CN/project-architecture.svg +0 -182
  53. package/docs/assets/media/dsh-mnemon-memory-system-demo-poster.jpg +0 -0
  54. package/docs/assets/media/dsh-mnemon-memory-system-demo.gif +0 -0
  55. package/docs/assets/media/dsh-mnemon-memory-system-demo.mp4 +0 -0
  56. package/docs/assets/screenshots/conversation-memory-jump.png +0 -0
  57. package/docs/assets/screenshots/conversation-save-dialog.png +0 -0
  58. package/docs/assets/screenshots/conversation-turn-memory.png +0 -0
  59. package/docs/assets/screenshots/document-create-dialog.png +0 -0
  60. package/docs/assets/screenshots/documents-markdown.png +0 -0
  61. package/docs/assets/screenshots/entities-context.png +0 -0
  62. package/docs/assets/screenshots/memory-content.png +0 -0
  63. package/docs/assets/screenshots/overview-memory-graph.png +0 -0
  64. package/docs/assets/screenshots/recall-agent-answer.png +0 -0
  65. package/docs/assets/screenshots/remember-dialog.png +0 -0
  66. package/docs/assets/screenshots/runtime-memory-add.png +0 -0
  67. package/docs/assets/screenshots/runtime-memory.png +0 -0
  68. package/docs/assets/screenshots/settings-memory-system.png +0 -0
  69. package/docs/assets/screenshots/status-overview.png +0 -0
  70. package/docs/assets/screenshots/version-check.png +0 -0
  71. package/docs/en/README.md +0 -48
  72. package/docs/en/architecture.md +0 -133
  73. package/docs/en/configuration.md +0 -223
  74. package/docs/en/development.md +0 -198
  75. package/docs/en/getting-started.md +0 -155
  76. package/docs/en/interfaces.md +0 -181
  77. package/docs/en/operations.md +0 -166
  78. package/docs/en/project-overview.md +0 -145
  79. package/docs/en/roadmap.md +0 -41
  80. package/docs/en/storage-model.md +0 -185
  81. package/docs/en/ui-guide.md +0 -156
  82. package/docs/en/workflows.md +0 -290
  83. package/docs/zh-CN/README.md +0 -48
  84. package/docs/zh-CN/architecture.md +0 -133
  85. package/docs/zh-CN/configuration.md +0 -223
  86. package/docs/zh-CN/development.md +0 -198
  87. package/docs/zh-CN/getting-started.md +0 -155
  88. package/docs/zh-CN/interfaces.md +0 -181
  89. package/docs/zh-CN/operations.md +0 -166
  90. package/docs/zh-CN/project-overview.md +0 -145
  91. package/docs/zh-CN/roadmap.md +0 -41
  92. package/docs/zh-CN/storage-model.md +0 -185
  93. package/docs/zh-CN/ui-guide.md +0 -160
  94. package/docs/zh-CN/workflows.md +0 -290
  95. package/lib/client.js.map +0 -1
  96. package/lib/types/activity.d.ts.map +0 -1
  97. package/lib/types/activity.js +0 -93
  98. package/lib/types/activity.js.map +0 -1
  99. package/lib/types/channels.d.ts.map +0 -1
  100. package/lib/types/channels.js +0 -4
  101. package/lib/types/channels.js.map +0 -1
  102. package/lib/types/client/MnemonLogo.d.ts.map +0 -1
  103. package/lib/types/client/MnemonLogo.js +0 -6
  104. package/lib/types/client/MnemonLogo.js.map +0 -1
  105. package/lib/types/client/MnemonPackSection.d.ts.map +0 -1
  106. package/lib/types/client/MnemonPackSection.js +0 -136
  107. package/lib/types/client/MnemonPackSection.js.map +0 -1
  108. package/lib/types/client/MnemonSaveAction.d.ts.map +0 -1
  109. package/lib/types/client/MnemonSaveAction.js +0 -90
  110. package/lib/types/client/MnemonSaveAction.js.map +0 -1
  111. package/lib/types/client/MnemonSettingsCard.d.ts.map +0 -1
  112. package/lib/types/client/MnemonSettingsCard.js +0 -155
  113. package/lib/types/client/MnemonSettingsCard.js.map +0 -1
  114. package/lib/types/client/MnemonTurnTail.d.ts.map +0 -1
  115. package/lib/types/client/MnemonTurnTail.js +0 -56
  116. package/lib/types/client/MnemonTurnTail.js.map +0 -1
  117. package/lib/types/client/MnemonView.d.ts.map +0 -1
  118. package/lib/types/client/MnemonView.js +0 -1585
  119. package/lib/types/client/MnemonView.js.map +0 -1
  120. package/lib/types/client/MnemonViewAppearance.d.ts.map +0 -1
  121. package/lib/types/client/MnemonViewAppearance.js +0 -67
  122. package/lib/types/client/MnemonViewAppearance.js.map +0 -1
  123. package/lib/types/client/anchor.d.ts.map +0 -1
  124. package/lib/types/client/anchor.js +0 -46
  125. package/lib/types/client/anchor.js.map +0 -1
  126. package/lib/types/client/api.d.ts.map +0 -1
  127. package/lib/types/client/api.js +0 -150
  128. package/lib/types/client/api.js.map +0 -1
  129. package/lib/types/client/dsh-compat.d.ts.map +0 -1
  130. package/lib/types/client/dsh-compat.js +0 -2
  131. package/lib/types/client/dsh-compat.js.map +0 -1
  132. package/lib/types/client/index.d.ts.map +0 -1
  133. package/lib/types/client/index.js +0 -161
  134. package/lib/types/client/index.js.map +0 -1
  135. package/lib/types/client/locales.d.ts.map +0 -1
  136. package/lib/types/client/locales.js +0 -1162
  137. package/lib/types/client/locales.js.map +0 -1
  138. package/lib/types/client/settings.d.ts.map +0 -1
  139. package/lib/types/client/settings.js +0 -70
  140. package/lib/types/client/settings.js.map +0 -1
  141. package/lib/types/client/sidebar-entry.d.ts.map +0 -1
  142. package/lib/types/client/sidebar-entry.js +0 -134
  143. package/lib/types/client/sidebar-entry.js.map +0 -1
  144. package/lib/types/client/workspace-controller.d.ts.map +0 -1
  145. package/lib/types/client/workspace-controller.js +0 -21
  146. package/lib/types/client/workspace-controller.js.map +0 -1
  147. package/lib/types/client/workspace-mount.d.ts.map +0 -1
  148. package/lib/types/client/workspace-mount.js +0 -138
  149. package/lib/types/client/workspace-mount.js.map +0 -1
  150. package/lib/types/commands.d.ts.map +0 -1
  151. package/lib/types/commands.js +0 -104
  152. package/lib/types/commands.js.map +0 -1
  153. package/lib/types/config-values.d.ts.map +0 -1
  154. package/lib/types/config-values.js +0 -4
  155. package/lib/types/config-values.js.map +0 -1
  156. package/lib/types/config.d.ts.map +0 -1
  157. package/lib/types/config.js +0 -127
  158. package/lib/types/config.js.map +0 -1
  159. package/lib/types/contracts.d.ts.map +0 -1
  160. package/lib/types/contracts.js +0 -2
  161. package/lib/types/contracts.js.map +0 -1
  162. package/lib/types/documents.d.ts.map +0 -1
  163. package/lib/types/documents.js +0 -495
  164. package/lib/types/documents.js.map +0 -1
  165. package/lib/types/guidance.d.ts.map +0 -1
  166. package/lib/types/guidance.js +0 -34
  167. package/lib/types/guidance.js.map +0 -1
  168. package/lib/types/index.d.ts.map +0 -1
  169. package/lib/types/index.js +0 -55
  170. package/lib/types/index.js.map +0 -1
  171. package/lib/types/lifecycle.d.ts.map +0 -1
  172. package/lib/types/lifecycle.js +0 -456
  173. package/lib/types/lifecycle.js.map +0 -1
  174. package/lib/types/live-runtime.d.ts.map +0 -1
  175. package/lib/types/live-runtime.js +0 -146
  176. package/lib/types/live-runtime.js.map +0 -1
  177. package/lib/types/memory-bodies.d.ts.map +0 -1
  178. package/lib/types/memory-bodies.js +0 -186
  179. package/lib/types/memory-bodies.js.map +0 -1
  180. package/lib/types/pack.d.ts.map +0 -1
  181. package/lib/types/pack.js +0 -709
  182. package/lib/types/pack.js.map +0 -1
  183. package/lib/types/process.d.ts.map +0 -1
  184. package/lib/types/process.js +0 -65
  185. package/lib/types/process.js.map +0 -1
  186. package/lib/types/review-activity.d.ts.map +0 -1
  187. package/lib/types/review-activity.js +0 -37
  188. package/lib/types/review-activity.js.map +0 -1
  189. package/lib/types/rpc.d.ts.map +0 -1
  190. package/lib/types/rpc.js +0 -384
  191. package/lib/types/rpc.js.map +0 -1
  192. package/lib/types/runner.d.ts.map +0 -1
  193. package/lib/types/runner.js +0 -155
  194. package/lib/types/runner.js.map +0 -1
  195. package/lib/types/runtime-memory.d.ts.map +0 -1
  196. package/lib/types/runtime-memory.js +0 -415
  197. package/lib/types/runtime-memory.js.map +0 -1
  198. package/lib/types/service.d.ts.map +0 -1
  199. package/lib/types/service.js +0 -512
  200. package/lib/types/service.js.map +0 -1
  201. package/lib/types/settings.d.ts.map +0 -1
  202. package/lib/types/settings.js +0 -103
  203. package/lib/types/settings.js.map +0 -1
  204. package/lib/types/storage-scope.d.ts.map +0 -1
  205. package/lib/types/storage-scope.js +0 -179
  206. package/lib/types/storage-scope.js.map +0 -1
  207. package/lib/types/subagent.d.ts.map +0 -1
  208. package/lib/types/subagent.js +0 -624
  209. package/lib/types/subagent.js.map +0 -1
  210. package/lib/types/tools.d.ts.map +0 -1
  211. package/lib/types/tools.js +0 -341
  212. package/lib/types/tools.js.map +0 -1
  213. package/lib/types/version-updates.d.ts.map +0 -1
  214. package/lib/types/version-updates.js +0 -377
  215. package/lib/types/version-updates.js.map +0 -1
@@ -1,48 +0,0 @@
1
- # dsh-mnemon 文档中心
2
-
3
- **简体中文** | [English](../en/README.md) | [项目首页](../../README.zh-CN.md)
4
-
5
- 这里按“你现在要完成什么”组织文档。第一次使用从快速开始进入;需要理解页面时看 UI 指南;只有在部署、集成或开发时才需要进入参考文档。
6
-
7
- ## 新用户路径
8
-
9
- 1. [快速开始](./getting-started.md):安装 Mnemon 与插件,选择存储范围,完成第一次验证。
10
- 2. [Sidebar 与对话交互指南](./ui-guide.md):认识状态、运行时、记忆体、档案和对话内入口。
11
- 3. [项目介绍](./project-overview.md):理解三层模型、跨 Agent 共享边界、读写边界与完整流转。
12
-
13
- ## 按任务查找
14
-
15
- | 我想要…… | 文档 |
16
- |---|---|
17
- | 决定一条信息应放在哪一层 | [存储与三层记忆模型](./storage-model.md) |
18
- | 让 DSH 与其他 Mnemon-enabled Agent 共享长期记忆 | [项目介绍:跨 Agent 共享边界](./project-overview.md#跨-agent-共享边界) · [配置参考:共享范围](./configuration.md#选择跨-agent-共享范围) |
19
- | 了解每轮注入、召回、沉淀和归档何时发生 | [生命周期与核心流程](./workflows.md) |
20
- | 切换 Sidebar / Buildin、全局 / 工作区 / 自定义目录 | [配置参考](./configuration.md) |
21
- | 理解工作区“查看目录”与 Agent“实际生效目录” | [UI 指南:工作区模式](./ui-guide.md#工作区模式查看与执行分离) |
22
- | 检查或更新 Mnemon 与 dsh-mnemon | [运维指南:版本检查与更新](./operations.md#版本检查与更新) |
23
- | 备份、恢复或迁移完整记忆目录 | [运维指南:备份与恢复](./operations.md#备份与恢复) |
24
- | 排查召回为空、目录未对齐、CLI 或 Provider 问题 | [运维、安全与故障排查](./operations.md#故障排查) |
25
- | 使用模型工具、`/mnemon` 命令或内部 RPC | [接口参考](./interfaces.md) |
26
- | 理解 Host、worker、控制面与数据面 | [架构设计](./architecture.md) |
27
- | 修改代码、截图、测试或发布 | [开发与验证](./development.md) |
28
- | 查看下一阶段计划 | [Roadmap](./roadmap.md) |
29
-
30
- ## 核心术语
31
-
32
- | 中文 | 英文 / 代码名 | 含义 |
33
- |---|---|---|
34
- | 记忆系统 | Memory System | dsh-mnemon 在 DSH 中的完整入口 |
35
- | 运行时记忆 | Runtime Memory | 每轮注入的 USER / MEMORY 热记忆 |
36
- | 档案 | Project Documents | 受管、可检索、保留完整 Markdown 叙事的项目知识 |
37
- | 记忆体 | Memory Space | 独立、可激活、按需召回的长期 Mnemon Store |
38
- | 跨 Agent 共享 | Cross-agent memory sharing | 多个 Mnemon-enabled Agent 使用同一根和 Store,共享长期记忆而非完整 DSH 上下文 |
39
- | 沉淀 | Remember / Distill | 把候选交给受监督子 Agent 判断、查重与写入 |
40
- | 召回 | Recall | 从已激活记忆体按需取回有界证据 |
41
- | 归档 | Archive | 先建立冷引用,再把不常用档案迁出 active 层 |
42
-
43
- ## 文档边界
44
-
45
- - 用户文档以 v0.1.4 的 Sidebar 默认体验为主,同时说明 Buildin 兼容形态。
46
- - 架构图表达稳定执行边界,不是实时监控面板;实时数量与版本以“状态”页为准。
47
- - RPC 是 Host 与插件客户端之间的内部协议,不承诺稳定外部 API。
48
- - 当前没有正式固定的 DSH / Mnemon 版本矩阵;升级前应备份并在隔离目录验证。
@@ -1,133 +0,0 @@
1
- # 架构设计
2
-
3
- **简体中文** | [English](../en/architecture.md) | [文档中心](./README.md)
4
-
5
- ## 定位
6
-
7
- `dsh-mnemon` 是 DSH 与 Mnemon 之间的集成和监督层,不是新的数据库引擎:
8
-
9
- - DSH 提供主 Agent、生命周期事件、subagent provider、工具、命令、设置和 Web 扩展点;
10
- - 插件提供三层知识控制面、路由策略、事务屏障和 UI;
11
- - 本地 `mnemon` CLI 提供命名 Store、SQLite 持久化、四类图、召回、关系和软删除,并形成与其他 Mnemon-enabled Agent 共享长期记忆的数据边界。
12
-
13
- ## 组件图
14
-
15
- [![dsh-mnemon 运行时架构](../assets/diagrams/zh-CN/project-architecture.svg)](../assets/diagrams/zh-CN/project-architecture.svg)
16
-
17
- 图中实线表示确定性数据或控制路径,紫色虚线表示 LLM 监督路径。Runtime Memory 和 Documents 直接使用受管文件;只有 Memory Spaces 通过 `MnemonRunner` 调用本地 Mnemon CLI。点击图片可以查看原始 SVG。
18
-
19
- 因此跨 Agent 互操作只发生在图中的 Memory Spaces:共享的是 Mnemon Store 内的长期记忆与关系,不是 DSH 的会话上下文、Runtime 投影或 Documents 控制面。插件不会把数据主动推送到其他 Agent;参与方通过对齐本地 Mnemon 根和 Store 来共享。
20
-
21
- ## Host 组合根
22
-
23
- `src/index.ts::apply()` 按以下顺序组装插件:
24
-
25
- ```text
26
- settings.register("mnemon")
27
- -> resolveConfig
28
- -> createRunner
29
- -> MnemonService
30
- -> RuntimeMemoryController
31
- -> DocumentManager
32
- -> StorageScopeInspector
33
- -> MnemonSubagentCoordinator
34
- -> MnemonLifecycle
35
- -> tools / commands / prompt sections
36
- -> register RPC when a Web connection exists
37
- ```
38
-
39
- Host 声明依赖 `tools`、`settings`、`commands`、`agents` 和 `subagents`。Web client 另外依赖 slots、connection 和 DSH locale 服务。
40
-
41
- ## 主 Agent 与 worker 的双路径
42
-
43
- 同名 `mnemon_*` 工具根据调用者是否为 subagent 分流,防止递归委派:
44
-
45
- ```text
46
- root Agent calls mnemon_recall
47
- -> coordinator starts a bounded recall worker
48
- -> worker calls mnemon_memory_bodies and mnemon_recall
49
- -> tool sees origin=subagent
50
- -> call reaches MnemonService directly
51
- -> structured evidence returns to root Agent
52
- ```
53
-
54
- 长期语义写入、关系、软删除以及记忆体创建/更新/合并采用相同模式。运行时记忆和 Documents 的普通变更先经过 coordinator,但通常由确定性控制层直接提交;只有容量维护或归档需要额外 worker。
55
-
56
- 记忆体目录的物理删除是单独的确定性危险操作:WebUI 必须先展示二次确认,随后经 loopback 写 RPC 调用 Mnemon 原生 `store remove`;只有 CLI 删除成功后才移除目录登记。
57
-
58
- ## 两类子 Agent
59
-
60
- ### `spawn`
61
-
62
- `spawn` 使用新的隔离上下文。插件为每类任务提供:
63
-
64
- - 固定 persona;
65
- - 最小工具白名单;
66
- - DSH 支持子集内的结构化输出 schema;
67
- - `maxDepth: 1`;
68
- - 可取消的 signal 和有界 token 预算。
69
-
70
- 它用于召回、长期语义写入、证据限定问答、热记忆整理和 Document 归档。
71
-
72
- ### `fork`
73
-
74
- 评分后台审查必须使用名为 `fork` 且 `inheritsParentContext=true` 的 provider。它只继承已经完成的父 checkpoint,用于判断是否需要维护热记忆或最多一份项目档案。它不是用户任务的延续,也不会把审查推理注入主对话。
75
-
76
- 当前审查白名单不包含 `mnemon_remember`、`mnemon_forget` 或记忆体维护工具,因此后台审查不会直接修改长期记忆体。
77
-
78
- ## 控制面与数据面
79
-
80
- ```text
81
- LLM-owned judgment Host-owned guarantees
82
- ------------------ ---------------------
83
- what is worth keeping input validation
84
- which Memory Space fits path boundary
85
- whether two items are duplicates process timeout/cancel
86
- how to summarize a Document file lock + atomic rename
87
- whether a reusable artifact exists UTF-8 capacity accounting
88
- revision conflict rejection
89
- read/write RPC authority
90
- ```
91
-
92
- 必须区分“persona 约束”和“Host 硬保证”。例如 MEMORY 归档 worker 被要求覆盖每条已提交热记忆,但 Host 只能硬校验结构化 action、revision 和字节预算;USER 压缩的 source coverage 则由 Host 逐项验证。
93
-
94
- ## Web 边界
95
-
96
- WebUI 不启动系统进程,也不直接打开 SQLite:
97
-
98
- ```text
99
- browser component
100
- -> typed client wrapper
101
- -> DSH RPC authority check
102
- -> Host validation
103
- -> controller / service / bounded worker
104
- -> local CLI or managed files
105
- ```
106
-
107
- 读通道要求 `trusted-host`,记忆写通道和设置通道要求 `loopback`。`writeEnabled=false` 时 Host 不注册记忆写通道。
108
-
109
- ## 国际化
110
-
111
- `src/client/locales.ts` 以中文键集定义 `MnemonKey`,英文词典必须满足同一键集合;`src/client/index.ts` 把两套词典注册到 DSH locale。主要 Web 页面和设置卡随 DSH 全局语言即时切换,并复用全局明暗主题。
112
-
113
- 当前命令输出、工具卡标题、持久化的兼容默认记忆体名称和部分后端错误仍是单语,这是 Roadmap 中的已知缺口。
114
-
115
- ## 关键模块
116
-
117
- | 模块 | 职责 |
118
- |---|---|
119
- | `src/index.ts` | Host 组合与注册 |
120
- | `src/config.ts` | 配置 schema、默认值和解析 |
121
- | `src/process.ts` | 无 shell 的有界进程执行 |
122
- | `src/runner.ts` | CLI 发现、参数、序列化和 JSON 解析 |
123
- | `src/service.ts` | 长期记忆应用门面 |
124
- | `src/memory-bodies.ts` | Memory Space 目录元数据 |
125
- | `src/runtime-memory.ts` | 热记忆事实源与投影 |
126
- | `src/documents.ts` | Documents 控制面 |
127
- | `src/subagent.ts` | worker 编排与容量事务 |
128
- | `src/lifecycle.ts` | per-root-Agent 生命周期 |
129
- | `src/review-activity.ts` | 确定性审查评分 |
130
- | `src/tools.ts` | 模型工具及 root/worker 分流 |
131
- | `src/rpc.ts` | Web 读写通道 |
132
- | `src/storage-scope.ts` | 三种存储范围的只读盘点 |
133
- | `src/client/*` | Web 工作台、设置和 locale |
@@ -1,223 +0,0 @@
1
- # 配置参考
2
-
3
- **简体中文** | [English](../en/configuration.md) | [文档中心](./README.md)
4
-
5
- ## 配置位置与生效方式
6
-
7
- 插件在 DSH settings 服务中注册 `mnemon` 命名空间。用户配置位于:
8
-
9
- ```text
10
- $DSH_HOME/settings.yaml
11
- ```
12
-
13
- 默认通常是 `~/.dsh/settings.yaml`。当前全部配置标记为 `live` 生效;保存后会先初始化候选运行图,再原子切换 Host 服务。
14
-
15
- Web 设置页编辑 `displayMode`、`storageScope`、`dataDir`,以及 `mnemon-ui` 下的回合记忆条和存入记忆按钮;同页还提供当前有效目录的 ZIP 导入 / 导出。其他高级项需要直接修改 YAML。
16
-
17
- ## 完整示例
18
-
19
- ```yaml
20
- mnemon:
21
- displayMode: sidebar # sidebar | buildin
22
- storageScope: global # global | workspace | custom
23
- # dataDir: ~/mnemon-data # custom 时必填
24
- # cliPath: /opt/homebrew/bin/mnemon
25
- # store: legacy-store # 兼容发现提示,不是常规路由目标
26
- timeoutMs: 10000
27
- defaultRecallLimit: 10
28
- routingGuidance: true
29
- lifecycleEnabled: true
30
- recallMode: guided
31
- writebackMode: guided
32
- idleReviewMs: 30000
33
- tabEnabled: true
34
- writeEnabled: true
35
- ```
36
-
37
- ## 选项
38
-
39
- | 配置 | 默认值 | 范围 | 实现语义 |
40
- |---|---:|---|---|
41
- | `displayMode` | `sidebar` | `sidebar` / `buildin` | `sidebar` 挂载左侧栏独立工作台;`buildin` 恢复 DSH 原生对话区标签页;保存后实时切换且不会同时挂载两个入口 |
42
- | `storageScope` | `global` | `global` / `workspace` / `custom` | 统一控制 Runtime、Documents、Memory Spaces 和预留 state 根目录 |
43
- | `dataDir` | 未设置 | 绝对路径、`~` 或 `~/...` | `custom` 时必填;旧配置只设置它时自动解析为 `custom` |
44
- | `cliPath` | 自动发现 | 可执行路径 | 显式指定 Mnemon CLI |
45
- | `store` | 未设置 | `[A-Za-z0-9][A-Za-z0-9_-]*` | 用于旧 Store 的兼容发现/首选提示;语义操作由 Memory Space 路由 |
46
- | `timeoutMs` | `10000` | 100–120000 ms | 单次 CLI 硬超时 |
47
- | `defaultRecallLimit` | `10` | 1–50 | 服务和 UI 默认召回条数;不同入口可能再收紧 |
48
- | `routingGuidance` | `true` | boolean | 是否注册额外的分层路由 system section |
49
- | `lifecycleEnabled` | `true` | boolean | 是否启用 pre-step cue 和评分后台审查 |
50
- | `recallMode` | `guided` | `guided` / `off` | 是否注入按需 recall cue;不移除显式召回 |
51
- | `writebackMode` | `guided` | `guided` / `off` | 是否注入热记忆 cue 并启用评分后台审查;不移除显式写入 |
52
- | `idleReviewMs` | `30000` | 5000–600000 ms | 达标后需要连续空闲的时间 |
53
- | `tabEnabled` | `true` | boolean | 是否挂载 `displayMode` 指定的 Web 入口;关闭后 Host RPC、命令和 Agent 工具保持注册 |
54
- | `writeEnabled` | `true` | boolean | 是否暴露语义写工具、写 RPC 和写命令 |
55
- | `mnemon-ui.turnBar` | `true` | boolean | 回合尾记忆活动条;默认开启,**保存后实时生效** |
56
- | `mnemon-ui.saveAction` | `true` | boolean | 已定稿助手回复旁的「存入记忆」图标与确认弹窗;默认开启,**保存后实时生效** |
57
-
58
- `mnemon` Host/存储命名空间和 `mnemon-ui` 浏览器呈现命名空间都实时生效。存储根只会在新运行图初始化成功后原子切换;旧版 `mnemon.conversationInteraction` 仍会作为迁移默认值读取,但新保存只写入 `mnemon-ui`。
59
-
60
- ## 存储范围
61
-
62
- ### `global`
63
-
64
- ```text
65
- MNEMON_DATA_DIR when non-empty
66
- otherwise ~/.mnemon
67
- ```
68
-
69
- 适合希望多个工作区共享 Runtime、Documents 和 Memory Spaces 的用户;其他 Mnemon-enabled Agent 使用相同根时,也可以共享其中的 Mnemon Memory Spaces。
70
-
71
- ### `workspace`
72
-
73
- ```text
74
- Agent / 工具 / 生命周期:resolve(currentSession.header.cwd, ".mnemon")
75
- Web 工作台查看:resolve(workspaceRegistry.get(selectedWorkspaceId).path, ".mnemon")
76
- ```
77
-
78
- 每个 DSH 工作区拥有独立的三层记忆根。Agent、模型工具、命令和生命周期按当前会话的 cwd 路由,不受 Web 工作台查看目标影响。工作台只能从 Host 已登记的工作区中选择,不能提交任意路径;查看目标与会话实际目录不一致时,顶部会显示两条路径并提供“一键对齐当前会话”。需要 Agent 子任务的操作在未对齐时会被 Host 拒绝,避免写入错误项目。
79
-
80
- ### `custom`
81
-
82
- ```yaml
83
- mnemon:
84
- storageScope: custom
85
- dataDir: /absolute/path/to/mnemon-data
86
- ```
87
-
88
- 也允许 `~` 和 `~/...`。相对路径会被拒绝。
89
-
90
- ### 选择跨 Agent 共享范围
91
-
92
- | 目标 | 推荐范围 | 说明 |
93
- |---|---|---|
94
- | 本机多个 Agent 共享长期记忆 | `global` | 各方统一使用 `~/.mnemon` 或同一个 `MNEMON_DATA_DIR` |
95
- | 多个 Agent 共享指定数据根 | `custom` | 各方显式配置同一个绝对目录,便于隔离和备份 |
96
- | 只在一个项目内共享 | `workspace` | 各方都需要把 Mnemon 根对齐到该项目的 `<workspace>/.mnemon` |
97
-
98
- 只有 `data/<store>/mnemon.db` 中的 Mnemon 长期层具备原生跨 Agent 互操作性。Runtime、Documents、DSH 的激活状态和 UI 元数据仍属于 dsh-mnemon 管理范围。
99
-
100
- ## CLI 发现优先级
101
-
102
- ```text
103
- config.cliPath
104
- -> executable MNEMON_CLI_PATH
105
- -> each PATH directory
106
- -> ~/.local/bin/mnemon
107
- -> /opt/homebrew/bin/mnemon
108
- -> /usr/local/bin/mnemon
109
- -> /usr/bin/mnemon
110
- ```
111
-
112
- 显式 `cliPath` 会被采用;若它不可执行,实际调用会返回启动错误。
113
-
114
- ## 兼容 Store 提示优先级
115
-
116
- ```text
117
- config.store
118
- -> MNEMON_STORE
119
- -> <storageRoot>/active
120
- -> default
121
- ```
122
-
123
- Memory Space 目录建立后,长期语义操作使用明确的记忆体 ID,不依赖全局 active Store 进行路由。
124
-
125
- ## Provider 要求
126
-
127
- 普通 worker 会优先选择 `spawn`;如果没有该名称,可以选择另一个具备全部能力的 provider:
128
-
129
- ```text
130
- outputSchema = true
131
- toolFilter = true
132
- persona = true
133
- depthLimit = true
134
- ```
135
-
136
- 后台审查没有回退:必须存在名为 `fork` 的兼容 provider,并且:
137
-
138
- ```text
139
- inheritsParentContext = true
140
- ```
141
-
142
- 缺少 `fork` 不会阻止确定性状态或普通 UI 读取,但达到审查门槛时会记录 subagent 失败。
143
-
144
- ## 只读配置
145
-
146
- ```yaml
147
- mnemon:
148
- writeEnabled: false
149
- ```
150
-
151
- 效果:
152
-
153
- - 不注册模型写工具;
154
- - 不注册 `/dsh-mnemon-write` RPC;
155
- - `/mnemon remember` 和 `/mnemon forget` 拒绝;
156
- - `MnemonService` 的语义 mutation 拒绝。
157
-
158
- 它是“功能只读”,不是文件系统只读模式:Runtime 控制器仍可能初始化或修复投影,Document 搜索会更新 LRU 访问时间,Mnemon 读命令也可能触发上游数据库迁移。不要把 `writeEnabled=false` 用作只读挂载的安全承诺。
159
-
160
- ## 开关交互
161
-
162
- ```text
163
- writeEnabled=false
164
- -> overrides all explicit semantic writes
165
-
166
- writebackMode=off
167
- -> no write cue, no scored review
168
- -> explicit writes remain when writeEnabled=true
169
-
170
- recallMode=off
171
- -> no recall cue
172
- -> explicit recall remains
173
-
174
- lifecycleEnabled=false
175
- -> no lifecycle cues or review
176
- -> UI, commands, and explicit tools remain
177
-
178
- routingGuidance=false
179
- -> removes only mnemon:routing
180
- -> runtime-memory prompt section remains
181
- ```
182
-
183
- ## 展示形态与 `tabEnabled` 界面开关
184
-
185
- `displayMode=sidebar`(默认)会挂载“记忆系统”侧边栏入口和独立主内容区工作台,并使用无 Mnemon Logo 的 DSH 官方风格极简皮肤;`displayMode=buildin` 会改为注册原有的 DSH `conversation.view` 内嵌标签页并保持既有视觉。两者共享功能工作台,但外观定义隔离。设置页保存后会先卸载当前入口再挂载目标入口,因此两种形态不会同时出现。
186
-
187
- `tabEnabled=false` 会实时移除当前形态的 Web 入口。为避免运行中的 Agent 或命令因界面设置变化而失效,Host RPC、命令和工具不会随展示形态或总开关卸载。
188
-
189
- ## Profile patch 覆盖
190
-
191
- 包内 `cordis.patch.yml` 提供默认 config 行。DSH profile 的同 ID 配置可能整体覆盖这行;自定义 patch 时应保留仍需启用的键,而不是假设深合并。
192
-
193
- ## 常见配置
194
-
195
- 工作区隔离:
196
-
197
- ```yaml
198
- mnemon:
199
- storageScope: workspace
200
- ```
201
-
202
- 自定义数据盘和较长 CLI 超时:
203
-
204
- ```yaml
205
- mnemon:
206
- storageScope: custom
207
- dataDir: /Volumes/AgentData/mnemon
208
- timeoutMs: 30000
209
- ```
210
-
211
- 保留显式工具、关闭生命周期行为:
212
-
213
- ```yaml
214
- mnemon:
215
- lifecycleEnabled: false
216
- ```
217
-
218
- 仅关闭后台写回判断:
219
-
220
- ```yaml
221
- mnemon:
222
- writebackMode: off
223
- ```
@@ -1,198 +0,0 @@
1
- # 开发与验证
2
-
3
- **简体中文** | [English](../en/development.md) | [文档中心](./README.md)
4
-
5
- ## 环境
6
-
7
- 仓库没有在 `package.json` 中声明 Node、pnpm、DSH 或 Mnemon 的最低版本。使用当前 DSH 开发环境,并在升级依赖时通过完整验证链路确认兼容性。
8
-
9
- 安装依赖:
10
-
11
- ```sh
12
- pnpm install
13
- ```
14
-
15
- ## 标准命令
16
-
17
- ```sh
18
- pnpm run typecheck # tsc --noEmit
19
- pnpm test # vitest run
20
- pnpm run build # declarations + host/client bundles
21
- pnpm run verify # typecheck + test + build
22
- ```
23
-
24
- ## 目录结构
25
-
26
- ```text
27
- src/
28
- +-- index.ts # Host composition root
29
- +-- config.ts # settings schema
30
- +-- process.ts / runner.ts # local CLI execution
31
- +-- service.ts # durable-memory facade
32
- +-- memory-bodies.ts # Memory Space registry
33
- +-- runtime-memory.ts # hot-memory authority
34
- +-- documents.ts # managed Documents
35
- +-- subagent.ts # bounded workers
36
- +-- lifecycle.ts # root-Agent hooks
37
- +-- review-activity.ts # activity score
38
- +-- tools.ts / commands.ts # model and human interfaces
39
- +-- rpc.ts / settings.ts # Web bridges
40
- +-- storage-scope.ts # storage inventory
41
- +-- client/ # React workspace and locales
42
- tests/ # Vitest suites
43
- lib/ # committed build artifacts
44
- docs/zh-CN/ # Chinese documentation
45
- docs/en/ # English mirror
46
- cordis.patch.yml # DSH profile bundle patch
47
- ```
48
-
49
- ## 构建产物
50
-
51
- ```text
52
- tsc -p tsconfig.build.json
53
- -> lib/types/* declarations, maps, intermediate ESM
54
-
55
- tsdown host bundle
56
- -> lib/index.js Node ES2024 ESM
57
-
58
- tsdown client bundle
59
- -> lib/client.js DSH browser module wrapper
60
- -> lib/client.js.map
61
-
62
- lightningcss plugin
63
- -> CSS Modules compiled and injected as scoped <style>
64
- ```
65
-
66
- Host 保持 `cordis` 和 `schemastery` external。Client 保持 React、ReactDOM、JSX runtime 和 Cordis external,其余依赖打入 bundle。
67
-
68
- `lib/` 是发布输入的一部分。修改 `src/` 后必须重新构建并检查生成 diff;不要手工编辑 `lib/`。
69
-
70
- ## 测试层次
71
-
72
- 现有 Vitest 套件覆盖:
73
-
74
- - 配置解析、CLI 查找、进程串行;
75
- - Memory Space 发现、激活、路由与合并;
76
- - recall payload 兼容和图谱解析;
77
- - Runtime JSON/Markdown 一致性、锁、容量、UTF-8 和 revision;
78
- - Documents 路径、frontmatter、搜索、LRU、归档与冲突;
79
- - worker 工具隔离、schema 子集、结构化回执;
80
- - 生命周期 cue、评分、idle debounce、取消和水位保留;
81
- - RPC authority、只读行为和设置 revision;
82
- - Web 工作台、双语文案和关键交互。
83
-
84
- 这些主要是临时目录、fake runner 和 mock Host 集成测试,不等同于自动化的真实 DSH + Mnemon WebUI E2E。
85
-
86
- ## 真实 WebUI 验证
87
-
88
- 发布前使用隔离环境,避免污染个人记忆:
89
-
90
- ```text
91
- temporary DSH_HOME
92
- temporary MNEMON_DATA_DIR or custom storageScope
93
- temporary workspace
94
- independent Web port
95
- local link installation
96
- ```
97
-
98
- 建议场景:
99
-
100
- 1. 空根:UI 不报错,能够创建第一个 Memory Space。
101
- 2. 普通对话:只出现短 cue,不强制 recall 或写入。
102
- 3. 历史问题:Agent 自主 recall,并返回正确 space provenance。
103
- 4. 显式沉淀:worker 查重、选择范围并可被再次召回。
104
- 5. 多空间:读取只覆盖 active,写入 inactive 后自动激活。
105
- 6. Runtime:USER / MEMORY add、replace、remove 和投影一致。
106
- 7. Documents:创建、检索、更新、人工归档和原项目文件不变。
107
- 8. 评分审查:轻任务不触发;达标后等待 idle;新 turn 能取消并保留水位。
108
- 9. 只读:写工具、写命令和写 RPC 被拒绝,读取仍可用。
109
- 10. Sidebar:四个一级标签、记忆体四个二级标签、固定页头、筛选与加载更多均正常。
110
- 11. 对话内交互:本回合记忆只在已完成且有活动的回合出现;跳转目标正确;存入记忆取消不写入。
111
- 12. 设置:Sidebar / Buildin、存储范围与两个对话开关保存后实时生效,不需要刷新。
112
- 13. ZIP:导出后可预检,并能在隔离 custom 根完成合并恢复;损坏 checksum 必须拒绝。
113
- 14. 版本:检查不会安装;link / 手工来源不显示不安全更新;更新完成后自动重新检查状态。
114
- 15. 状态和浏览器控制台:无未处理错误或警告。
115
-
116
- 容量极限、CLI 超时、revision 冲突和 Host 重启应在专用故障注入环境验证。
117
-
118
- ## 维护文档视觉素材
119
-
120
- 公开 UI 截图统一位于 `docs/assets/screenshots/`,中英文文档复用同一组实机画面;语言相关架构图分别保存在 `docs/assets/diagrams/zh-CN/` 与 `docs/assets/diagrams/en/`。界面结构、主要文案或默认行为变化时:
121
-
122
- 1. 使用真实 DSH Web profile,但先检查画面中没有 token、凭据或不应公开的个人数据;
123
- 2. 只做查看、筛选、展开与打开弹窗等可逆交互;需要展示写入前流程时停在最终确认之前;
124
- 3. 覆盖同职责截图,避免按版本不断累积文件名;只有新增用户任务时才增加素材;
125
- 4. 同步 README 海报、GIF / MP4 演示和 `ui-guide.md`;
126
- 5. 检查 PNG / JPEG 扩展名与真实编码一致,并在原始分辨率下确认文字可读;
127
- 6. 删除已无引用、展示旧 Buildin 布局或术语过时的截图;
128
- 7. 运行链接与图片检查,再人工打开中英文 README 和 UI 指南。
129
-
130
- README 演示资源位于 `docs/assets/media/dsh-mnemon-memory-system-demo.*`。演示应覆盖状态、运行时、记忆体、档案和对话内确认,但不要用自动化真正提交记忆、更新组件或更改设置。
131
-
132
- ## 修改 subagent schema
133
-
134
- DSH structured output 只支持一个紧凑 JSON Schema 子集:
135
-
136
- ```text
137
- type, oneOf, properties, required, additionalProperties,
138
- items, enum, const, and annotation keywords
139
- ```
140
-
141
- 不要加入 `maxItems` 等不受支持关键字。`assertDshOutputSchema()` 会在启动 worker 前递归拒绝未知 schema 键;结果数量等限制由 persona 和 Host parser 双重实现。
142
-
143
- ## 修改存储格式
144
-
145
- Runtime、Documents 和 Memory Space registry 都带版本字段或固定结构。修改时需要:
146
-
147
- 1. 明确旧格式解析策略;
148
- 2. 增加迁移或拒绝路径;
149
- 3. 保证临时文件与原子 rename;
150
- 4. 补充并发和损坏输入测试;
151
- 5. 更新中英文存储、运维和 Roadmap 文档;
152
- 6. 在复制的数据根上完成升级/回退验证。
153
-
154
- 当前没有正式 schema migration 框架,不应静默改变持久格式。
155
-
156
- ## 文档国际化维护
157
-
158
- `docs/zh-CN` 与 `docs/en` 应保持同名文件和相同章节职责。修改默认值、流程或限制时:
159
-
160
- - 同步两种语言;
161
- - 保持命令、配置键、路径和代码符号完全一致;
162
- - 使用相对路径互链对应语言页面;
163
- - 架构总览优先使用可访问、无脚本和无外部资源的 SVG;目录树、命令、公式与短协议仍使用可复制的 `text` / ASCII;
164
- - 根 README 只保留摘要,把细节放到单一权威 docs 页面;
165
- - 所有用户可感知界面变化同步检查 `ui-guide.md`、`getting-started.md`、`configuration.md` 与 `operations.md`。
166
-
167
- Web locale 变更时,中文键集合仍是类型事实源;英文词典必须满足 `Record<MnemonKey, string>`,并保持占位符一致。
168
-
169
- ## 发布检查
170
-
171
- ```text
172
- [ ] pnpm run verify
173
- [ ] review source and generated lib diffs
174
- [ ] validate package file list includes README.md, README.zh-CN.md, docs/assets and bilingual docs
175
- [ ] install the built/local bundle into an isolated Web profile
176
- [ ] run real Mnemon CLI and WebUI smoke tests
177
- [ ] verify Chinese and English workspaces
178
- [ ] verify global/workspace/custom paths as applicable
179
- [ ] record tested DSH and Mnemon versions
180
- [ ] back up any data root used for upgrade testing
181
- ```
182
-
183
- `package.json.files` 当前发布 `lib`、patch、两份根 README、统一管理的文档视觉素材、双语公开 docs 和 License。
184
-
185
- ## 发布到 npm
186
-
187
- 发布后 `dsh plugin --profile web add dsh-mnemon` 即按 registry 名称解析(与 dsh-better-sidebar 同路径)。发布步骤:
188
-
189
- ```sh
190
- npm pack --dry-run # 检查 tarball 文件清单(含 cordis.patch.yml、lib、docs)
191
- pnpm publish --access public # prepublishOnly 会先跑 pnpm run verify
192
- ```
193
-
194
- 凭据约定:NPM_TOKEN 只写入用户级 `~/.npmrc`(`npm config set "//registry.npmjs.org/:_authToken" "${NPM_TOKEN}" --userconfig ~/.npmrc`),发布后删除。**不要**把凭据行提交进仓库 `.npmrc`:pnpm 11 出于安全会忽略项目级 `.npmrc` 中未展开的环境变量凭据并告警,且该文件会随仓库传播。
195
-
196
- 2FA 注意:若 npm 账号开启发布级两步验证,交互发布直接执行 `pnpm publish --access public`,按提示输入 OTP;脚本/CI 发布需改用 Classic **Automation** 令牌或允许 bypass 2FA 的 Granular 令牌(`npm login` 生成的普通令牌无法发布,会报 403 Two-factor authentication required)。
197
-
198
- 发布前核对 `package.json` 的 `repository`/`homepage`/`bugs` 指向 `omdsh-dev/dsh-mnemon`(npm 页面与 GitHub 保持一致),并确认版本号已递增。