mirror of
https://gitcode.com/JianFeeeee/HomeAgent.git
synced 2026-11-01 06:47:29 +00:00
docs(rename-batch7): SDK 仓名引用统一为 hologramagentsdk，module 路径按发布 tag 保持旧名
SDK 仓已在 GitHub 改名为 JianFeeeee/hologramagentsdk（旧名 homeagentsdk 301 跳转，仓 id 与提交未变）。本批把仓内**指向该仓的引用**跟上： - 仓库链接 / 克隆地址 / 示例目录链接：homeagentsdk → hologramagentsdk （README zh+en、PLUGIN_DEV zh+en、OVERVIEW zh+en、site/index.html） - package-linux.sh 的 fallback clone URL 同步新名（仅 URL 与注释） - ci-cd-runbook：仓库表与 secret 配置命令用当前名，并注明历史改名点 **刻意保留旧名的三处**，都是事实而非遗漏： 1. Go import / go.mod replace 与文档里的 import 示例——已发布 tag （v1.3.0 及更早）的 go.mod 仍是 module github.com/JianFeeeee/homeagentsdk， 改了直接编译不过。PLUGIN_DEV 里加了显式注记说明这条边界。 2. gitcode 的 homeagentsdk → 404 实测行（那是实测事实表） 3. runbook 里「配置时还叫 homeagentsdk」的历史说明 实测（2026-10-22）：github.com/JianFeeeee/hologramagentsdk 的 /tree/v1.1.0、 /tree/v1.3.0、/blob/main/LICENSE 均 200；example/* 为 301→tree 200 （GitHub 对目录自动从 blob 跳 tree，非死链）；ls-remote 取到 refs/tags/v1.1.0 = 49f9957。 零代码改动：.go/.lua/go.mod/go.sum/third_party 变更数 0。
This commit is contained in:
xiao-zhai
xiao-zhai
@ -101,5 +101,5 @@ CLI 需要终端面板时，**订阅事件总线**（`EventTerminalOutput` + `Ev
|
||||
|
||||
- 内置插件（13 个）：webui / cli / agentcli / cfgmgr / healthcheck / kbtree / multimodal / pluginmgr / clawhubadapter / remotedevice / skillmgr / seemedia / seq
|
||||
- 判定标准：**只有必须使用内部 SDK 能力（公开 SDK 没有的接口面）的插件才内置**，其余一律外置为 .hmap 插件（详见 ARCHITECTURE「内置插件的判定标准」）
|
||||
- 外部插件示例（[homeagentsdk](https://github.com/JianFeeeee/homeagentsdk) 仓库 `example/`，含 Go 和 Lua 两种类型）：qq / files / a2a / ai_image / bili / browser / calendar / editdoc / memo / music / ocr / rss / sanitizer / weather / luademo
|
||||
- 外部插件示例（[hologramagentsdk](https://github.com/JianFeeeee/hologramagentsdk) 仓库 `example/`，含 Go 和 Lua 两种类型）：qq / files / a2a / ai_image / bili / browser / calendar / editdoc / memo / music / ocr / rss / sanitizer / weather / luademo
|
||||
- 打包分发：`.hmap` 插件包格式，通过 WebUI 安装
|
||||
|
||||
@ -9,13 +9,19 @@
|
||||
HologramAgent 的所有外部交互能力都来自插件。插件通过 `PluginSDK`（Go API）与内核交互。
|
||||
|
||||
**SDK 仓库**：插件开发工具、模板代码和示例插件统一托管在
|
||||
[homeagentsdk](https://github.com/JianFeeeee/homeagentsdk) 仓库。
|
||||
[hologramagentsdk](https://github.com/JianFeeeee/hologramagentsdk) 仓库。
|
||||
|
||||
```bash
|
||||
git clone https://github.com/JianFeeeee/homeagentsdk.git
|
||||
cd homeagentsdk
|
||||
git clone https://github.com/JianFeeeee/hologramagentsdk.git
|
||||
cd hologramagentsdk
|
||||
```
|
||||
|
||||
> **仓名与 module 路径不是一回事**：仓 2026-10 已改名为 `hologramagentsdk`，
|
||||
> 但**已发布 tag（v1.3.0 及更早）的 go.mod 里 module 仍是**
|
||||
> `github.com/JianFeeeee/homeagentsdk`，所以 `import` 与 `go.mod` 里继续写旧
|
||||
> module 路径（下面示例即如此）。等 SDK 发新 tag 把 module 改成新名后，
|
||||
> 主仓与新插件再一起改 import。
|
||||
|
||||
每个插件实现一个三方法接口：
|
||||
|
||||
```go
|
||||
@ -49,7 +55,7 @@ type Plugin interface {
|
||||
### 安装
|
||||
|
||||
```bash
|
||||
cd homeagentsdk/tools/hmapdev
|
||||
cd hologramagentsdk/tools/hmapdev
|
||||
go build -o hmapdev
|
||||
# 将 hmapdev 加入 PATH 或直接使用
|
||||
# 也可从 SDK 的 release 附件下载预编译二进制（hmapdev_linux_amd64 等）
|
||||
@ -830,31 +836,31 @@ pmgr.ReloadPlugins() // 重载所有插件
|
||||
|
||||
## 七、示例插件参考
|
||||
|
||||
### SDK 仓库示例（`homeagentsdk/example/`）
|
||||
### SDK 仓库示例（`hologramagentsdk/example/`）
|
||||
|
||||
| 示例 | 类型 | 特点 |
|
||||
|------|------|------|
|
||||
| [weather](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/weather) | Go | 天气查询（wttr.in），演示 NoMemory/Cleaner/阶段钩子/通道/文本记忆 |
|
||||
| [luademo](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/luademo) | Lua | Lua 全功能示例，覆盖 v0.8.0 Lua SDK 全部 API 面 |
|
||||
| [qq](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/qq) | Go | NapCat OneBot 对接，24 个工具，输入/输出通道完整对接 |
|
||||
| [memo](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/memo) | Go | 备忘管理，PreAction 注入 + 定时打断双提醒 |
|
||||
| [files](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/files) | Go | 文件系统操作，4 种写入模式，沙箱隔离 |
|
||||
| [browser](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/browser) | Go | 网络搜索、网页抓取（SSRF）、浏览器渲染（合并自 web/webfetch） |
|
||||
| [bili](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/bili) | Go | B 站视频下载（yt-dlp） |
|
||||
| [editdoc](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/editdoc) | Go | Office 文档编辑与格式转换 |
|
||||
| [a2a](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/a2a) | Go | Agent-to-Agent 协议 |
|
||||
| [ocr](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/ocr) | Go | 离线文字识别（Tesseract） |
|
||||
| [sanitizer](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/sanitizer) | Go | 输出清洗过滤器 |
|
||||
| [calendar](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/calendar) | Go | 日历管理 |
|
||||
| [rss](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/rss) | Go | RSS 订阅 |
|
||||
| [ai_image](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/ai_image) | Go | AI 图片生成 |
|
||||
| [music](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/music) | Go | 音乐播放 |
|
||||
| [vikunja](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/vikunja) | Go | Vikunja 任务管理对接（项目/任务/标签 CRUD） |
|
||||
| [vanblog](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/vanblog) | Go | VanBlog 博客发布与管理 |
|
||||
| [deepsearch](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/deepsearch) | Go | 多轮深度检索（逐层聚焦 + 引用汇总） |
|
||||
| [acp](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/acp) | Go | Agent Client Protocol 对接（外部编辑器/IDE 驱动本 agent） |
|
||||
| [recoverydiag](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/recoverydiag) | Go | 故障诊断五件套（分诊/sqlite 校验/日志签名/diff/结论排序），failback 模式的核心插件 |
|
||||
| [plugindev](https://github.com/JianFeeeee/homeagentsdk/tree/main/example/plugindev) | Go | 插件脚手架：生成工程、构建、安装，供 agent 自助开发插件 |
|
||||
| [weather](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/weather) | Go | 天气查询（wttr.in），演示 NoMemory/Cleaner/阶段钩子/通道/文本记忆 |
|
||||
| [luademo](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/luademo) | Lua | Lua 全功能示例，覆盖 v0.8.0 Lua SDK 全部 API 面 |
|
||||
| [qq](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/qq) | Go | NapCat OneBot 对接，24 个工具，输入/输出通道完整对接 |
|
||||
| [memo](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/memo) | Go | 备忘管理，PreAction 注入 + 定时打断双提醒 |
|
||||
| [files](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/files) | Go | 文件系统操作，4 种写入模式，沙箱隔离 |
|
||||
| [browser](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/browser) | Go | 网络搜索、网页抓取（SSRF）、浏览器渲染（合并自 web/webfetch） |
|
||||
| [bili](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/bili) | Go | B 站视频下载（yt-dlp） |
|
||||
| [editdoc](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/editdoc) | Go | Office 文档编辑与格式转换 |
|
||||
| [a2a](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/a2a) | Go | Agent-to-Agent 协议 |
|
||||
| [ocr](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/ocr) | Go | 离线文字识别（Tesseract） |
|
||||
| [sanitizer](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/sanitizer) | Go | 输出清洗过滤器 |
|
||||
| [calendar](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/calendar) | Go | 日历管理 |
|
||||
| [rss](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/rss) | Go | RSS 订阅 |
|
||||
| [ai_image](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/ai_image) | Go | AI 图片生成 |
|
||||
| [music](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/music) | Go | 音乐播放 |
|
||||
| [vikunja](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/vikunja) | Go | Vikunja 任务管理对接（项目/任务/标签 CRUD） |
|
||||
| [vanblog](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/vanblog) | Go | VanBlog 博客发布与管理 |
|
||||
| [deepsearch](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/deepsearch) | Go | 多轮深度检索（逐层聚焦 + 引用汇总） |
|
||||
| [acp](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/acp) | Go | Agent Client Protocol 对接（外部编辑器/IDE 驱动本 agent） |
|
||||
| [recoverydiag](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/recoverydiag) | Go | 故障诊断五件套（分诊/sqlite 校验/日志签名/diff/结论排序），failback 模式的核心插件 |
|
||||
| [plugindev](https://github.com/JianFeeeee/hologramagentsdk/tree/main/example/plugindev) | Go | 插件脚手架：生成工程、构建、安装，供 agent 自助开发插件 |
|
||||
|
||||
### 内置插件
|
||||
|
||||
@ -884,4 +890,4 @@ pmgr.ReloadPlugins() // 重载所有插件
|
||||
|
||||
*了解项目整体目标？查看 [OVERVIEW.md](OVERVIEW.md)。*
|
||||
*了解技术架构？查看 [ARCHITECTURE.md](ARCHITECTURE.md)。*
|
||||
*SDK 仓库与开发工具？查看 [homeagentsdk](https://github.com/JianFeeeee/homeagentsdk)。*
|
||||
*SDK 仓库与开发工具？查看 [hologramagentsdk](https://github.com/JianFeeeee/hologramagentsdk)。*
|
||||
|
||||
Reference in New Issue
Block a user