mirror of https://gitcode.com/JianFeeeee/HomeAgent.git synced 2026-11-01 23:07:30 +00:00

Files

JianFeeeee 7f43a6bfc7 docs: 重写 README，中英文对齐，历史移入 CHANGELOG

## 问题：README 像架构文档，不像 README

原文 420 行，开头第一句是「以核心域与应用域分离为设计原则的 Agent 框架」。
读者点进来想知道「这东西能给我干什么」，得到的是一句需要三分钟才能理解的定义。

量化一下 AI 味的几个典型指纹：

| 指标 | 改前 | 改后 |
|---|---|---|
| 加粗标记 | **230** 处 | 56 处 |
| 破折号插入语 | **17** 处 | 0 |
| 行数 | 420 | 204 |
| 「项目状态」占比 | 86 行（21%） | 移出 |

几乎每条 bullet 都是同一个模板：粗体术语开头 + 三行解释 + 收尾总结。
结构过度对称、每段都自我收尾，是 AI 写作最明显的痕迹。

## 改法：先说人话，再讲设计

开头四句：

> 一个能自己跑几个月、还记得住事的 Agent 内核。
> 说人话：你给它接上 QQ、WebUI、命令行、文件、浏览器，它就能在这些地方替你干活。
> 白天聊过的事，晚上还记得。三周前说过的偏好，不会因为上下文窗口滚动就丢了。
> 插件崩了它不倒，模型换了它不改。

然后把 `## 设计要点` 改成 `## 它跟别的 Agent 框架哪里不一样` ——从「我们有什么设计」
改成「你和别人有什么不同」。每条都给了**为什么这么选**，不是**我们做得多好**：

- 插件是独立进程 → 因为 `.so` 那套踩过 `dlclose` 空操作、cgo 超时杀不掉线程
- 内核不碰 IO → 好处不是干净，是能换掉整个交互层而不改内核
- 记忆会下沉 → 所以能跑几个月而不把历史全塞进 prompt

`## 能力` 不列 API，列「你能让它干什么」：说话的地方 / 看和听 / 动手 / 记住 / 调度。

## 删掉 227 行重复与历史

- **`## 架构图`（142 行）**：`ARCHITECTURE.md` 里已有完整的「消息处理流程」「7 阶段
  钩子」「三层记忆」，README 里这套是**逐字重复**。README 留一张 8 行流程图 +
  三段话讲清机制，细节指向架构文档。
- **`## 项目状态`（85 行）**：这是更新日志，不是 README。移入新建的
  `CHANGELOG.md` / `CHANGELOG_EN.md`。

## 中英文同步

`README_EN.md` 之前停在旧版式（439 行，含 `Architecture Diagrams` /
`Project Status`），与中文版结构完全不同 —— 不是这次才不同步，是**一直是两份不同的文档**。

本次按节 1:1 对齐（9 节完全一致），英文不是逐字直译，按英文习惯重写：

```
## 它跟别的 Agent 框架哪里不一样   →  ## What makes it different
## 能力                          →  ## What it can do
## 怎么工作的                    →  ## How it works
## 快速体验                       →  ## Quick Start
## 代码结构                       →  ## Code Structure
...
```

补上英文版一直**缺失**的 `## Quick Start` 整节（中文有、英文没有）。

## 顺带修正的事实错误

