Files
homeagent-sdk/example/plugindev/README.md
JianFeeeee 535922c6a0 feat(example): plugindev 插件 —— 把 hmapdev 工具链封装成 Agent 可调用的工具
用户要求:把 SDK 的 hmapdev 额外封装为 HomeAgent 插件并装上。

## 为什么

hmapdev 原本是"给人/CI 用"的命令行。做成插件后,Agent 能自己完成
「新建插件 → 构建 → 安装 → 重载」全流程(配合已有的 plugin_install / plgreload):

  plugindev_init → plugindev_build → plugin_install(path) → plgreload

## 工具面(5 个)

`plugindev_status`(可用性/版本/当前 SDK/工作区,排障首选)、
`plugindev_init`(脚手架,插件名约束 `[a-zA-Z0-9_-]{1,64}`)、
`plugindev_build`(在工程目录构建打包,返回产物路径与下一步提示)、
`plugindev_sdk`(SDK 版本 list/current/path/latest/install/use,`from` 支持本地源码)、
`plugindev_projects`(列出工作区已有工程与产物)。

## 安全边界(实现里落实)

- 只 exec **hmapdev 一个可执行文件**,不做 shell 拼接;
- `plugindev_build` 只接受含 `plg.json` 的目录 —— 这个工具不会变成"对任意目录跑构建";
- 子进程全部带超时;输出截断(6000 字符,保留首尾)后才返回,避免几百 KB 构建日志灌爆模型上下文;
- 工作区默认落在 `<data_dir>/plugindev`,配置可改。

## 现场验证

已在本机生产装上(`plugin_install` 带 path):5 个工具注册成功、
启动日志 `[plugindev] 就绪:hmapdev=/usr/local/bin/hmapdev 工作区=/home/newqqagent/plugindev`,
`hmapdev` 已装到 `/usr/local/bin/hmapdev`(版本 1.3.0)。
2026-09-13 14:17:06 +08:00

2.2 KiB
Raw Blame History

plugindev — 插件开发工具链Agent 可调用)

把 SDK 的 hmapdev 封装成插件,让 Agent 自己走完「新建插件 → 构建 → 安装」全流程, 不需要人来敲命令行:

plugindev_init    生成工程骨架(等价 hmapdev init <name> [--lua]
      ↓  改 plugin.go
plugindev_build   构建打包(等价在该目录 hmapdev build→ dist/*.hmap
      ↓
plugin_install    安装(用 path 指向刚构建出的 .hmapoverwrite=true 表示原地更新)
      ↓
plgreload         重载生效

工具

工具 参数 说明
plugindev_status hmapdev 是否可用/版本/当前 SDK 版本与路径/工作区;排查"为什么不能构建"先用它
plugindev_init namelang(go/lua)、dir 生成工程骨架;插件名必须 [a-zA-Z0-9_-]{1,64}
plugindev_build dirtarget 在工程目录构建打包;产物路径会在返回里给出
plugindev_sdk actionversionfrom SDK 版本管理list/current/path/latest/install/usefrom 可指向本地 SDK 源码
plugindev_projects 列出工作区里已有工程与产物

配置

默认 说明
hmapdev_path 自动查找 依次尝试:本配置项 → PATH → /usr/local/bin/hmapdev/root/go/bin/hmapdev
workspace_dir <data_dir>/plugindev plugindev_init 生成工程的默认目录
build_timeout_sec 600 单次 hmapdev 调用超时

前置:装 hmapdev

cd <sdk-repo>/tools/hmapdev && go build -buildvcs=false -o /usr/local/bin/hmapdev .
hmapdev version

安全边界(都在实现里,不只写在文档里)

  • 只 exec hmapdev 一个可执行文件,不接受任意命令、不做 shell 拼接;
  • plugindev_build 只接受含 plg.json 的目录("看起来是插件工程"才构建), 避免把这个工具变成对任意目录跑构建;
  • 子进程全部带超时,输出截断后才返回(构建日志动辄几百 KB直接回灌会撑爆模型上下文
  • 工程名约束与内核/上游对"进工具名的标识符"的规则一致([a-zA-Z0-9_-]{1,64})。