EverOS/README.zh-CN.md at main

25 KiB

Raw Permalink Blame History

目录

为什么选择 EverOS
快速开始
使用场景
文档
EverMind 生态
参与贡献

为什么选择 EverOS

EverOS 是面向 agents 和 makers 的 Python library 与 local-first memory runtime。它从 day one 开始就提供一层可携带的记忆层，让记忆穿过 coding assistants、apps、devices 和 workflows。它会把 conversations、files 和 agent trajectories 保存为可读 Markdown，并同步本地 SQLite 与 LanceDB 索引，用于快速检索和自进化复用。

Title	EverOS	Other Agent Memory Libraries
Markdown source of truth	✅ 标准 `.md` 文件：可读、可编辑、可 diff、可 Git 版本化	❌ 通常是 API、vector、graph、dashboard 或 database state
直接文件编辑	✅ 编辑 `.md`；cascade watcher 同步	❌ 通常需要 SDK、API、dashboard 或 backend update path
本地三件套	✅ Markdown + SQLite + LanceDB；不需要 MongoDB、Elasticsearch 或 Redis	❌ 常依赖 managed service、vector DB、graph DB 或 server stack
用户 + Agent 双轨	✅ 用户 `episodes/profile` 与 Agent `cases/skills` 是分离的一等记忆表面	❌ 通常围绕 chat history、profiles、entities、facts 或 retrieval records
正交检索作用域	✅ 按 `user_id`、`agent_id`、`app_id`、`project_id` 和 `session_id` 检索	❌ 通常按 app、namespace、tenant、thread 或 graph 来组织
Knowledge Wiki	✅ 可编辑、可溯源的 Markdown 知识页，支持 taxonomy、CRUD APIs 和 topic search	❌ 通常和 memory 分离，被锁在 dashboard 里，或者无法回溯到源文件
Reflection	✅ 离线记忆进化：在 session 之间合并 episode clusters，并持续改进 profiles 和 skills	❌ 通常只是 retrieval-only memory，缺少后台 consolidation 和长周期改进

快速开始

国内默认使用一个阿里云百炼 DashScope API Key，即可启动 EverOS、写入持久化记忆，并使用完整的文本检索能力。

前置条件

Python 3.12+
一个阿里云百炼 DashScope API Key

1. 安装

uv pip install everos
# or: pip install everos

2. 先体验独立 Demo —— 不需要 Key

在配置 provider 或启动 server 之前，先运行：

everos demo

这个命令会询问一条记忆和一个召回问题，然后打开全屏 terminal visualizer。它是 hardcoded 的本地 CLI 演示：不需要 API Key，不会启动或连接 EverOS server，也不会修改下面真实记忆流程的任何数据。

Animated EverOS demo preview showing the memory sphere moving through recall and confetti states

按 r replay，按 q 退出。非交互式预览可以使用 everos demo --plain；循环 showroom view 可以使用 everos demo --cinematic。Visualizer 的范围见 docs/everos-demo.md。

3. 初始化并配置百炼

everos init

这个命令会创建 ~/.everos/everos.toml 和 ~/.everos/ome.toml。打开 ~/.everos/everos.toml，配置下面的百炼 provider。

在百炼控制台创建一个华北 2（北京）地域的 DashScope API Key，并把同一个 Key 复用到三个文本 provider：

[llm]
model = "qwen-plus"
api_key = "<DASHSCOPE_API_KEY>"
base_url = "https://dashscope.aliyuncs.com/compatible-mode/v1"

[embedding]
model = "text-embedding-v4"
api_key = "<DASHSCOPE_API_KEY>"
base_url = "https://dashscope.aliyuncs.com/compatible-mode/v1"
dimensions = 1024

[rerank]
provider = "dashscope"
model = "gte-rerank-v2"
api_key = "<DASHSCOPE_API_KEY>"
base_url = "https://dashscope.aliyuncs.com"

