mirror of
https://gitcode.com/JianFeeeee/HomeAgent.git
synced 2026-09-21 09:28:14 +00:00
9b92a04230
README/架构文档仍在描述 C ABI 动态库加载，与 v1.0.0 实际实现不符。
新用户按文档走会去做 -buildmode=c-shared，产物新内核根本不加载。
README.md / README_EN.md：
- 设计要点补子进程架构段（三面通信、崩溃自愈、真热重载）
- 代码结构 plugin/ 描述：.so 动态加载器 → 子进程加载器
- 项目状态补 v1.0.0 条目（6 类缺陷 + 实测数字），v0.9.0 标注 ABI 已退场
- 新增「下载」章节：三变体对照 + 各平台包格式 + macOS 限制
assets/docs/{zh,en}/ARCHITECTURE.md：
- 四种加载方式表：外部 .so/C ABI → 外部子进程/握手+stdio JSON-RPC
- 加载流程改写为 exec.Command → 继承 fd → 握手 → init → start
- 内置 vs 外部对照表 7 行更新
- 新增「子进程插件的三个通信面」小节，含每个面的选择理由
assets/docs/{zh,en}/OVERVIEW.md：插件系统段落改写
deploy/ 发布脚本三处回归（v0.7.2 的 2c5f9ff 把 package/ 移到
deploy/packaging/ 使目录深度 1→2，但没改相对路径，此后两个版本
的发布都没有二进制资产）：
- build.sh：.syso 按目标平台 hide/restore（trap 兜底），恢复
windows 目标的 CXX，arm64 刻意不带 CXX
- installer.nsi：5 处 ..\build → ..\..\build，PRODUCT_VERSION 可注入
（原先硬编码 0.8.0）
- homeagent.spec：server 变体补装 waiter（control-server 声明了 CLI 却没装）
deploy/scripts/upload_assets.py：release 资产上传（两步签名 URL → OBS
PUT）。放 deploy/scripts/ 而非 scripts/，因为后者在 .gitignore 里。
支持 GITCODE_REPO/ASSET_DIR 环境变量以复用于 SDK 仓。
87 lines
6.0 KiB
Markdown
87 lines
6.0 KiB
Markdown
**中文** | [English](../en/OVERVIEW.md)
|
|
|
|
# HomeAgent — Project Overview
|
|
|
|
## What Is This
|
|
|
|
HomeAgent is a continuously-running personal intelligent Agent framework.
|
|
|
|
Core architecture: a long-running kernel process (`homed`) that connects to various IO channels (QQ, Web, CLI, etc.) through a plugin system. The kernel handles LLM orchestration, memory management, and knowledge retrieval; plugins handle all external IO — sending/receiving messages, file operations, web search, etc.
|
|
|
|
### Design Highlights
|
|
|
|
**Separation of Core Domain and Application Domain** — The kernel (core domain) performs no IO operations; all IO capabilities belong to plugins (application domain). The boundary is defined through PluginSDK:
|
|
- Plugins register tools (Tool) with the kernel for LLM invocation
|
|
- Plugins hook into the processing pipeline (Stage) to intercept/rewrite message flow at various phases
|
|
- Plugins subscribe/publish events (Event) for loosely-coupled communication
|
|
- Plugins queue or interrupt input delivery through IO API
|
|
|
|
The significance lies in clear responsibility boundaries: the kernel focuses on orchestration and memory management, while plugins handle IO implementation — the two are not coupled.
|
|
|
|
**Three-Layer Memory Architecture** — Manages information retention across long agent runtimes through a tiered storage strategy:
|
|
- **Context Layer**: In-memory pretrained word embedding scored event window (StaticEmbedder word vectors → CosineSimilarity, TF-IDF fallback), maintains recent context in real-time, low-relevance events automatically sink to the next layer
|
|
- **Document Layer**: JSON files + TF-IDF vector-indexed temporary memory, supports explicit submission and implicit archival, cold data distills to Graph
|
|
- **Graph Layer**: SQLite graph database, persists entities and relations, BFS traversal recall, distillation pipeline extracts triples from conversations
|
|
|
|
Three progressive layers — context, cold archive, long-term graph memory — form an information decay and consolidation pipeline from short-term to persistent storage.
|
|
|
|
## What It Actually Does
|
|
|
|
Code is in the project root, implemented in Go.
|
|
|
|
**Kernel** (`internal/agent/core/`):
|
|
- `eventloop.go` — Message loop (`eventLoop`), queuing input from the IO layer
|
|
- `process.go` / `stages.go` — Processing pipeline: memory recall → persona injection → LLM call → tool execution → output delivery, 7 stage hooks
|
|
- `toolcall.go` — Tool scheduling and execution
|
|
- `context.go` — Context management (pretrained word embedding scoring StaticEmbedder → CosineSimilarity, TF-IDF fallback), automatic pruning of low-relevance events
|
|
- LLM calls abstracted through Provider interface, supports 8 LLM sources with automatic fallback
|
|
|
|
**Memory System** (`internal/memory/`):
|
|
- **GraphDB** (`graph.go`) — SQLite, entities + relations tables, BFS traversal
|
|
- **Document Store** (`document/document.go`) — Temporary memory, JSON files + TF-IDF vector index, consume-on-read
|
|
- **Text Memory** (`text/text.go`) — Raw conversation logs, JSONL file rotation
|
|
- **Social Store** (`social/social.go`) — Persona traits + relationship network, wraps GraphDB
|
|
- **Memory Indexer** (`indexer.go`) — Auto-vectorizes GraphDB entities, recalls and injects into system prompt on user input
|
|
|
|
**Knowledge Base** (`internal/knowledge/knowledge.go`):
|
|
- File system directory `knowledge/<name>/content.md`
|
|
- TF-IDF vector search, independent index instance from the memory system
|
|
- LLM operates via three tools: `knowledge_search` / `knowledge_create` / `knowledge_list`
|
|
|
|
**Plugin System** (`internal/plugin/`):
|
|
- Built-in plugins: Go `init()` self-registration, compiled into kernel
|
|
- External plugins (since v1.0.0): compiled to an ordinary Go binary `plugin.bin`, spawned by the
|
|
kernel as an **independent subprocess**, communicating over stdio JSON-RPC (control plane) +
|
|
a shared memory segment (data plane) + an event ring (notification plane); Lua script plugins are
|
|
also supported (the C ABI shared-library channel, `-buildmode=c-shared`, was removed entirely in v1.0.0)
|
|
- PluginSDK (`internal/sdk/`) defines four channels: RegisterTool / RegisterStage / Subscribe / RegisterOutputChannel
|
|
- 7 stage hooks: on_input → pre_action → post_action → before_toolcall → after_toolcall → before_output → after_output
|
|
|
|
**LLM Provider** (`internal/agent/api/provider.go`):
|
|
- Provider interface: Name / Chat / ChatStream
|
|
- Three implementations: OpenAIProvider (standard OpenAI API), OllamaProvider (local), LuaAdaptedProvider (Lua adapter)
|
|
- LuaAdapter located at `internal/lua/adapters/`, each LLM source has a corresponding `.lua` script
|
|
- 8 built-in adapters: deepseek / openai / anthropic / gemini / mistral / groq / github / ollama
|
|
|
|
**WebUI** (`internal/plugins/webui/`):
|
|
- Embedded SPA dashboard (`dashboard.html` packaged via `//go:embed`)
|
|
- REST API: status query, configuration management, memory operations, knowledge management, plugin management
|
|
- OpenAI API-compatible `/v1/chat/completions` endpoint
|
|
- SSE event stream `/api/v1/chat/events`
|
|
|
|
**ClawHub Adapter** (`internal/plugins/clawhubadapter/`):
|
|
- Unified loader for OC plugins (Node.js), Python sidecar, JS sidecar, and SKILL plugins
|
|
- RegistryDispatcher pattern: routes registration notifications to Tool/Provider/Channel/Stage registries
|
|
- ClawHub marketplace search and install: `clawhubadapter_search` / `clawhubadapter_npm_install`
|
|
- 9 provider types mapped to LLM-accessible tools (image generation, web search, speech, etc.)
|
|
- OC channels auto-registered as IO devices with text/file/image/audio capability flags
|
|
|
|
|
|
## Project Status
|
|
|
|
Core functionality is operational. Plugin system and SDK are ready for independent external plugin development.
|
|
|
|
- Built-in plugins: webui / cli / timer / cmd / mcp / agentcli / healthcheck / pluginmgr / clawhubadapter / files / cfgmgr
|
|
- External plugin examples ([homeagent-sdk](https://gitcode.com/JianFeeeee/homeagent-sdk) repo `example/`, both Go and Lua types): qq / files / a2a / ai_image / bili / browser / calendar / editdoc / memo / music / ocr / rss / sanitizer / weather / luademo
|
|
- Distribution: `.hmap` plugin package format, installable via WebUI
|