EverOS/README.zh-CN.md at 0910affc7880a8c2adac7d4dea96b3d163dd213c

Files

Elliot Chen 28977ba295 docs(readme): polish repository presentation (#263 )

* docs(readme): refine repository watch section

Replace the Stay Tuned section with a clearer Watch EverOS call to action in both English and Chinese READMEs.

Remove the star GIF and keep star history as lighter social proof.

* docs(readme): improve highlights table spacing

Add spacing below each feature title in the EverOS highlights table.

Mirror the same table spacing in the Chinese README.

2026-06-06 21:47:35 +08:00

26 KiB

Raw Blame History

官网 · 文档 · 博客 · English

目录

EverOS 1.0.0 亮点
为什么选择 EverOS
快速开始
架构概览
存储布局
功能
项目结构
文档
使用场景
关注 EverOS
EverMind 生态
参与贡献

EverOS 1.0.0 亮点

Important

EverOS 1.0.0 是面向自进化记忆的一次重要发布。 它带来了 local-first 运行时、Markdown 作为 source of truth、混合检索、多模态摄取、用户记忆与 Agent 记忆作用域，以及由 EverAlgo 支撑的模块化算法。

欢迎 Watch 这个仓库。 下一阶段我们会继续推进记忆系统方法，包括 Wiki 式知识层和用于更深层离线进化的 Dreaming。

Markdown As Source Of Truth 所有记忆持久化为 `.md` 文件：可读、可改、可 grep、可 Git 版本化，也可直接用 Obsidian 打开。	Local Three-Part Stack Markdown + SQLite + LanceDB 在本地完成向量、BM25 和标量过滤检索，无需 MongoDB、Elasticsearch 或 Redis。	Dual-Track Memory Agent 记忆（`cases` / `skills`）与用户记忆（`episodes` / `profile`）独立提取，互不污染。
Multimodal Ingestion 文本、图像、音频、文档、PDF、HTML 和邮件统一抽取为可检索的记忆形态。	Self-Evolution 从真实使用经验中自动抽取共性 skills，重复模式沉淀为可复用流程，无需重训。	Orthogonal Retrieval 按 `user_id`、`agent_id`、`app_id`、`project_id` 和 `session_id` 五维独立检索。

为什么选择 EverOS

EverOS 是一个开源 Python 框架，用来构建跨 Agent、跨平台的自进化长期记忆。它为 maker 提供一层可携带的统一记忆层，适用于他们使用的每一个 Agent： Claude Code、Codex、OpenClaw、Hermes 等等。这样，上下文、决策、文件和 Agent 轨迹可以跟着工作流走，而不是被锁在某一个工具里。

EverOS 会把对话、Agent 轨迹和文件保存为可读 Markdown，并同步本地 SQLite 和 LanceDB 索引，以便快速检索。Agent 可以复用过去的 cases 和 skills，从重复工作流中自我改进，并逐渐变得更加主动。

系统围绕三个边界设计：

记忆内容保持可读 - Markdown 是长期、耐用的 source of truth。
运行时状态保持本地 - SQLite 跟踪状态；LanceDB 处理向量、BM25 和结构化过滤搜索。
算法保持模块化 - EverAlgo 负责记忆算法；EverOS 负责运行时、持久化、在线流程和离线进化。

快速开始

1. 安装 EverOS

uv pip install everos
# or: pip install everos

2. 初始化配置

生成一个 starter .env 文件，然后根据生成的注释填入 API key 字段。

everos init

everos init 默认写入 ./.env。也可以使用 everos init --xdg 写入 ${XDG_CONFIG_HOME:-~/.config}/everos/.env。

3. 启动服务

everos --help
everos server start

everos server start 会按以下顺序查找 .env：--env-file <path> → ./.env（当前目录）→ ${XDG_CONFIG_HOME:-~/.config}/everos/.env → ~/.everos/.env。端点栈兼容 OpenAI protocol（OpenAI / OpenRouter / vLLM / Ollama / DeepInfra）。你可以覆盖生成的 .env 中的 *__BASE_URL 来指向任意这些模型服务。

完整 walkthrough（添加对话、flush、search，然后读取 Markdown）见 QUICKSTART.md。

可选：摄取多模态文件

如果要通过 /api/v1/memory/add 的 content items 摄取非文本内容（image / pdf / audio / office documents），安装可选 extra：

uv pip install 'everos[multimodal]'   # or: pip install 'everos[multimodal]'

这会引入 everalgo-parser（包含用于 SVG 支持的 [svg] bundle，通过 cairosvg）并接入多模态 LLM client（.env 中的 EVEROS_MULTIMODAL__* 字段，默认通过 OpenRouter 使用 google/gemini-3-flash-preview）。

Office 文档支持需要 LibreOffice 作为系统依赖。 parser 会调用 soffice（LibreOffice 的 headless renderer），先把 .doc / .docx / .ppt / .pptx / .xls / .xlsx 转换为 PDF，再交给多模态 LLM。如果没有 LibreOffice，office 上传会返回 HTTP 415，并带有明确错误信息； PDF / image / audio / HTML / email 解析不受影响。

在提供 office 文档服务前，请先在宿主机安装：

brew install --cask libreoffice              # macOS
sudo apt-get install -y libreoffice          # Debian / Ubuntu

贡献者开发

git clone https://github.com/EverMind-AI/EverOS.git
cd EverOS
uv sync                              # creates ./.venv and installs deps
source .venv/bin/activate            # or prefix commands with `uv run`
everos init                          # fill the four API key slots in .env (two distinct keys)

everos --help
make test

架构概览

┌───────────────────────────────────────────────┐
│  entrypoints/  (CLI + HTTP API)                │  presentation
├───────────────────────────────────────────────┤
│  service/      (use cases: memorize/retrieve)  │  application
├───────────────────────────────────────────────┤
│  memory/       (extract + search + cascade)    │  domain
├───────────────────────────────────────────────┤
│  infra/        (markdown / sqlite / lancedb)   │  infrastructure
└───────────────────────────────────────────────┘
        ↑                    ↑
   component/            core/
   (LLM/Embedding)       (observability/lifespan)

DDD 5 层架构，单向依赖。详见 docs/architecture.md。

存储布局

~/.everos/
├── default_app/                  # app_id  ("default" → "default_app" on disk)
│   └── default_project/          # project_id ("default" → "default_project")
│       ├── users/<user_id>/
│       │   ├── user.md           # profile
│       │   ├── episodes/         # daily-log episodes (visible)
│       │   ├── .atomic_facts/    # nested facts (dotfile-hidden)
│       │   └── .foresights/      # predictive memory (dotfile-hidden)
│       └── agents/<agent_id>/
│           ├── agent.md
│           ├── .cases/           # one task case per entry
│           └── skills/           # named procedural memories
├── .index/                       # derived indexes (rebuildable from md)
│   ├── sqlite/system.db          # state + queue + audit
│   └── lancedb/*.lance/          # vector + BM25 + scalar
└── .tmp/                         # transient working files

在 Obsidian 中打开任意 <app>/<project>/users/<user_id>/ 文件夹即可。你的 Agent 大脑本质上就是一组文件。dotfile 目录（.atomic_facts/、 .foresights/、.cases/）默认保持隐藏，因此可见文件夹仍然是面向用户的记忆表面，而提取出的衍生信息则安静地放在旁边。

功能

混合检索: BM25 + vector（HNSW/IVF-PQ）+ scalar filter，在 LanceDB 中完成单次查询
级联索引同步: 编辑 .md → file watcher → entry-level diff → LanceDB sync，亚秒级同步
多源提取: conversations / agent trajectories / file knowledge
双轨记忆: user-track（Episodes / Profiles）+ agent-track（Cases / Skills）
异步优先: 完整 asyncio，单一 event loop
多模态: text + 小图片 / audio inline；大媒体通过 S3/OSS reference

项目结构

everos/                        # repo root
├── src/everos/                # main package (src layout)
│   ├── entrypoints/           # cli + api
│   ├── service/               # use case orchestration
│   ├── memory/                # domain: extract + search + cascade + prompt_slots
│   ├── infra/                 # storage: markdown + lancedb + sqlite
│   ├── component/             # cross-cutting: llm / embedding / config / utils
│   ├── core/                  # runtime: observability / lifespan / context
│   └── config/                # configuration data + Settings schema
├── tests/                     # unit / integration / golden / fixtures
├── docs/                      # design docs
└── .claude/                   # team-shared rules + skills (auto-loaded by Claude Code)

文档

docs/overview.md - 项目概览与愿景
docs/architecture.md - DDD 分层架构与依赖规则
docs/engineering.md - 工程与开发效率基础设施（CI / tooling / Claude Code）
docs/use-cases.md - 完整使用场景 gallery 和集成示例
docs/migration-to-1.0.0.md - Legacy API 与基础设施迁移说明
CHANGELOG.md - 发布记录
CONTRIBUTING.md - 如何贡献
.claude/rules/ - 详细代码规范（Claude Code 会自动加载）

使用场景

这些使用场景展示了持久记忆可以在真实产品和工作流中带来什么能力。有些示例已经打包在本仓库中，另一些则指向外部 demo 或集成，你可以研究并复用。

Reunite - 用 EverOS 找回连接

父母描述他们记得的线索，孩子描述他们残留的回忆。Reunite 使用语义记忆来浮现这些连接。

了解更多

Hive Orchestrator

面向 CLI coding agents 的 browser-native hive-mind。Claude Code、Codex、Gemini 和 OpenCode 作为真实 PTY 进程，通过团队协议协作。

代码

接入 EverOS 的 AI 编程助手

由 EverOS 驱动的通用长期记忆层，面向 AI coding assistants。

代码

AI Data Technician

一个 agentic AI 系统，可以从科学家的交互中学习，用于检查、分析和分类高维时间序列数据，并通过跨 session 改进的持久记忆持续变强。

代码

接入 EverOS 的 Rokid AI 助手

在 Rokid Glasses 中连接 EverOS，为你的智能活动启用长期记忆。

即将推出

带长期记忆的创意助手

拥有长期记忆的创意助手，让你的创作上下文可以跨 session 持续可用。

即将推出

Earth Online 记忆游戏

Earth Online 是一款 memory-aware productivity game，把日常计划变成一个持续生长的 quest log。

代码

多 Agent 编排平台

Golutra 为工程团队提供 multi-agent workforce，把 IDE 从单一 assistant 扩展为协同 agents。

代码

你的个人品鉴宇宙

通过沉浸式 3D 星图记录、可视化并探索你的 tasting journey。

代码

EverOS Open Her

构建有感受的 AI。开源 persona engine，让 personality 从 neural drives 中涌现，而不是来自 prompts。灵感来自 Her。

代码

面向个人记忆的浏览器 Agent

Ruminer 为 browser agent 带来持久记忆，让它能在不同网页任务之间携带个人上下文。

插件

EverMem 与 EverOS 同步

一条命令，把任意 AI coding CLI 连接到 EverMemOS 长期记忆。

代码

MCO - 编排 AI Coding Agents

MCO 为你的主 Agent 配备一个 agent team，让它们可以一起处理复杂任务。

代码

带自进化记忆的 Study Buddy

使用拥有 self-evolving memory 的 Agent，主动辅助学习。

代码

阿尔茨海默症记忆助手

通过高级记忆支持和日常辅助，帮助有需要的人更好地生活。

代码

记忆驱动的 Multi-Agent NPC 体验

一款 iOS 科幻悬疑游戏，玩家可以探索世界并揭开真相。

代码

Mobi Companion

一款 iOS app，用户可以创建、养成并与名为 Mobi 的个性化 AI companion 一起生活。

代码

带记忆的 AI 可穿戴设备

一个 context-native AI wearable，聆听日常生活，并把对话转换为记忆。

代码

Legacy OpenClaw Agent 记忆

已归档的 pre-1.0.0 plugin reference。新的集成应使用 EverOS 1.0.0 API。

了解更多

带记忆的 Live2D 角色

为实时 Live2D character 添加长期记忆，由 TEN Framework 驱动。

代码

带记忆的 Computer-Use

运行基于截图的分析任务，并把结果存入记忆。

在线演示

Game Of Thrones Memories

通过与 A Game of Thrones 互动问答体验，展示 AI 记忆基础设施。

代码

Claude Code Plugin

Claude Code 的持久记忆插件。自动保存并回忆过去 coding sessions 的上下文。

代码

记忆图谱可视化

在图界面中探索已存储的 entities 和 relationships。前端 demo 已可用；后端集成仍在进行中。