dsh-disk-cleanup
6starlong/dsh-disk-cleanup
DSH 插件:为 shell 命令注入临时目录与依赖缓存变量,给 scratch 目录补齐写权限,在系统提示里说明临时文件落点,并自动清理过期的临时文件。
安装
dsh plugin --profile web add github:6starlong/dsh-disk-cleanupREADME
dsh-disk-cleanup
DSH 插件:为 shell 命令注入临时目录与依赖缓存变量,给 scratch 目录补齐写权限,在系统提示里说明临时文件落点,并自动清理过期的临时文件与无主附件。
DSH 本身没有「临时文件目录」这个概念;模型写出的探针脚本默认都落在工作区内。这个插件提供统一的环境注入、scratch 目录授权、一段系统提示和一份过期清理,让临时文件有地方可去、也不会越攒越多;已删会话留下的图片也会按引用关系回收。
它做什么
四条机制:
| 机制 | 覆盖的情况 | 做法 |
|---|---|---|
| shell 环境注入 | 脚本内部用 tempfile / [System.IO.Path]::GetTempPath() 之类 | 在 pwsh / bash 命令串前设置 TMP / TEMP / TMPDIR,指向 <DSH_HOME>/cache/scratch |
| 权限补齐 | workspace-write 下 scratch 目录对受限子进程不可写 | 给会话注册可写根 + 给目录补访问控制项 |
| 系统提示 | 模型不知道该往哪写 | 加一段祈使句,点明 scratch 位置、临时文件写那儿、用户文件留在工作区;路径每次构建时现算,只读会话不出这段 |
| 过期清理 | scratch 只增不减,旧探针脚本一直留着;删会话后图片留在两处 | 按保留天数清 scratch 过期条目、请求图片缓存;原件先扫全部会话,只删零引用且过期的;清残留空目录,加载时与之后定期各扫一次 |
不改写任何工具入参的路径:模型给什么路径就写什么路径。要不要把临时文件放进 scratch 由提示词引导,不由插件替模型决定。
落点规则
| 权限模式 | scratch 目录 | 怎么让它可写 |
|---|---|---|
| workspace-write | <DSH_HOME>/cache/scratch | 给会话注册可写根(文件工具)+ 给目录补访问控制项(子进程) |
| danger-full-access | <DSH_HOME>/cache/scratch | 不需要,本来就能写 |
| read-only | 不启用 | —— |
任意可写模式 + 配置了 scratchDir | 配置里给的那个目录 | 同 workspace-write 的两步;这个目录不参与自动清理 |
<DSH_HOME> 默认 ~/.dsh,跟随 DSH_HOME 环境变量。所有可写模式都用同一个位置,工作区只留用户要的文件。
workspace-write 下写到工作区外面要两步授权,插件在会话创建时就做好:
sandboxPolicy.registerWritableRoot(session, dir)—— 让文件工具能写这个目录。AclWriteGrant(Windows)—— 用工作区自己的安全标识给目录加一条可写项,受限子进程也能写。
第 2 步只在 Windows 上做,复用工作区的安全标识,不加新身份、也不放宽到别的目录。补上的访问控制项是常驻的:插件卸载时只释放授权对象,不删这一项,否则下一个会话写 scratch 会被挡回去。任何一步失败就整体退到 <工作区>/cache/scratch。
过期清理
清 <DSH_HOME>/cache/scratch 里的过期条目与空目录,另外删 <DSH_HOME> 下一级的空目录:
- 删什么:
cache/scratch下的顶层条目,最后修改时间早于「现在减保留天数」的才删;目录整个删掉,含里面的内容。 - 空目录:
cache/scratch里自底向上删空目录(父目录因此变空也一并删),另外删<DSH_HOME>下一级的空目录;都只删没有任何条目的目录。 - 不删什么:只处理
<DSH_HOME>/cache/scratch与<DSH_HOME>下一级的空目录,不往其它子目录里递归;配置里自己指了scratchDir的,那个目录也不自动清,里面的东西未必可丢。 - 怎么算过期:看条目自己的最后修改时间,不看访问时间(Windows 默认不更新访问时间)。目录里某个子文件刚被写过,目录的修改时间会一并刷新,正在用的工作目录不会被误删。
- 何时清:插件加载时一次,之后每 6 小时最多再扫一次,进程重启等于重新起算。
- 单个条目删不掉(Windows 上被别的进程占着)就跳过,不中断整批。
附件残留
删会话后图片仍留在两个目录里,按各自的恢复成本区别处理:
- 请求图片缓存(
<DSH_HOME>/cache/attachments/request-images):按固定参数生成的派生图,删掉后下次请求会重建。直接按最后修改时间套用同一个保留天数。 - 原件(
<DSH_HOME>/attachments/v1/objects):删掉不可恢复。递归解压<DSH_HOME>/sessions下全部会话(含子会话),收集仍在引用的 id,只删「零引用」且「最后修改时间早于分界线」的。会话是按多个 zstd 帧连续写的,必须逐帧解压再拼起来;只解第一帧会漏掉消息里的全部图片引用。 - 原件的安全闸:会话根读不到、任何一个会话解压失败,或所有会话都读完却一个引用都没提取到,这三种情况整批跳过原件清理,不把「读不到」当成「没人用」。
- 首轮:第一次运行只统计原件并在日志里报数,不真删,之后才按上面的规则删。标记写在
<DSH_HOME>/cache/dsh-disk-cleanup/attachments。 - 单个文件读不到或删不掉就跳过,不中断整批。
在插件详情页的「过期清理」卡片里可以关掉自动清理,也可以改保留天数(1–365):天数留空恢复默认的 3 天。
安装
在 DSH 的插件管理页里安装,或者用命令行装:
dsh plugin --profile <profile> add dsh-disk-cleanup
安装后重启 DSH 生效。
配置
插件详情页(插件页点开某个插件后的那一页)上那张「过期清理」卡片管 autoCleanup 与 cleanupMaxAgeDays;其余字段在 profile 的 cordis.patch.yml 里覆盖:
- id: dsh-disk-cleanup
name: 'dsh-disk-cleanup'
config:
enabled: true
scratchDir: '' # 留空 = 默认暂存目录并自动清理;自定义目录不清理
injectShellTemp: true # pwsh/bash 的 TMP/TEMP 指向 scratch
grantProcessWrite: true # 给 scratch 补访问控制项,让子进程也能写
promptSection: true # 往系统提示里加一段说明
autoCleanup: true # 启动时清掉过期的临时文件(插件页也能改)
cleanupMaxAgeDays: 3 # 保留天数,1–365(插件页也能改)
测试
node --test "test/*.test.mjs"
node test/e2e-shell.mjs
plugin/scratch/cleanup:插件装配、纯函数与目录清理,覆盖 shell 包装、环境变量注入、可写根登记、提示词 section、过期判定、空目录清理与节流。attachments:多帧会话逐帧解压提取引用、请求图片缓存过期清理、零引用原件清理、首轮只统计、读不全或零引用时整批跳过。e2e-shell:生成的前缀真的交给 pwsh 执行,确认 TMP/TEMP 落到 scratch。client-probe:核对客户端产物lib/client.js能注册到插件页槽位、保存时写哪几个字段。
改 src/client/index.jsx 之后要重新生成 lib/client.js:
node scripts/build.mjs
工具包装
包装只覆盖 pwsh 与 bash,并处理两个情况:
- 目标工具可能比本插件晚注册(bundle 顺序不定)。
install()只给此刻已注册的工具装包装,只有真的注册成功才记进「已装」集合;还没出现的留白,由tools/change事件补装。 - 注册包装会触发
tools/change,监听器回头再调install()就是重入,会在同一作用域重复注册同名工具并抛错。用installingWeakSet 挡住。
边界
- 无
sandboxPolicy或 read-only:不注入、不建目录;清理照常。 - 共享 scratch 无权限:workspace-write 未自定义目录时退到工作区;danger-full-access 跳过注入。
- 非 Windows:不补访问控制项,仅 workspace-write 退到工作区。
- 工具被关掉就跳过,原
execute抛错原样透传,run_code不覆盖。 - 可写模式下
agent/created即建 scratch,read-only 不建。 - 只清 scratch;系统临时目录(
%LOCALAPPDATA%\Temp)里 DSH 自建的dsh-*不接管、不清理。 sandbox_permissions/justification原样透传。- 客户端注册失败只影响插件页卡片,其余照常。