JJianFeeeeedocs(example): 为每个插件补 README

7ef9bc2a创建于 5 天前历史提交

文件	最后提交记录	最后更新时间
README.md	docs(example): 为每个插件补 README 此前 example/ 下 21 个插件里，13 个完全没有 README，另 4 个是 `hmapdev init` 生成的脚手架样板（`# <name>` + `plugin build` + `Install` 三行，等于从没被写过）。只有 deepsearch / vikunja / plugindev / luademo 是真实文档。本次为 17 个插件写了真文档（13 个缺失 + 4 个样板），现在 21 个全部有内容。 ## 写法每个 README 覆盖：能力一句话 → 为什么需要 → 工具表 → 配置项表 → 通道与钩子（有才写）→ 构建 → 已知边界。事实全部从源码读出来，不推测： - 工具名核对到注册点（含 `tp+"x"` / `p.name+"_x"` 前缀拼接，展开成最终名） - 配置键与默认值取自 `RegisterDef` / getStr 默认值 - 通道名、钩子名、依赖命令逐条 grep 确认 - 版本号与已部署实例交叉核对，17 个里 16 个一致 ## 几处按源码写、与直觉不同的点 - rss：订阅时会把抓到的历史条目一次性标为 seen，所以订阅一个源不会把历史文章全推一遍 —— 这是避免刷屏的关键，写进了文档。 - files：路径校验是两道（规范化后判断 + 解析符号链接后再判断），只做前者的话沙箱里的软链接就能逃逸。两种情况报错文案不同。 - qq：身份必须绑帧而非存插件全局，源码注释记录了由此产生的两个真实故障（中断抢占恢复后权限门整体失效、运行中到达的消息改写正在跑那一轮的身份）。多来源合并时权限取交集。硬私有工具按前缀一律拒绝。这些是安全关键，单独成节写清楚。 - memo：待办与备忘录刻意分两类（一提醒一不提醒），提醒注入带 NoMemory。 - sanitizer：不注册任何工具，只挂三个阶段钩子；依赖 ABI v2 的 stage 写回能力。 - editdoc：本目录是 v1.0.0（单工具），而线上跑 v2.0.0（全能版，源码未公开）—— 在文档开头显式标注，不按 v2 描述，避免读者以为这里就是线上那份。 ## 验证 - 21/21 文件非空且非样板（最小 913B，最大 6845B） - 逐个核对 README 中出现的工具名能在源码找到依据；5 处报警经复核全是误报（`ai_image_generate`/`music_` 前缀来自 metadata 的 name，`on_input` 等是钩子不是工具） - README 版本号 vs 线上 plugin.json：16/17 一致，editdoc 的差异已显式说明注：本仓既有未提交改动（example/qq/plugin.go、sdk/plugin.go）未纳入本次提交*。	5 天前
go.mod	examples: update weather with v0.8.0 API surface, add luademo Lua example, fix go.mod replaces	1 个月前
main.go	feat: sdk NoMemory/Cleaner + example build fixes - sdk/plugin.go: ToolDef adds NoMemory/Cleaner fields - sdk/plugin_test.go: unit tests for NoMemory/Cleaner - all example plugins: NoMemory/Cleaner annotated for each tool - plugindev/templates.go: template shows NoMemory/Cleaner pattern - plugindev/cmd_build.go: fix ensureGoMod, buildBundle/buildTarget sdkPath param, NewPluginFactory - example/go.mod: add external dependency declarations (chromedp, gofeed) - add main.go stubs for all example plugins	2 个月前
plg.json	example: 新增 acp(ACP 代理通信)、vanblog(VanBlog 博客管理) 插件; 多插件工具调用检测与清理改进; weather 移除 onRemove/文本记忆; plugindev 精简	1 个月前
plugin.go	example: 新增 acp(ACP 代理通信)、vanblog(VanBlog 博客管理) 插件; 多插件工具调用检测与清理改进; weather 移除 onRemove/文本记忆; plugindev 精简	1 个月前

files · 沙箱文件操作

读写与编辑文件，全部操作限制在沙箱目录内。

工具

工具	说明
`files_read`	读文件内容，支持 `offset` / `limit` 读大文件
`files_write`	写文件，自动创建父目录
`files_edit`	按精确字符串替换改文件
`files_ls`	列目录（目录名带 `/` 后缀）

files_edit 用 edits[] 传多组替换，每组 {old, new}：

每个 old 必须在原文件中恰好出现一次 —— 不唯一会报错，避免改错地方。
所有替换都针对原内容匹配，不要在同一个 edits 里写相互重叠的改动。

配置项

键	默认	说明
`dir`	空	允许访问的根目录。留空用默认沙箱（主数据目录下的 `files_sandbox`）。不建议设为 `/`

沙箱实现

路径校验不止一次，是两道：

规范化后判断：filepath.Abs + filepath.Clean，再用 withinSandbox 检查结果是否在根目录之下（/ 作为特例放行）。
解析符号链接后再判断：filepath.EvalSymlinks 求出真实路径，再查一次沙箱。

第 2 步是关键：只做第 1 步的话，沙箱内一个指向外部的软链接就能绕过限制（.../sandbox/link -> /etc）。报错文案也区分了这两种情况（path outside sandbox vs path escapes sandbox via symlink）。

对不存在的路径（write 会用到），求真实路径时只对已存在的部分做 EvalSymlinks，其余保留为未创建的尾部。

构建

hmapdev build