- 「内置 13 个插件」→ 实际 18 个插件目录（`webui`/`cli`/`files`/`cmd`/`mcp`/`kbtree`/`seq`/`skillmgr` …）
- 「参考 `example/` 目录下的 Go 和 Lua 示例」→ 26 个插件已迁到
  [github.com/HologramAgent](https://github.com/HologramAgent)，`example/` 只剩 2 个

## 验证

- 两版死链检查：`README.md` / `README_EN.md` 内部链接全部有效
- 9 个二级标题逐一对齐
- 破折号插入语归零（英文剩余 4 处全是列表分隔符）

2026-10-31 11:08:12 +08:00

10 KiB

Raw Blame History

⚠️ AI 辅助编程声明：本项目代码、文档及提交历史中，部分内容由 AI 辅助生成或修改。人工已审阅关键改动，但使用时请自行评估与验证。

HologramAgent

English: README_EN.md

一个能自己跑几个月、还记得住事的 Agent 内核。

说人话：你给它接上 QQ、WebUI、命令行、文件、浏览器，它就能在这些地方替你干活。白天聊过的事，晚上还记得。三周前说过的偏好，不会因为上下文窗口滚动就丢了。插件崩了它不倒，模型换了它不改。

./build/homed -data /tmp/ha      # 起来
./build/waiter                    # 跟它说话

硬件只需要一台 Linux。API 密钥在 WebUI 里填，存进本地 SQLite。

它跟别的 Agent 框架哪里不一样

插件是独立进程，不是动态库。 插件 panic 带不崩内核，还能自动重启。换个 plugin.bin 就生效，不用重装、不用重启。这不是架构洁癖：.so 那套踩过的坑够写一页（dlclose 被 DF_1_NODELETE 变成空操作、cgo 超时杀不掉线程、插件一崩整个 homed 陪葬），所以才改成子进程 + 共享内存。

内核自己不碰 IO。 不发 HTTP、不读文件、不连数据库之外的世界。 WebUI、QQ、命令执行、网络搜索全是插件。好处不是"干净"，是你能在不改内核的前提下换掉整个交互层。

记忆是会下沉的，不是一直堆在上下文里。 最近的留在窗口，旧的沉到文档层，再旧蒸馏进图数据库。所以它能连续跑几个月而不会把历史全塞进 prompt。

它记得的是"场面"，不是"会话"。 你把话题从工作切到生活，它按通道、对话对象、用到的工具、时段自动分场。同一个场面再次出现，上次的结论会被想起来，包括它自己说错过的那些。

安全是一堵墙，不是每个工具自己随手扫一下。 内核流出的请求、插件流回的数据都要先过它。密钥不进 prompt（执行前才回填）、工具黑白名单、敏感词预警、按主体授权（同一个 QQ 插件，群主和路人的权限可以不同）。

能力

不列 API，列你能让它干什么：

说话的地方：WebUI、CLI/TUI、QQ 群与私聊、其他 Agent（A2A）、IDE 里的 ACP
看和听：图片、视频、语音、屏幕截图、网页
动手：读写文件、跑命令、写代码、浏览器操作（含真实 Chrome）、日程、备忘、RSS、音乐
记住：三层记忆 + 图记忆 + 知识库，支持按场面召回
调度：一边跟人聊，一边把长任务派给子 agent 并行做；用户催了就插队，被打断的工作能接回去

28 个内置插件、89 个模型可调工具。外部插件一插件一仓，见 github.com/HologramAgent。

怎么工作的

homed（内核：LLM 编排 + 记忆 + 检索）
   ↑ PluginSDK
插件（WebUI / QQ / CLI / 文件 / 网络 / 一切 IO）

内核和插件之间三条通道：stdio JSON-RPC 管控制、共享内存管大块数据、事件环管通知。大对象不序列化、不拷两遍。

消息进来先过调度器，不直接喂给模型。排队的和插队的分开，插队分四级（"这有多不能等"），高级能抢占低级并保存现场。同级的排队等，不会互相踩。

然后进七阶段管道，模型可以连续调工具。同轮多个工具默认串行，要让它们并行，得由工具自己声明安全。批里有一个没声明，整批退回串行。

快速体验

make build build-cli
./build/homed -data /tmp/ha

# 交互模式
./build/waiter

# 或单条消息
echo "你好，记住我喜欢喝咖啡" | ./build/waiter

后台驻留模式（daemon）

waiter 也支持后台驻留，保持与 homed 的持久连接并等待 TUI 实例接入，适合让 agent 主动召唤用户/设备桥持续存活：

# 后台驻留（默认连 ~/.homeagent/cli.sock）
./build/waiter --daemon

# 指定 socket
./build/waiter --socket /path/to/cli.sock --daemon

# 随后任意 TUI/一行实例都会自动接入正在运行的 daemon，而不是直连 homed
./build/waiter

daemon 监听 ~/.homeagent/waiter.sock，新客户端连入时会回放缓冲的最近对话（256 行），断连后 daemon 持续存活、自动重连 homed，并保持设备桥（若配置了 device_gateway/device_token）。

API 密钥通过 WebUI http://localhost:8080 设置页配置，持久化在 SQLite 中。

代码结构

cmd/homed/          守护进程入口，组装所有子系统
cmd/waiter/         CLI 客户端（Unix socket）
internal/
├── agent/core/     Agent 核心：输入调度器（两类别+四级中断）、事件循环、LLM 工具循环、7 阶段管道、驻留子
├── agent/api/      LLM Provider（Lua 适配层：provider.go 调 vm）
├── memory/         三层记忆：Graph(SQLite) / Document(JSON+TF-IDF) / Text(JSONL) + StaticEmbedder(预训练词嵌入/TF-IDF回退) + CleanTemplateText(去模版)
├── knowledge/      知识库（文件系统 + TF-IDF）
├── plugin/         插件注册表 + 子进程加载器（stdio RPC + 共享内存段 + 事件环）
├── plugins/        内置插件（webui / cli / files / cmd / mcp / kbtree / seq / skillmgr …）
├── sdk/            PluginSDK（Tool/Stage/Event 三通道）
├── config/         SQLite 配置中心
├── events/         事件总线
└── internal/lua/adapters/   10 个 LLM 协议适配器脚本
外部插件开发见 [hologramagentsdk](https://github.com/JianFeeeee/hologramagentsdk) 仓库，使用 `hmapdev` 工具链开发，参考 `example/` 目录下的 Go 和 Lua 示例

文档

在线文档：

介绍站（项目总览）：https://introduce.homeagent.jianfgit.xyz/
插件 SDK 文档（快速开始 / API 参考 / 指南 / 示例）：https://sdk.homeagent.jianfgit.xyz/ 给 agent 直接读的纯文本入口：llms.txt / llms-full.txt

仓内文档（随代码版本走）：

项目概览 | English
技术架构 | English
插件开发指南 | English
Lua Adapter | English
知识库演示
设计文档索引 — 32 篇设计文档的状态分类与可信度规则
更新记录 — 每个版本实际改了什么
未来计划 — 没做的东西都记在这

下载

Releases 提供三种变体：

变体	内容	适用
full	homed + waiter + 桌面 GUI + systemd unit	单机全功能
server	homed + waiter + systemd unit	服务器（无桌面环境）
client	waiter + 桌面 GUI	连接远程 HologramAgent

Linux：.deb（amd64/arm64）、.rpm（x86_64）、.tar.gz
Windows：HologramAgent_v1.2.0_{Full,Server,Client}_win64.exe（NSIS 安装向导，含 AGPL 许可页）。自 v1.2.0 起因 homed 不再支持 Windows 原生（依赖 fd 继承与共享内存段内偏移解引用），安装器改为引导到 WSL2，并把 Linux 包送进发行版里按 Linux 方式安装。
免安装：homeagent-bin-<os>_<arch>.tar.gz（含 homed/waiter/initconfig）
校验：SHA256SUMS

macOS 的 homed 需在原生 macOS 构建（CGO + sqlite3），发布包仅含 waiter/initconfig。

构建

make build build-cli    # 编译守护进程 + CLI
make test               # go test ./...
make install            # 安装到系统

依赖：Go 1.25+, CGo (go-sqlite3), Linux。

homed 需 Linux（依赖 fd 继承与共享内存段的段内偏移解引用，见 cmd/homed/platform_windows.go）；Windows 上只构建 waiter.exe， homed 跑在 WSL2 里（见「下载」）。macOS 可构建 waiter/initconfig， homed 需在原生 macOS 构建。

许可

本项目以 GNU Affero 通用公共许可证第 3 版（AGPL-3.0-only） 发布，全文见 LICENSE。

它是 GPL 家族里传染性最强的一档：不仅分发时须提供完整对应源码， 通过网络提供服务时也要向使用者提供源码（§13 Remote Network Interaction）。即：任何人把改过的 HologramAgent 对外提供网络服务，都必须让该服务的使用者拿到改动后的源码。

插件与本项目通过公开 hologramagentsdk 静态链接（SDK 源码会进入插件二进制），但那个仓以 MIT 发布。MIT 是宽松许可，拿到授权的代码不继承本项目的 AGPL。因此外部插件不是本项目的衍生作品，作者可自行选择许可（含闭源、商业、私有），既不必同许可、也不受 §13 网络条款约束。第三方插件生态的安全与活跃正建立在这条之上。

边界很清楚：AGPL 覆盖内核与随包内置插件（homed、internal/、internal/plugins/ 下 13 个内置插件）； MIT 覆盖公开 SDK（sdk/，go.mod 零外部依赖、只依赖 Go 标准库，不引用内核任何代码）。子进程隔离在这里不重要了。决定许可的是被链接的 SDK 代码本身，而它是 MIT。

随包分发的第三方组件

组件	许可	位置
Chinese-CLIP ViT-B/16（ONNX 产物）	Apache-2.0	`/usr/lib/hologram/models/chinese-clip-vit-b16-onnx/`
ONNX Runtime（`libonnxruntime.so`）	MIT	`/usr/lib/hologram/onnxruntime/`
jieba 词库（内嵌进二进制）	MIT	源码 `internal/memory/jiebadict/`
Go 依赖（go-sqlite3、gojieba、bubbletea 等）	MIT / BSD-3 / Apache-2.0	均为宽松许可，与 AGPL-3.0 兼容

这些组件保持各自原有许可，不在本项目的 AGPL 授权范围内；发行包把它们的许可全文放在 /usr/share/doc/hologramagent/licenses/，并在 dep/rpm 元数据里声明本包许可为 AGPL-3.0-only。

10 KiB Raw Blame History Unescape Escape