/dsh-retrace"`),放在同一个
`dependencies` 块里,再 `pnpm install`。
### 3. npm 包 + 组合文件(经典方式)
```sh
npm i dsh-retrace
```
在所使用的应用/部署的 `cordis.yml` 组合文件中加入一行普通插件条目:
```yaml
- name: 'dsh-retrace'
```
Client 半区会依据包内 `dsh.client` 元数据被自动打包进 Web 客户端(组合变化时会自动
重建客户端模块);Host 半区为浏览器 UI 注册同源 HTTP 路由 `/api/plugins/retrace/*`。
### 4. 动态插件(当前会话,免安装、免重建)
包内提供了两个自包含的动态入口:
1. 打开插件编辑界面,用 `lib/dynamic-host.js`(Host 半区)和
`lib/dynamic-client.js`(Client 半区)新建插件;
2. 批准并运行 Client 半区;
3. 完成 —— 悬停任意助手回复或用户消息,即可使用 ↩ / ✎ / ↻。
动态 Host 通过 `harness.handle` 注册同一组操作
(`retrace.recall` / `retrace.editAndResend` / `retrace.regenerate`)。
### 5. 依赖与权限
- DeepSeek Harness 需提供 `package.json` 里声明的 peer 包
(`@deepseek-ai/dsh-session`、`@deepseek-ai/dsh-client-*`、`cordis`、`react` ——
当前构建面向 `0.1.7-rc.2` 这一代内核)。
- `dsh-log-contract >= 0.3.18`(作为依赖自动安装)。
- 插件通过 `inject` 声明所需宿主能力
(`sessions`、`agents`、`webServer`、`fs`、`subprocess`、`sandboxPolicy`、`jobs`)。
缺某个能力只会让对应功能降级(例如没有 `subprocess` ⇒ 回档只用内置快照),
不影响启动。
---
## 🔒 关闭守卫(防误关丢进度)
退出/重载前先看清还有什么在跑:
| | 是什么 | |
|---|---|---|
| 🛡️ | **运行中检测** | 逐会话扫描运行中工作:agent 正在跑 / inbox 排队 / 后台 jobs / 未闭合轮 |
| 📋 | **运行中横幅** | 有运行中工作的会话显示页面常驻横幅(会话谱系标识 + 原因),退出前可见 |
| ⚠️ | **退出提示** | 插件 dispose(应用退出/重载)时中文提示列出每个运行中会话与原因——只提示,绝不代你取消 agent |
| 🔒 | **页面关闭阻止** | **桌面端一律不武装宿主原生确认框**;改用**页面自绘确认门**:先画框并**同步校验可见**才拦(`preventDefault`),画不出 / 不可见 / 页面不可见 ⇒ **当场放行**;确认框一直等你选择(Esc = 取消);**看门狗(Web Worker 计时器,不受后台节流)**只作最后一道。关掉设置项「退出确认(关闭守卫)」即退回官方形态(**不用重启**) |
| 🔎 | **查询面** | `retrace.runningState`(host RPC)+ `GET\|POST /api/plugins/retrace/runningState`(HTTP),两入口同形状;全会话形状另带宿主判定的承载面(`surface` / `quitVeto`) |
> **关闭确认的行为(用户可见口径)**:**是否弹宿主原生关闭确认由宿主与页面共同决定**。
> 桌面端**不弹宿主原生框**,改用**页面内自绘确认**(Esc = 取消)。框画不出来 / 框不可见 /
> 页面不可见 ⇒ **当场放行**。把设置里的「退出确认(关闭守卫)」关掉即退回宿主默认形态
> (**不用重启**)。
>
> **已知限制(照实写)**:某些桌面壳的退出口径**根本不经过页面**(如托盘项直接销毁窗口,
> 或点 X 只是隐藏窗口)⇒ 那类壳上「退出时弹确认」**插件侧做不到**,需要**壳提供 seam**
> (`will-prevent-unload` 处理,或退出前的询问钩子)。**桌面端退不掉时**,把设置里的
> 「退出确认(关闭守卫)」关掉即退回官方形态(**不用重启**)。
## ⚙️ 设置 → 通用
| 设置项 | 默认 | 说明 |
| --- | --- | --- |
| **编辑后显示原提问对照** | 开 | 重发消息下方的折叠「原输入」引用,显示**最近一次**被替换的原文(仅作对照,不会进入模型上下文)。 |
| **读档点与产物快照** | 开 | 开:每次撤回/编辑自动存一档(消息与触碰文件),提供读档点列表与产物回退;关:仅回退上下文,不存档、不追踪产物(最省资源)。 |
| **给旧内容生成 AI 摘要** | 关 | 开:撤回 / 编辑时多花 1 次小模型调用,为被丢弃的旧内容生成摘要;依赖宿主 `llm` 服务(官方 `@deepseek-ai/dsh-llm`),缺失时自动降级为**只显示逐字原文**。关:**零 LLM 调用**;逐字原文(零 token 成本)**始终产出**。每次操作至多 1 次小调用(输入文本上限 500 字符、输出 ≤200 token、5 秒超时),模型与凭据沿用会话自身的默认选择,插件**不新增任何配置面**。 |
| **启用 git 集成** | 开 | 开:工作区是 git 仓库时用 git 记录与回退(不自动提交、不动你的分支),非仓库可在读档点视图里一键启用;关:一律用内置快照(存于插件数据家),不触碰工作区 git 状态,功能等价。 |
| **读档点保留上限** | 50 | 文件快照只保留最近 N 个读档点,超出自动清理最旧的;读档点记录与审计痕迹始终保留。 |
| **退出确认(关闭守卫)** | 关 | 开:有运行中任务或未完成对话时,页面关闭前由本插件自绘确认框(Esc 等同取消)。默认关,因为这道门也会拦住应用内重载 —— 桌面端口径与自救方式见 [🔒 关闭守卫](#-关闭守卫防误关丢进度)。 |
设置里原有的「按标记隐藏被编辑/撤回的消息」与「编辑后从新对话开始」两个开关已撤除:
撤回/重发/重新生成恒隐藏被替换的内容(单个 marker 要隐藏超过 40% 的对话时降级为只显示提示,
历史永不静默消失),重发恒为「从这条重开」语义,兜底动作如上文所述。
---
## 🧠 工作原理
```
持久化日志(只追加) 模型上下文与视图
┌────────────────────────────────┐ ┌────────────────────┐
│ … 目标消息 │ │ … 目标消息 │
│ ↓ 阴影区间 │ │ ↓ 回退 │
│ [目标 … 最后一个表面节点] │ ──▶ │ (空 replace │
│ ↳ 追加一条替换型 │ │ = 上下文截断) │
│ assistant/message(空) │ agent.followup(新提示)
│ ↳ 可选「原提问」对照 │ → 下一轮基于回退后的历史重建请求
└────────────────────────────────┘ └────────────────────┘
```
1. **Host 核心**(`lib/host-core.js`,零运行时依赖):在会话的活跃表面中定位目标
消息,计算阴影区间 `[消息 … 最后一个表面节点]`,追加一条**空内容**的替换型
`assistant/message` —— 空助手消息是合法表面节点,但派生不出任何模型消息,
因此 LLM 上下文直接回退。
2. **重发 / 重新生成**:额外调用 `agent.followup(...)` 发送(新的)提示文本,
智能体的下一轮请求基于回退后的 `session.deriveMessages()` 构建。
3. **Client**(`lib/client.js`)注册:
- 每条用户消息下的 `user-actions` 对话节点(重发/撤回行 + 内联编辑器);
撤回后把原文回显到输入框,
- `recall-marker` 节点渲染器:提示行 + 注入 CSS 把被阴影化的消息行从对话流中
隐藏(视图与模型上下文保持同步),并可显示「原提问」对照块、**「恢复显示」按钮**
与**「真正恢复」**动作,
- `conversation.chat.assistant-actions` 中的 `retrace` 入口
(撤回/重新生成),
- **「读档点」视图**与 设置 → 通用 中的偏好开关。
> 这里有两个不同层面:**持久化日志**(只追加;旧事件从不被改写或删除)与
> **模型可见表面**(由追加的替换事件回退)。因此旧事件作为审计痕迹留在记录中——
> 但它们会被**同步地从模型上下文和可见对话中清除**,界面始终反映智能体真正看到的内容。
> 因为插件只追加合法、带类型的会话事件,持久化、投影与记录保持一致。(**真正恢复**是唯一
> 会改写日志的操作,且是原地改写、不改 seq 编号。)
---
## 🔺 兼容性与升级须知
`dsh-retrace` 是 **bundle 型插件**:它插进哪套宿主,就依赖那套宿主暴露的面。因此宿主
**移除**一个包或一个客户端服务时,**旧版插件即使一行没改也会坏** —— 而且症状通常是
「起不来」,不是「某个功能看起来不对」。
本节的目的:让你能分清 **宿主侧破坏性变更** 与 **插件侧缺陷**。提 issue 前请先看这节。
### 宿主侧变更须知
宿主升级偶尔会移除插件依赖的 API —— 这些是**宿主侧变化,不是插件缺陷**,一行一条:
- 升级后开机循环/恢复界面 → 切到干净会话并重启 DSH(插件降级而非阻断)。
- 版本/检查点面板为空 → `dsh plugin --profile add dsh-retrace` 刷新 bundle。
- 标题/重命名行为变化 → 自动标题路径由宿主守卫,手动重命名不受影响。
- 依赖下限:`dsh-log-contract >= 0.3.18`。
历史细节与原始报错见 [CHANGELOG.md](./CHANGELOG.md);兼容矩阵见 [docs/COMPAT.md](./docs/COMPAT.md)。
### 升级
```bash
dsh plugin --profile desktop add dsh-retrace@0.4.135
# 然后重启 DSH —— 插件不会热重载
```
**`0.4.27` 与 `0.4.31` 已撤回**(短暂发布后撤回、npm 上标记 deprecated);它们的替代版本
包含其全部修复。
**不需要数据迁移。** 会话格式未变(v3),不改写任何会话,也不需要重建索引:升级、重启即可。
若宿主仍提供旧成员,兼容访问器会让那些路径继续可用 —— 本构建不丢弃老宿主。
如果**升级后 App 起不来**:一个插件失败就能拖垮整棵树,所以**先恢复、再排查**:
1. 把 `dsh-retrace` 从 profile 的 `dsh.profile.bundles` **和** `dependencies` 里删掉,重启,
确认能先进得来;
2. 读宿主日志 —— macOS:`~/Library/Application Support/DSH Desktop/logs/host/dsh-<日期>.error.log`;
3. `plugin tree failed to load` 是**宿主侧**;`renderer boot failed` 是**客户端侧**。
两者都会点名出问题的插件/包 —— 从那里查起。
### 版本固定建议
请固定到确切版本(`dsh-retrace@0.4.135`),并让 `dsh-log-contract` 解析到 `>=0.3.18`。
**不要在跨宿主升级时依赖 `^0.4` 这种范围**:这里的兼容性由**宿主的面**决定,光看 semver 不够。
---
## ⚠️ 要求与限制
- 只有**用户消息**可以重发;撤回同时适用于用户与助手消息。工具结果会随区间一并被阴影化,
但不能单独作为撤回目标。
- 撤回若指向正在运行的一轮,会**先暂停**它(官方停止入口、有等待上限)。暂停失败/超时也
照常撤回,并用提示告知。**真正恢复**与回档预览要求会话**空闲**,否则被拒。
- 撤回/重发作用于**活跃模型表面**:已被压缩或此前已撤回的消息会被拒绝
(`target-shadowed`);写入尚未 flush 的消息会如实报 `message-pending`(「消息生成中」),
不再被误判成「已不在活跃对话」。
- 重新生成只重发原提示的**文本**部分;携带图片的提示会退化为仅文本重发。
- **真正恢复**会**原地**改写会话日志(中和两段标记,seq 编号不动)。会话是你当前正在查看的、
正在运行的,或文件被其他进程持有时,它会拒绝执行;成功后需重开该会话(或刷新)才看到结果。
---
## 🗺️ 路线图
> 详细下一步与方向:[docs/PLAN.md](./docs/PLAN.md) | 能力路线:[docs/ROADMAP.md](./docs/ROADMAP.md)
**当前已具备(0.4.x):**
- 撤回 / 重发 / 重新生成——每次回退都过**三层写前校验**与安全编辑路径(自动停 agent、临时 step 包裹 marker),**新的回退不会损坏日志、不新增 `/compact` 债**;**旧单段 marker 需要压缩前清理**(配套 `check` + `fix --remove-markers`)。
- **撤销**:恢复显示(界面)与真正恢复(日志层面、原地)。
- 单会话**读档点时间线** + **产物回退**(git 优先 + 快照兜底、干跑预览、跳转对话)。
- **关闭守卫**(运行中横幅、退出提示、页面自绘确认门)。
- **实时看门狗**——并发写入第一时间快照日志。
- 配套 **`dsh-log-contract`**:30+ 条离线契约规则 + 原地修复(`fix --neutralize` / `--clip-crossstep`),能处理会让 /compact 永久失败的会话。
- 供集成使用的只读宿主面:`retrace/versions`、`retrace/forkmap` 投影,
`GET /api/plugins/retrace/{versions,forkmap,lineage,event,surface,doctor,snapshot}`,
`POST /api/plugins/retrace/{rollback/preview,rollback,git/init}`,以及谱系标识操作
(`sessionBadge` / `setBadgeTitle` / `initBadgeTitles` / `badgeMap`)与 `retrace` CLI(见文末)。
**未来计划**——agent 业务层规划(运行时守护、中断治理、生态开放接口)**尚未发布**,此节是**计划**而非已上线能力。本 README 描述的是**开发线(main)**,可能领先于 npm 上最新发布版。
---
## 🛠️ 开发
```sh
# 目录结构
lib/host-core.js # 传输无关的 Host 逻辑(无 import)
lib/index.js # 发布版 Host:harness RPC + HTTP 路由
lib/client.js # Client 源码(import React;传输层可插拔)
lib/client.bundle.js # 构建产物 —— 自注册 loader entry
# (`window.__ModuleLoader__.load`),由 client-modules 提供
lib/dynamic-host.js # 生成的动态 Host 半区(源自 lib/host-core.js)
lib/dynamic-client.js # 生成的动态 Client 半区(源自 lib/client.js)
scripts/build-client.mjs # 打包 lib/client.js → lib/client.bundle.js
scripts/generate-dynamic.mjs # 从权威源生成两个动态入口
scripts/check-dynamic.mjs # 语法检查动态入口(函数体形态)
test/ # vitest 套件:host-core 操作 + 生成产物冒烟测试
.github/workflows/ # CI(语法 + 构建同步 + 测试)与 npm 发布(v* tag)
cordis.patch.yml # dsh.bundle profile patch 层
```
```sh
pnpm install # 安装开发依赖(vitest、esbuild);需要 Node >= 22.13
pnpm check # 语法检查源码与生成的动态入口
pnpm build # 重新生成 lib/dynamic-*.js 与 lib/client.bundle.js
pnpm test # 运行单元测试
npm pack --dry-run # 校验发布文件清单
```
> ⚠️ **生成文件。** `lib/dynamic-host.js`、`lib/dynamic-client.js` 与
> `lib/client.bundle.js` 是由 `lib/host-core.js` 和 `lib/client.js` 生成的构建
> 产物 —— **请勿手改**。CI 会在构建产物与源码不同步时失败
> (`git diff --exit-code`),因此提交前记得执行 `pnpm build`。动态 Client 与
> 发布版共用同一份 client 源码,仅通过 `__setMessageEditorWire` 切换传输层
> (`host.call` vs HTTP 路由)。
欢迎提交 PR 与 issue —— 问题追踪入口见本包
`repository`/`bugs` 元数据里的链接。
---
## 📚 生态
收录于 [dsh-plugin topic](https://github.com/topics/dsh-plugin)。
**Agent 业务层(生产级保证)** 的一部分——即 dsh-retrace 在 DeepSeek Harness 上实现的
那层框架无关的业务层定义。配套组件:
- [**dsh-log-contract**](https://www.npmjs.com/package/dsh-log-contract) —— 业务层的
「医生」:30+ 条离线契约规则 + 原地修复(`fix --neutralize` / `--clip-crossstep`)。
作为依赖自动安装,也独立发布供直接使用。
> **直接从 git 安装**(无需 npm registry —— 适合把本仓库链接丢给 AI,或想装最新提交):
>
> ```sh
> dsh plugin --profile desktop add github:/dsh-retrace
> # 或直接用 pnpm 装进 profile:
> cd "$DSH_HOME/profiles/desktop" && pnpm add github:/dsh-retrace
> ```
>
> `` 取本包 `repository` 字段里的 owner。然后照常重启 DSH Desktop,
> `dsh-log-contract` 依赖会自动带上。
DeepSeek Harness 插件生态的精选总览见
[awesome-dsh-plugin](https://github.com/awesome-dsh-plugin/awesome-dsh-plugin)
(第三方收录,使用前请自行确认可用性)。
---
## 👥 团队
由 [OfferKuai](https://www.offerkuai.com) 团队开发——一款 AI 求职助手,使命是
「用户要的是结果,而不是反复的对话」。本插件以开源形式发布,回馈 DeepSeek Harness 社区。
## 📄 License
MIT
---
## 🧭 会话日志考古(retrace CLI)
DSH 会话日志持久化了每次工具调用的完整输入输出——数据资产与审计资产。
`retrace` CLI 提供只读考古能力(复用 dsh-log-contract 的契约与提取):
```sh
retrace index # 工具调用索引
retrace query --cmd "seed-scale" # 按命令正则查输出
retrace extract --pattern "seed-scale" --out ./found # 导出输出
retrace file-history # 文件 write/edit 历史版本
retrace file-diff 0 5 # 两版本行级 diff
retrace lineage # 会话 parent 链谱系
```
`` 为完整日志路径或 sessionId(自动在**活动会话基座**查找:`$DSH_HOME/sessions`,
否则 `$DSH_SESSION_BASES` 各基座,最后才是 `~/.dsh/sessions`)。全部只读。
**会话谱系**:`GET /api/plugins/retrace/lineage?sessionId=` 沿当前会话的
`parentSession` 接续链遍历(只读、带环保护),与 CLI `retrace lineage` 同一语义 ——
任何客户端都能查到「这个会话是从哪个会话接着干/分叉出来的」,也是分叉拓扑的元数据源。
### 兼容性与运行契约(Compatibility & runtime contract)
| 项 | 声明 |
|---|---|
| **Node.js** | `>=20.0.0`(见 `package.json#engines`) |
| **DSH** | `>=0.1.5 <0.3.0`(见 `package.json#dsh.compatibility`;桌面与 Web 两种模式均支持) |
| **运行所需文件** | 运行时所需文件**全部随仓库提交**并在 `package.json#files` 声明(`lib/**`、`cordis.patch.yml`、README 等) |
| **单文件体积** | 每个分发文件 **< 256 KiB**(最大约 249 KB) |
| **构建产物** | 运行所需构建产物**随包提交**(`lib/client.bundle.js`、`lib/dynamic-client.js`、`lib/dynamic-host.js`);仓库内可复现:`pnpm i && pnpm build`(生成器 `scripts/generate-dynamic.mjs`、`scripts/build-client.mjs`) |
| **运行时依赖** | `dsh-log-contract`(日志契约校验)、`zod`(参数校验);**不联网、不下载额外代码** |
| **宿主依赖(peer)** | `@deepseek-ai/cordis` 与若干 `@deepseek-ai/dsh-*` 客户端包(由 DSH 提供,不由本插件分发) |
| **权限 / 外部服务** | 只读写本机会话数据目录与会话日志;**不访问外部服务、不上报数据**;不改动 DSH 安装目录之外的系统路径 |
| **失败边界** | 所有写入(撤回/编辑/恢复/回档)均在**目标文件之外先备份**、写后做帧级校验与折叠重放;失败即中止并保留原文件;不可判定时按"拒绝 + 可操作提示"处理,不静默降级 |
| **可回退** | 每个操作都有可逆路径;本地管理脚本可一键回退到上一快照 |
- 稳定标识由会话 id 确定性导出(无随机后缀);对同一会话重复读取得到同一个标识。