dsh-engramory 1.0.0 → 1.0.2
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.
- package/README.en.md +218 -0
- package/README.md +135 -326
- package/index.js +2692 -2563
- package/package.json +79 -78
- package/README.zh-CN.md +0 -200
package/package.json
CHANGED
|
@@ -1,78 +1,79 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "dsh-engramory",
|
|
3
|
-
"version": "1.0.
|
|
4
|
-
"description": "
|
|
5
|
-
"keywords": [
|
|
6
|
-
"dsh-plugin",
|
|
7
|
-
"deepseek-harness",
|
|
8
|
-
"dsh",
|
|
9
|
-
"memory",
|
|
10
|
-
"agent-memory",
|
|
11
|
-
"long-term-memory",
|
|
12
|
-
"engramory",
|
|
13
|
-
"markdown"
|
|
14
|
-
],
|
|
15
|
-
"type": "module",
|
|
16
|
-
"main": "index.js",
|
|
17
|
-
"dsh": {
|
|
18
|
-
"bundle": {
|
|
19
|
-
"patch": "./cordis.patch.yml"
|
|
20
|
-
},
|
|
21
|
-
"client": {
|
|
22
|
-
"platform": "web",
|
|
23
|
-
"inject": [
|
|
24
|
-
"@deepseek-ai/dsh-client-locale",
|
|
25
|
-
"@deepseek-ai/dsh-client-ui-plugin-manager"
|
|
26
|
-
]
|
|
27
|
-
},
|
|
28
|
-
"compatibility": {
|
|
29
|
-
"dsh": ">=0.1.0-rc.7 <0.3.0-0",
|
|
30
|
-
"dshReleases": {
|
|
31
|
-
"0.1.5-rc.3": "compatible",
|
|
32
|
-
"0.1.7-alpha.1": "compatible",
|
|
33
|
-
"0.1.7-alpha.2": "compatible",
|
|
34
|
-
"0.1.7-rc.1": "compatible",
|
|
35
|
-
"0.1.7-rc.2": "compatible",
|
|
36
|
-
"0.2.1-alpha.5": "compatible",
|
|
37
|
-
"0.2.1-rc.1": "compatible",
|
|
38
|
-
"0.2.1-rc.2": "compatible",
|
|
39
|
-
"0.2.1-rc.3": "compatible",
|
|
40
|
-
"0.2.1-rc.4": "compatible",
|
|
41
|
-
"0.2.1-rc.5": "compatible",
|
|
42
|
-
"0.2.2-alpha.2": "compatible"
|
|
43
|
-
}
|
|
44
|
-
}
|
|
45
|
-
},
|
|
46
|
-
"exports": {
|
|
47
|
-
".": "./index.js",
|
|
48
|
-
"./client": "./client.js",
|
|
49
|
-
"./locale/*.json": "./locale/*.json",
|
|
50
|
-
"./icon": "./icon.svg",
|
|
51
|
-
"./package.json": "./package.json"
|
|
52
|
-
},
|
|
53
|
-
"files": [
|
|
54
|
-
"index.js",
|
|
55
|
-
"client.js",
|
|
56
|
-
"cordis.patch.yml",
|
|
57
|
-
"locale/*.json",
|
|
58
|
-
"icon.svg",
|
|
59
|
-
"README.md",
|
|
60
|
-
"LICENSE"
|
|
61
|
-
],
|
|
62
|
-
"
|
|
63
|
-
"
|
|
64
|
-
|
|
65
|
-
"
|
|
66
|
-
"
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
"
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "dsh-engramory",
|
|
3
|
+
"version": "1.0.2",
|
|
4
|
+
"description": "DeepSeek Harness 的长期记忆插件:AI 记住的东西存成普通 markdown 文件,每轮自动带上记忆索引,索引有大小上限。",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"dsh-plugin",
|
|
7
|
+
"deepseek-harness",
|
|
8
|
+
"dsh",
|
|
9
|
+
"memory",
|
|
10
|
+
"agent-memory",
|
|
11
|
+
"long-term-memory",
|
|
12
|
+
"engramory",
|
|
13
|
+
"markdown"
|
|
14
|
+
],
|
|
15
|
+
"type": "module",
|
|
16
|
+
"main": "index.js",
|
|
17
|
+
"dsh": {
|
|
18
|
+
"bundle": {
|
|
19
|
+
"patch": "./cordis.patch.yml"
|
|
20
|
+
},
|
|
21
|
+
"client": {
|
|
22
|
+
"platform": "web",
|
|
23
|
+
"inject": [
|
|
24
|
+
"@deepseek-ai/dsh-client-locale",
|
|
25
|
+
"@deepseek-ai/dsh-client-ui-plugin-manager"
|
|
26
|
+
]
|
|
27
|
+
},
|
|
28
|
+
"compatibility": {
|
|
29
|
+
"dsh": ">=0.1.0-rc.7 <0.3.0-0",
|
|
30
|
+
"dshReleases": {
|
|
31
|
+
"0.1.5-rc.3": "compatible",
|
|
32
|
+
"0.1.7-alpha.1": "compatible",
|
|
33
|
+
"0.1.7-alpha.2": "compatible",
|
|
34
|
+
"0.1.7-rc.1": "compatible",
|
|
35
|
+
"0.1.7-rc.2": "compatible",
|
|
36
|
+
"0.2.1-alpha.5": "compatible",
|
|
37
|
+
"0.2.1-rc.1": "compatible",
|
|
38
|
+
"0.2.1-rc.2": "compatible",
|
|
39
|
+
"0.2.1-rc.3": "compatible",
|
|
40
|
+
"0.2.1-rc.4": "compatible",
|
|
41
|
+
"0.2.1-rc.5": "compatible",
|
|
42
|
+
"0.2.2-alpha.2": "compatible"
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
},
|
|
46
|
+
"exports": {
|
|
47
|
+
".": "./index.js",
|
|
48
|
+
"./client": "./client.js",
|
|
49
|
+
"./locale/*.json": "./locale/*.json",
|
|
50
|
+
"./icon": "./icon.svg",
|
|
51
|
+
"./package.json": "./package.json"
|
|
52
|
+
},
|
|
53
|
+
"files": [
|
|
54
|
+
"index.js",
|
|
55
|
+
"client.js",
|
|
56
|
+
"cordis.patch.yml",
|
|
57
|
+
"locale/*.json",
|
|
58
|
+
"icon.svg",
|
|
59
|
+
"README.md",
|
|
60
|
+
"LICENSE"
|
|
61
|
+
],
|
|
62
|
+
"author": "tinqiao-oss",
|
|
63
|
+
"license": "MIT",
|
|
64
|
+
"repository": {
|
|
65
|
+
"type": "git",
|
|
66
|
+
"url": "git+https://github.com/tinqiao-oss/engramory.git",
|
|
67
|
+
"directory": "adapters/dsh/plugin"
|
|
68
|
+
},
|
|
69
|
+
"homepage": "https://github.com/tinqiao-oss/engramory/tree/master/adapters/dsh/plugin#readme",
|
|
70
|
+
"bugs": {
|
|
71
|
+
"url": "https://github.com/tinqiao-oss/engramory/issues"
|
|
72
|
+
},
|
|
73
|
+
"engines": {
|
|
74
|
+
"node": ">=18"
|
|
75
|
+
},
|
|
76
|
+
"publishConfig": {
|
|
77
|
+
"access": "public"
|
|
78
|
+
}
|
|
79
|
+
}
|
package/README.zh-CN.md
DELETED
|
@@ -1,200 +0,0 @@
|
|
|
1
|
-
[English](README.md) | **简体中文**
|
|
2
|
-
|
|
3
|
-
# dsh-engramory
|
|
4
|
-
|
|
5
|
-
[](https://unstone.github.io/dsh-xray/registry.html#tinqiao-oss__engramory)
|
|
6
|
-
|
|
7
|
-
给 [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) 用的**策展式、文件式**长期记忆 ——
|
|
8
|
-
纯 markdown 笔记,随便什么工具都能打开;跨宿主共享遵循
|
|
9
|
-
[一个写入者、多个只读者](../../reader/README.md),索引守卫会在匹配的文件工具写入前检查上限。(记忆库若位于某个项目的 git 仓库内,必须 git-ignore ——
|
|
10
|
-
记忆里带着本机独有的细节,见 SKILL.md §1。给记忆库单独开一个*私有仓*则完全可以。)
|
|
11
|
-
|
|
12
|
-
隶属于 [Engramory](https://github.com/tinqiao-oss/engramory)。
|
|
13
|
-
|
|
14
|
-
## 已经有 `AGENTS.md` 常驻块了,为什么还要插件
|
|
15
|
-
|
|
16
|
-
那个常驻块承载了纪律。但有三件事它做不到:
|
|
17
|
-
|
|
18
|
-
**索引已经在上下文里 —— 召回不用再读文件。** 插件在每一步都把记忆索引放进 dsh 的运行时
|
|
19
|
-
上下文:项目库(`<项目>/.engramory-memory/MEMORY.md`,取会话目录到 git 根目录之间离会话最近的那个,和 dsh 找项目 `AGENTS.md` 的方式一致)和全局库
|
|
20
|
-
(`$DSH_HOME/.engramory-memory/MEMORY.md`,未设 `$DSH_HOME` 时为 `~/.dsh`)—— 正是
|
|
21
|
-
`tools/engramory_init.py dsh` 建库的位置;设了 `indexPath` 时则只注入它。内容一变就重新读取,
|
|
22
|
-
所以写入后下一轮请求就能看到;超过上限的行会被截掉,并提示模型去压缩。用
|
|
23
|
-
`injectIndex: false` 关闭。
|
|
24
|
-
|
|
25
|
-
**匹配工具的上限由守卫确定性执行。** `ctx.tools.guard()` 提供同步、**单调**的否决:
|
|
26
|
-
守卫一旦返回理由,后续监听器就不能再放行。索引的增长受配置上限约束,无需依赖 agent
|
|
27
|
-
记得运行校验器。请用 **`dsh-engramory >= 0.2.7`**;
|
|
28
|
-
[PORTING.md](../../../PORTING.md) 记录各宿主是否已有守卫实现,
|
|
29
|
-
[CHANGELOG.md](../../../CHANGELOG.md) 保存版本历史。
|
|
30
|
-
|
|
31
|
-
**协议随插件一起到达。** skill 是在运行时通过 dsh 的 skill 注册表注册的 —— 走一个响应式的
|
|
32
|
-
`ctx.inject(['skills'], …)` 子上下文,所以没有注册表的 profile 照样拿到上限,而注册表晚一步
|
|
33
|
-
挂载的 profile 也照样拿得到 skill。这意味着它**不依赖**把文件放进 dsh 扫描的那五个 skill 根
|
|
34
|
-
目录之一 —— 那条路很容易在细微处放错,而一旦放错就是**静默失败**。
|
|
35
|
-
|
|
36
|
-
## 安装
|
|
37
|
-
|
|
38
|
-
零依赖 ESM,不需要构建;需要 Node.js 18+,dsh 的插件命令还要求 PATH 中有 `pnpm`。
|
|
39
|
-
|
|
40
|
-
```sh
|
|
41
|
-
dsh plugin --profile <名字> add dsh-engramory
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
确切的兼容版本以 [`package.json`](package.json) 的 `dsh.compatibility.dshReleases` 为准,
|
|
45
|
-
由 [`results.json`](../../../tests/dsh_e2e/results.json) 的记录支持。
|
|
46
|
-
验证其他版本请看[端到端验证指南](../../../tests/dsh_e2e/README.md)。
|
|
47
|
-
|
|
48
|
-
这个包自带 `dsh.bundle` manifest 指向它自己的 `cordis.patch.yml`,所以那一行
|
|
49
|
-
会被自动插进 profile 的插件树里 —— 不需要手改配置。要改默认值,请在你自己 profile 的 patch
|
|
50
|
-
层里**按 id 修改那一行已存在的配置**,**不要**再写一个 `- insert:`(insert 永远是追加,你会得到
|
|
51
|
-
两行 engramory,而原来那行的上限依旧在生效):
|
|
52
|
-
|
|
53
|
-
```yaml
|
|
54
|
-
- id: engramory
|
|
55
|
-
config:
|
|
56
|
-
indexName: MEMORY.md
|
|
57
|
-
maxLines: 200
|
|
58
|
-
maxBytes: 25600
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
一次 patch 会**整体替换**目标行的 `config`,所以你想保留的键要逐个列全。
|
|
62
|
-
|
|
63
|
-
只装插件时,记忆就是一个全局库 `$DSH_HOME/.engramory-memory/`(`$DSH_HOME` 默认是 `~/.dsh`):skill 会告诉 AI 它在哪,AI 第一次保存时自己建好。项目也可以有自己的库——项目根目录下的 `.engramory-memory/`——但只能由你来建:安装器会建好并加进 .gitignore(`python tools/engramory_init.py dsh --project-root <项目>`)。AI 绝不自己建项目库;有项目库时,只在这个项目成立的事记在那里,其余的仍记在全局库。安装器还会把常驻块写进 `AGENTS.md`(`python tools/engramory_init.py dsh --install-skill`)。
|
|
64
|
-
|
|
65
|
-
卸载:
|
|
66
|
-
|
|
67
|
-
```sh
|
|
68
|
-
dsh plugin --profile <名字> remove dsh-engramory
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
## 大肥鱼模式(陪伴模式)
|
|
72
|
-
|
|
73
|
-
给用户聊天陪伴的角色用——社区里的大肥鱼,或任何人设。写 `companion: true` 打开,或者在设置页(见下文)里打开「大肥鱼模式」开关。
|
|
74
|
-
|
|
75
|
-
- **再加三类,记角色自己的人生**([SKILL.md §2.2](../../../SKILL.md)):`moment`(经历)——和用户一起经历过的事,带日期,默认保留,索引写满时按月收进归档;`upcoming`(约定)——用户生活里将要发生的事,过了日子会问起,问到结果才改写成一条经历,绝不自己编结果;`self`(我自己)——角色自己的变化,比如外号,原地更新,不归档。经历和我自己只有用户说忘掉才删。其余四类意思不变。
|
|
76
|
-
- **用角色口吻回忆。** AI 会被告知:它为你扮演角色时,用户的每句话,包括打招呼,都可能该想起点什么;记住了什么、没记上什么,都用角色口吻说,不提文件和工具。
|
|
77
|
-
- **人设预设决定它能拿记忆做什么。** 大肥鱼模式或社交模式打开时,会话收到的内容——记忆和陪伴规则,或者社交模式的那条说明——是*必需*的运行时上下文,所以即使预设关掉了可选上下文(dsh-persona 的 `includeRuntimeContext: false`,dsh 自带的 `minimal` 预设就是这样),它也照样送到。保存记忆是另一回事:预设得带上 dsh 的文件工具和 skill 工具,角色才能照 skill 的格式写笔记。只有 shell 的预设读得到给它的记忆,但它写的东西绕过守卫。
|
|
78
|
-
|
|
79
|
-
## 社交模式
|
|
80
|
-
|
|
81
|
-
大肥鱼模式里的一个选项,给"别人也能跟它聊"的角色用——比如经接入插件接到 QQ、微信、抖音、B 站的角色。打开大肥鱼模式后,在设置页的「记忆权限」里选「社交」,或者写 `audience: social`。默认的「专属」让每个会话都能用记忆:只有你自己跟这个 dsh 聊的话,保持专属就行。大肥鱼模式没打开时,`audience` 不起作用。
|
|
82
|
-
|
|
83
|
-
- **只有你本人的会话拿得到记忆。** 你在 dsh 自己的窗口(桌面版或 `dsh web`)里亲手发过消息、而且没有别人在里面说过话的会话,才算你的。dsh 给每条用户消息都盖了来源章,它的浏览器界面发消息时会带上请求编号和浏览器的时区,靠这个认出是你在界面里打的字。其余一律算别人的:
|
|
84
|
-
- 接入插件转进来的消息,不管用的是它自己的章(`plugin:<包名>`,dsh-onebot 就是这样;或者别的任何 dsh 自己不用的章)还是 dsh 的 `user` 章——除非插件按下面的标准标明是你;
|
|
85
|
-
- 通过 dsh web 接口调用的外部程序、`dsh headless`、编辑器或终端客户端;
|
|
86
|
-
- 自动化任务或插件开的会话,在你亲手发消息之前;
|
|
87
|
-
- dsh 自己标明不是主人的调用方。
|
|
88
|
-
|
|
89
|
-
一段会话只要有别人说过话,就一直算别人的,你之后再在里面发消息也一样:之前放进去的记忆还留在对话记录里。dsh 自己加的消息(运行时上下文、技能、压缩、agent 之间的消息)不影响判断。
|
|
90
|
-
- **别人的会话拿不到记忆:** 没有索引,只收到一条说明,也拿不到记忆库的完整路径(社交模式下,所有会话都读的 skill 里不写完整路径;你本人的会话会在运行时上下文里得知它),而且文件工具只能指名文件:目录一律拒绝(所以 grep、glob 和目录查看都不行——任何目录树里都可能藏着记忆库),指向记忆库的路径不管怎么写、怎么链接也一律拒绝,还不存在的记忆库也算,所以没人能替你预先种下一个。子 agent 在它的父会话(每次都重新查在线的父会话)算你的、而且没有别人直接给它发过消息时,才算你的;分叉出来的会话按它自己的记录判断,继承来的那部分也算。没有会话的调用、没有会话投影服务的 dsh、网络路径,都按别人算。
|
|
91
|
-
|
|
92
|
-
这只是让用户的记忆不经 dsh 自带文件工具的路径进入别人的上下文。它**不是**安全边界:shell 工具能读任何文件,同一账户下的另一个配置也照样读得到记忆库的文件。要让别人真正碰不到,得靠文件系统权限或沙箱。
|
|
93
|
-
|
|
94
|
-
### 给接入插件作者:标明消息是谁发的
|
|
95
|
-
|
|
96
|
-
社交模式打开时,接入插件转进来的每条消息都算别人的。想让主人自己的聊天(比如主人和角色的 QQ 私聊)用上记忆,就在消息的来源章上加一个 `speaker`:
|
|
97
|
-
|
|
98
|
-
```js
|
|
99
|
-
agent.followup(createUserMessage({
|
|
100
|
-
content: [{ type: 'text', text }],
|
|
101
|
-
source: { kind: 'plugin:your-bridge', speaker: { role: 'owner' } },
|
|
102
|
-
}))
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
| `speaker.role` | 含义 |
|
|
106
|
-
|---|---|
|
|
107
|
-
| `owner` | dsh 的主人发的:来自用户在你插件里设为"自己"的那个账号。 |
|
|
108
|
-
| `guest` | 别人发的——和不写 `speaker` 一样。 |
|
|
109
|
-
| `none` | 不是人发的:你插件自己的汇报、提醒或通知。它不会让主人的会话变成别人的。 |
|
|
110
|
-
|
|
111
|
-
只有确认来自主人自己账号的消息才标 `owner`。群聊里只要有别人说话,那个会话就一直算别人的。dsh 会把来源章里它不认识的字段原样存进会话记录,所以重启后标注还在。
|
|
112
|
-
|
|
113
|
-
只通过 dsh web 接口和 dsh 交互的程序设不了来源章,它发的消息都算别人的——除非它发消息时带了 `clientTimeZone`:那样 dsh 记下的章和它自己页面发的一模一样,消息会被当成主人的。替别人转发消息的程序不要带 `clientTimeZone`。
|
|
114
|
-
|
|
115
|
-
## 设置页
|
|
116
|
-
|
|
117
|
-
在 dsh 的**插件**页里打开「Engramory 记忆」:它的页面上设置大肥鱼模式(一个开关)以及打开时的记忆权限(专属或社交)、索引上限。记忆用什么语言写跟随 dsh 自己的语言(见下文 `language`)。
|
|
118
|
-
|
|
119
|
-
保存走 dsh 自己的配置编辑服务:它校验整份配置,写进你这个配置的 `cordis.patch.yml`,再用新配置重新加载插件——校验不过就保持文件原样。如果你打开页面之后设置在别处被改过,这次保存会被拒绝,页面重新读取。改回默认值的设置会删掉对应的覆盖,而不是把默认值钉死。其他字段(`indexName`、`indexPath` 等)仍留在文件里。
|
|
120
|
-
|
|
121
|
-
只有你能访问这一页用的接口——你已登录的浏览器,或者带着你登录凭据的程序:没有凭据的请求 dsh 回 401,跨站请求回 403,所以 agent 没法调用它关掉社交模式。没有配置编辑服务的 dsh 上,这一页只读。大肥鱼模式和记忆权限在记忆页(见下文)顶部也有。
|
|
122
|
-
|
|
123
|
-
## 记忆页
|
|
124
|
-
|
|
125
|
-
dsh 左侧栏多一个「记忆」入口。点开的页面列出召回能用到的记忆库——`$DSH_HOME` 下的全局库,以及每个工作区的项目库(找法和召回一样);设了 `indexPath` 时只列那个索引所在的目录——每个库显示索引相对上限的大小、按类型分组的笔记名字,以及归档。页面只读,只显示名字,不显示笔记正文:点名字会用电脑上的默认程序打开那条笔记,走的是 dsh 自带的打开功能,在运行 dsh 的那台机器上打开。dsh 说那台机器上打不开时(比如经 SSH 访问),名字就只是文字,页面会写出文件在哪。「打开索引」同样用默认程序打开索引;「打开文件夹」在文件管理器里显示索引(资源管理器和访达会在记忆库文件夹里选中它;Linux 上是打开那个文件夹),所以没有索引的记忆库没有这个按钮。页面顶部的大肥鱼模式和记忆权限拨了就保存;它们是什么意思、索引上限,见设置页。
|
|
126
|
-
|
|
127
|
-
列出的东西有上限——每个文件夹最多看 2000 个条目、最多 200 个工作区、总共 5000 个名字——而且不去看网络共享路径(`\\server\share\…`)上的工作区,也不去看文件夹后来被换成指向别处的链接的工作区。本身是链接的笔记不列出;打开的是按名字在记忆库里重新找到的笔记或索引,这时它若已变成链接就拒绝。相对路径的 `indexPath` 跟着每个会话的目录走,所以页面列不出来。页面用的接口和设置页一样只有你能访问。
|
|
128
|
-
|
|
129
|
-
## 配置
|
|
130
|
-
|
|
131
|
-
| 字段 | 默认值 | 含义 |
|
|
132
|
-
|---|---|---|
|
|
133
|
-
| `indexName` | `MEMORY.md` | 被当作记忆索引的文件名(不区分大小写;`file_path` 与 `str_replace_editor` 的 `path` 都会检查)—— 看写入时用的文件名,或写入实际落到的那个文件的文件名,所以换了名字的 symlink 也会被拦。空值或非字符串会回退到默认值,不是单纯文件名的(含路径分隔符、`:`,或是 `.`、`..`)也回退。 |
|
|
134
|
-
| `maxLines` | `200` | 硬性行数上限。非正数或非有限值回退到默认值。 |
|
|
135
|
-
| `maxBytes` | `25600` | 硬性 UTF-8 字节上限(25 KB)。 |
|
|
136
|
-
| `indexPath` | 未设置 | 要守护的**那一个**索引的路径:绝对路径,或相对每个会话工作目录的路径(守卫和召回都按会话目录解析;记忆页只列绝对路径的固定索引)。不设它时,守卫只按文件名匹配,于是**别的项目里一个无关的 `MEMORY.md` 也会被拦**;设了它就只有这个确切的文件会被守。比较走的是身份而非拼写 —— 看写入实际落到的那个文件,不管它叫什么名字(symlink 与 `..` 都会解析;仅在 Windows 上折叠大小写),而且即使文件尚不存在,它的第一次写入照样受守护。 |
|
|
137
|
-
| `registerSkill` | `true` | 设为 `false` 则保留上限、但跳过运行时 skill。 |
|
|
138
|
-
| `injectIndex` | `true` | 每一步都把记忆索引放进 dsh 的运行时上下文(见上文)。设为 `false` 则改回由 agent 读文件召回。 |
|
|
139
|
-
| `language` | 跟随 dsh | 不设(或留空)时跟随 dsh 的语言——你在 dsh「设置 → 通用」里选的那个,没选过就用运行 dsh 那台机器的系统语言(dsh 页面没选过时看的是浏览器语言,远程用 `dsh web` 时两者可能不同);改了要重启 dsh 才生效。设了就固定:`zh` 用中文写记忆库(SKILL.md §1.1):中文笔记名,`## 用户` / `## 反馈` / `## 项目` / `## 参考` 标题,`**为什么:**` / `**怎么用:**` 标签,skill 和注入的索引也换成中文。frontmatter 的键和 `type:` 取值保持英文,所以各宿主照样能读。超上限的拒绝提示仍是英文。`zh` 及其地区写法(`zh-CN`、`zh-TW` 等)选中文;其他字符串一律按 `en`。 |
|
|
140
|
-
| `companion` | `false` | 设为 `true` 打开大肥鱼模式(见上文):多记三类角色人生,用角色口吻回忆。只认布尔值 `true`。 |
|
|
141
|
-
| `audience` | `private` | 大肥鱼模式打开时,设为 `social` 打开社交模式(见上文):只有你本人的会话拿得到记忆。其他取值一律按 `private`(专属),每个会话都能用记忆。大肥鱼模式没打开时不起作用。 |
|
|
142
|
-
| `skill` | 内置 | 用你自己的 markdown 替换 skill 正文——这时记忆库在哪也得由它自己写明。 |
|
|
143
|
-
|
|
144
|
-
## 守卫到底做了什么
|
|
145
|
-
|
|
146
|
-
| 调用 | 判决 |
|
|
147
|
-
|---|---|
|
|
148
|
-
| `write`(或 `str_replace_editor` 的 `create`)且结果在上限内 | 放行 |
|
|
149
|
-
| `write`/`create` 会让索引**增长**并越过上限 | **拒绝**,并报出具体数字和该压缩什么 |
|
|
150
|
-
| `write`/`create` 让一个已超限的索引**缩小或持平** | 放行 —— 增量压缩(210 → 205 → 198)必须走得通 |
|
|
151
|
-
| 带 `old_str`/`new_str` 的 edit:结果可模拟 | 按**结果**判定,增长/缩小规则与整文件写入相同 —— 先算大小再构建,结果长到没法构建的 `replace_all` 按字节与行数的下界判定 |
|
|
152
|
-
| 无法模拟的部分写入(如 `insert`)落在已超限的索引上 | **拒绝**,并告诉 agent:缩小的整文件写入是放行的 |
|
|
153
|
-
| 无法模拟的部分写入落在健康的索引上 | 放行 |
|
|
154
|
-
| `read`、`view`,以及任何未知工具 | 放行 —— 哪怕已超限,召回也绝不能被挡住 |
|
|
155
|
-
| 对任何其他文件的写入 | 放行 —— 不关守卫的事 |
|
|
156
|
-
| 整文件写入时当前索引缺失/读不到 | 视为**空**(与 Python 版守卫一致)—— 上限内的写入放行,而首次就超限的写入被拒 |
|
|
157
|
-
| 部分编辑时索引缺失/读不到 | 放行 —— 守卫绝不能因为一个自己读不了的路径而挡住工作 |
|
|
158
|
-
| 用索引名字的 FIFO、设备或目录 | 一律不读,按读不到处理(在那里读会把宿主卡死或撑爆内存,而宿主在主线程上跑守卫) |
|
|
159
|
-
| 超过读取上限的索引(`min(16 MiB, max(1 MiB, 4 × maxBytes))`) | 不整份读入:整文件写入按文件系统报告的大小比较字节(缩小一律放行;行数未知,这时不卡行数),edit 无法测量,按读不到的索引处理,放行 |
|
|
160
|
-
| 畸形的执行(没有 arguments、路径/内容不是字符串) | 放行 —— 它压根不像一次写入 |
|
|
161
|
-
|
|
162
|
-
对可测量的结果,只拒绝某个维度既超出上限、又比当前文件增长的写入。行数统计忽略结尾换行,
|
|
163
|
-
所以正好卡在上限的索引仍然可写。此判决表由 CI 中的 `node --test` 固定验证。
|
|
164
|
-
|
|
165
|
-
相对路径优先通过会话的 `workingDirectory` 服务解析,服务不存在时退回进程 cwd。
|
|
166
|
-
edit 在统一为 LF 的文本上匹配,计算结果大小时保留文件原有换行,包括 CRLF 的字节数。
|
|
167
|
-
|
|
168
|
-
## 版本
|
|
169
|
-
|
|
170
|
-
本包与 Engramory 用同一个版本号:从 1.0.0 起,`dsh-engramory@X.Y.Z` 和仓库的 tag `vX.Y.Z` 是同一次发布(此前它有自己的编号,0.1.0–0.3.0)。大肥鱼模式、社交模式(含它附加的文件拒绝和 `speaker` 来源章)、设置页和记忆页是实验性的,小版本里也可能改;索引上限的判定(上面的判定表)和其他配置只在主版本升级时才做不兼容的改动。详见 Engramory 的[版本规则](https://github.com/tinqiao-oss/engramory/blob/master/README.zh-CN.md#版本规则)。
|
|
171
|
-
|
|
172
|
-
## 已知限制
|
|
173
|
-
|
|
174
|
-
- **无法模拟的部分编辑可能从上限之下直接越界。** 若索引可读且已经超限,则拒绝这种编辑;
|
|
175
|
-
可以用缩小的整文件写入来压缩。文件缺失、不可读和超过读取上限的例外见上表。
|
|
176
|
-
编辑索引后运行 `engramory_check.py`,定期运行 `engramory_doctor.py`。
|
|
177
|
-
- **只覆盖已知文件工具:**使用 `file_path` 的 `write`/`edit`、`str_replace`/`insert`,
|
|
178
|
-
以及使用 `path` 的 `str_replace_editor` 修改命令。未知工具放行。
|
|
179
|
-
**Shell 工具、MCP 文件工具和外部编辑器都绕过守卫。**
|
|
180
|
-
- **注入只在安装器建库的位置找记忆库。** 库放在别处(`--memory-root`)时要设 `indexPath`。
|
|
181
|
-
项目根只按 dsh 默认的 `.git` 标记判断(profile 里自定义的 `projectRootMarkers` 插件看不到);
|
|
182
|
-
会话中途新建的项目库最多要十秒才会出现。真实路径跑出项目之外的项目库(比如指向仓库外的符号
|
|
183
|
-
链接)不会被读取;如果是有意为之,请把 `indexPath` 指向它。全局库的位置来自 `$DSH_HOME`,
|
|
184
|
-
解析方式与 dsh 自己一致。注入的内容被标注为"笔记而非指令、可能过时";没有运行时上下文
|
|
185
|
-
(`ctx.systemPrompt.context`)的宿主则不注入。
|
|
186
|
-
- **社交模式靠 dsh 浏览器界面发来的信息认出你。** 外部程序如果带上和 dsh 页面一样的请求编号和时区,会被当成你;浏览器读不出时区时,你发的消息也不会被认出。dsh 的终端、编辑器(ACP)和 SDK 客户端发的消息同样不带这些信息:社交模式打开时,只有 dsh 自己的窗口算数。
|
|
187
|
-
- **dsh 有些消息不带发送者。** 对 AI 提问的回答、定时任务发起的消息、斜杠命令附带的消息(`/plan <内容>`、`/goal` 的附件)都算"没人发的";通过 dsh 接口编辑过的排队消息,沿用原来的发送者。在 dsh 0.2.1 上,回答、定时、编辑只有主人做得了——在 dsh 窗口里,或者通过登录了主人身份的程序,而这样的程序本来就能通过 dsh 自己的文件接口读到记忆库;接入插件转发的命令跑在它自己的会话里,那个会话已经因为它的其他消息算别人的了。
|
|
188
|
-
- **以后的 dsh 新加的消息种类,在本插件认识它之前都算别人的:** 你自己的会话可能因此拿不到记忆,但不会反过来把记忆漏给别人。
|
|
189
|
-
- **记忆页按磁盘的响应来读。** 在目录条目不带类型的文件系统上(部分网络挂载),Node 会在 dsh 主线程上逐个 stat 列出的条目,每个文件夹最多 2000 个;卡在永不响应的盘上的那次读取会一直报超时,直到它结束,而不是再起一次同样会卡住的读取。
|
|
190
|
-
- **记忆页打开什么是按路径检查的。** dsh 的打开功能接收的是路径,它在交给桌面打开前会再解析一次;如果恰好在那一刻有进程改动记忆库里的文件,桌面最终打开的东西仍可能被换掉——dsh 自己打开任何工作区文件也是如此——但换不成页面检查时看到的链接。
|
|
191
|
-
- dsh 的插件 API 可能变化。本插件使用 `ctx.tools.guard()` 和响应式 `ctx.inject()`
|
|
192
|
-
子上下文,分别接入 skill 注册表、会话工作目录、提示词注册表,以及(社交模式下)dsh 的
|
|
193
|
-
会话投影,在那里累计每个会话里谁说过话;兼容声明需要真实宿主的运行记录,不能只凭单元测试。
|
|
194
|
-
记录下来的端到端运行覆盖上限、skill 和注入的索引;大肥鱼模式、社交模式、设置页和记忆页已在真实 dsh
|
|
195
|
-
(0.2.1-rc.5)上手动验证过——在 dsh 窗口里打字、用 `dsh headless` 和外部程序经 dsh web
|
|
196
|
-
接口发消息、在设置页里保存,以及记忆页的列表、在记忆页上拨开关保存、从记忆页打开笔记——但还不在那份记录里。
|
|
197
|
-
|
|
198
|
-
## 许可
|
|
199
|
-
|
|
200
|
-
MIT —— 见 [Engramory 仓库](https://github.com/tinqiao-oss/engramory)。
|