Embedding 会启用 vector 和 user-hybrid retrieval；DashScope rerank 会进一步启用 agentic search、默认 agent-hybrid search 和 Knowledge Wiki。共享 DashScope host 仍支持北京地域的 Key；生产环境可以换成对应地域与业务空间的百炼专属 host。

如果希望更换 memory root，可以使用 everos init --root <path>。后续命令也要传入同一个 --root <path>。

4. 启动 EverOS

everos server start

保持服务运行，然后打开第二个 terminal 检查：

curl http://127.0.0.1:8000/health

确认响应里有 "status":"ok"。上面的百炼配置会显示 llm、embed 和 rerank 三个文本 capability 均可用。

5. 写入并搜索第一条记忆

[!NOTE] 业务接口位于 /api/v2。旧的 /api/v1 前缀仍然指向同一批 handler，已有集成不会受影响；但它只是兼容用的 legacy alias，未来的大版本可能移除 —— 新代码请直接使用 /api/v2。

添加一个很小的 conversation：

TS=$(($(date +%s)*1000))

curl -X POST http://127.0.0.1:8000/api/v2/memory/add \
  -H 'Content-Type: application/json' \
  -d "{
    \"session_id\": \"demo-001\",
    \"app_id\": \"default\",
    \"project_id\": \"default\",
    \"messages\": [
      {\"sender_id\": \"alice\", \"role\": \"user\", \"timestamp\": $TS, \"content\": \"I love climbing in Yosemite every spring.\"},
      {\"sender_id\": \"alice\", \"role\": \"user\", \"timestamp\": $((TS+10000)), \"content\": \"My favorite coffee shop is Blue Bottle in SOMA.\"}
    ]
  }"

在 session 结束时手动 flush 这条记忆：

curl -X POST http://127.0.0.1:8000/api/v2/memory/flush \
  -H 'Content-Type: application/json' \
  -d '{"session_id":"demo-001","app_id":"default","project_id":"default"}'

再把这条记忆搜索回来：

curl -X POST http://127.0.0.1:8000/api/v2/memory/search \
  -H 'Content-Type: application/json' \
  -d '{
    "user_id": "alice",
    "app_id": "default",
    "project_id": "default",
    "query": "Where do I like to climb?",
    "method": "hybrid",
    "top_k": 5
  }'

响应里应该能看到 Yosemite 相关记忆。完整百炼配置可以直接使用 hybrid search；也可以省略 method 字段，因为 API 默认就是 hybrid。

[!TIP] 第一条记忆已经写入。 你刚刚把一个事实交给 EverOS，把它整理进可持久化的 Markdown-backed memory，并通过本地索引把它搜索回来。这就是 EverOS 的核心闭环。想看看 source of truth？打开 ~/.everos，直接检查生成的 Markdown 文件。

一个百炼 Key 可以使用哪些能力？

配置	可用能力
百炼 `[llm]` + `[embedding]` + `[rerank]`	Keyword、vector、hybrid、agentic search；reflection、skill extraction、Knowledge Wiki
再添加 `[multimodal]` 和 parser extra	图片、PDF、音频、Office 文件摄取

/health 会列出缺失的可选能力。如果请求了尚未配置 provider 的功能，API 会返回明确的 HTTP 422。

[!NOTE] everos demo --live 和步骤 2 的独立 Demo 不一样：它会连接正在运行的 server，并执行真实的 add / flush / search 流程。它使用 hybrid search，上面的完整百炼配置可以直接运行。

可选：摄取多模态文件

如果要通过 /api/v2/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）。在 everos.toml 的 [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 demo --plain                  # 先体验本地 educational demo；不需要 API keys
everos init                          # 把一个百炼 DashScope Key 配置到 ~/.everos/everos.toml

everos --help
make test

使用场景

现在你已经完成了第一个成功的 EverOS moment，可以继续看看大家如何把持久记忆用在 agents、apps 和社区集成里。

这些使用场景展示了持久记忆可以在真实产品和工作流中带来什么能力。有些示例已经打包在本仓库中，另一些则指向外部 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 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 已可用；后端集成仍在进行中。