ReMe/README_ZH.md at b78e32ef03a996966571944ced09c3d89bde8605

scriptoriumadmin/ReMe

Fork 0

mirror of https://github.com/agentscope-ai/ReMe.git synced 2026-08-28 05:25:04 +00:00

jinliyl a457bf7542

docs: reorganize readme around agent integrations (#492 )

2026-08-26 19:30:16 +08:00

22 KiB

Raw Blame History

ReMe Logo

面向 AI Agent 的 local-first 自进化个人知识库。

历史版本：0.3.x · 0.2.x · MemoryScope

✨ 为什么选择 ReMe？

🧠 ReMe 将对话和资料持续沉淀为可读、可编辑、可检索、相互链接的 Markdown 记忆。QwenPaw、OpenClaw、Hermes 和 Claude Code 等 Agent 可以共享同一个 workspace，共同检索、维护和演化知识，而持久文件始终由用户掌控。

Memory as File, File as Memory：ReMe 使用带 frontmatter 和 wikilink 的普通 Markdown 保存持久记忆。用户和 Agent 都可以使用熟悉的工具查看、编辑、移动、同步和备份；索引及生成的元数据均可重建。
自进化知识库：ReMe 将对话和资料逐步加工为 daily note 与长期知识，在保留来源的同时，持续提炼事实、偏好、流程经验及其关系。
精准召回所需上下文。 ReMe 结合 BM25、可选 embedding 和 wikilink 展开，召回带行号的相关片段及其关系，无需把整个知识库塞入 Agent 上下文。
一个 workspace，可供不同 Agent 共同使用。 个人助理、coding agent 和其他 Agent runtime 可以通过原生集成、SKILL.md、CLI、 HTTP、MCP 或 Python API 共享同一个本地记忆空间。

ReMe 设计理念

📰 最新动态

[2026.08] - 发布 @agentscope-ai/reme，为 DeepSeek Harness 提供原生 ReMe 记忆集成。
[2026.08] - 发布 ReMe 博客，系统介绍本地优先的记忆架构、自进化工作流、混合检索、主动发现与评测结果。
[2026.08] - 基于 ReMe 的智能体工具使用经验驱动增强方法已发布，见 arXiv:2608.03403。
[2026.07] - 新增可选插件：每日论文用于论文发现与解析， Auto Fin用于研究最近 24 小时的主题相关财联社新闻，通过本地记忆搜索回顾历史材料并构建 wikilink。
[2026.07] - 我们的论文 Remember Me, Refine Me: A Dynamic Procedural Memory Framework for Experience-Driven Agent Evolution 已被 Findings of ACL 2026 接收。

🚀 快速开始

安装

ReMe 要求 Python 3.11+。

从 pip 安装：

pip install "reme-ai[core]"

从源码安装：

git clone https://github.com/agentscope-ai/ReMe.git
cd ReMe
pip install -e packages/reme_ai_studio -e ".[core]"
cd website
npm ci
npm run build:static
cd ..

静态构建要求 Node.js 22.13 或更高版本，并让源码安装可以直接使用 Studio。

启动服务

reme start

默认服务地址是 127.0.0.1:2333。如果端口被占用，可以指定其他端口：

reme start service.port=8181
# reme start workspace_dir=/tmp/reme-demo service.port=8181

reme version
reme health_check
reme help
curl -s http://127.0.0.1:2333/version -H 'Content-Type: application/json' -d '{}'

5 分钟记忆 Demo

服务运行后，可以写入一个记忆节点，让 ReMe 索引并检索它：

reme write \
  path=digest/wiki/quick-start-demo \
  name="Quick Start Demo" \
  description="第一个 ReMe 记忆节点" \
  content="# Quick Start Demo

ReMe 会把 Agent 记忆保存为可读的 Markdown。

相关链接：[[digest/wiki/memory-as-file.md]]"

reme search query="agent memory markdown" limit=5
reme read path=digest/wiki/quick-start-demo start_line=1 end_line=20

生成的文件是普通 Markdown，并带有 frontmatter：

---
name: Quick Start Demo
description: 第一个 ReMe 记忆节点
---

# Quick Start Demo

ReMe 会把 Agent 记忆保存为可读的 Markdown。

相关链接：[[digest/wiki/memory-as-file.md]]

ReMe Studio（可选）

上面的 core 安装已包含 Studio。启动 ReMe 后，打开 http://127.0.0.1:2333/ 即可浏览、编辑和搜索 workspace。如需为基础安装单独添加 Studio，可使用 pip install "reme-ai[web]"。源码构建、配置和开发说明见 ReMe Studio 指南。

可选模型配置

如果需要 LLM 驱动的记忆演化或 embedding 检索，可以配置环境变量。embedding 默认关闭，因此默认配置不会启动 embedding 模型，也不需要 embedding API key。

cat > .env <<'EOF'
# 可选：仅在配置中显式启用 embedding 组件后使用。
# EMBEDDING_API_KEY=sk-xxx
# EMBEDDING_BASE_URL=https://dashscope.aliyuncs.com/compatible-mode/v1

# 必须：auto_memory、auto_resource 和 auto_dream 需要 LLM。
LLM_API_KEY=sk-xxx
LLM_BASE_URL=https://dashscope.aliyuncs.com/compatible-mode/v1
EOF

基础文件读写、BM25 检索、wikilink 遍历和 proactive topics 读取可以先不配置 LLM 凭证。

Note

如需启用基于 embedding 的语义检索，请取消 reme/config/default.yaml 中 components.as_embedding 和 components.embedding_store 的注释，并将 components.file_store.default.embedding_store 从 "" 改为 default。完整说明见记忆检索文档。

🤝 将 ReMe 接入你的 Agent

ReMe 既可以作为本地记忆服务，通过 CLI、HTTP API 或 MCP server 接入，也可以通过 Python API 嵌入宿主进程。宿主集成可根据不同 runtime 的能力，将记忆指引、召回和捕获接入 Agent 生命周期。

Agent	推荐接入方式	接入后能力
DeepSeek Harness	使用 `dsh plugin --profile web add @agentscope-ai/reme` 安装 `@agentscope-ai/reme`。	长期记忆指引、`reme_search` 工具，以及自动捕获已完成的主 Agent 对话。
OpenClaw	使用 `openclaw plugins install @agentscope-ai/reme` 安装 `@agentscope-ai/reme`。	原生记忆工具、用户触发运行前召回和自动对话捕获。
QwenPaw	通过 Python API 在进程内嵌入 ReMe。	复用宿主生命周期和模型配置，同时保持记忆本地、文件化。
Claude Code	启动 streamable HTTP MCP service，并安装 ReMe 插件。	MCP 召回工具、`reme-memory` skill，以及自动记录会话的 Stop hook。
Hermes	启动 HTTP service，并安装 ReMe provider。	模型调用前召回，每轮对话完成后异步执行 `auto_memory`。
Codex 及其他 CLI Agent	安装或复制 ReMe Memory skill。	通过 CLI 搜索、读取和写入记忆；自动捕获需要显式接入宿主生命周期。

集成演示

	Auto Memory	Auto Dream
QwenPaw
Claude Code

🧠 ReMe 如何工作

Memory as File, File as Memory.

ReMe 将 记忆视为文件，让过滤后的对话来源记录和外部资料从 session/、resource/ 渐进加工到 daily/，再沉淀为 digest/。默认 workspace 是当前目录下的 .reme/；可通过 workspace_dir=... 选择其他由用户控制的位置。

Workspace 结构

<workspace_dir>/
├── metadata/       # 可重建的索引、图谱、catalog 和缓存
├── session/        # 对话来源记录和 Agent session
│   ├── dialog/
│   │   └── <session_id>.jsonl  # auto_memory 保存的来源消息
│   └── claude_code/
│       └── <session_id>.jsonl  # auto_memory_cc 使用的 ReMe 副本
├── mem_session/    # Agent wrapper 生成的 session/配置，不是用户记忆
│   ├── agentscope/
│   ├── claude_config/
│   └── codex/
├── resource/            # 外部原始材料
│   ├── <resource>.<ext>  # 根目录文件进入当天 daily 层
│   └── YYYY-MM-DD/
│       └── <resource>.<ext>
├── daily/               # 浅加工记忆：当天事实、对话摘要、资源解读
│   ├── YYYY-MM-DD.md
│   └── YYYY-MM-DD/
│       ├── <generated_name>.md  # 按主题命名的对话或资源卡片
│       └── interests.yaml
└── digest/              # 长期记忆：个人事实、流程经验、知识节点
    ├── personal/
    │   └── {topic/event}.md
    ├── procedure/
    │   └── {topic/event}.md
    └── wiki/
        └── {topic/event}.md

ReMe 文件化记忆系统总览

记忆生命周期

ReMe 遵循 capture → index → consolidate → recall 的循环。workspace 文件是持久化的事实来源，metadata/ 中的内容均可重建。

能力	入口	作用	输出
`auto_memory`	Agent hook 或 `reme auto_memory`	提炼有长期价值的对话事实，同时保留过滤后的对话来源记录。	`session/dialog/*.jsonl`、`daily/<date>/<generated-name>.md`
`auto_resource`	资源监听或 `reme auto_resource`	将 `resource/` 下的文件转为带来源链接、按内容命名的 daily 卡片。	`daily/<date>/<resource-card>.md`
`auto_index`	后台监听或 `reme reindex`	实时索引 `daily/` 和 `digest/` 中的 Markdown；全量重建还会扫描 `resource/` 和 JSONL。	可检索的 chunks、BM25、wikilink 图谱和可选向量
`auto_dream`	`dream_cron` 或 `reme auto_dream`	默认从最近两天内变化的文件中最多提取 5 个可复用 unit，再创建、印证、补充或修正 digest 节点。	`digest/**`、`daily/<date>/interests.yaml`
`proactive`	Agent 决定主动行动前调用 `reme proactive`	读取 `auto_dream` 生成的 topics；是否以及如何提醒用户由宿主 Agent 决定。	来自 `daily/<date>/interests.yaml` 的结构化 topics

搜索返回带行号范围的相关 chunks 和数量受限的 wikilink 邻居；可选向量结果通过 RRF 与 BM25 融合。

Important

proactive 只读取并暴露 Auto Dream 生成的兴趣主题，不会自行联网、发送通知或改写知识库；是否以及如何使用主题，由宿主 Agent 决定。

📊 评测结果

ReMe 通过 Agent 多轮搜索与读取的方式，评测多会话和超长上下文中的记忆能力。下表为仓库中已公开的参考实验结果；模型、prompt、数据集和评判细节见各评测文档。

基准	设置	样本量	Agentic 得分	主要检验内容
LongMemEval cleaned-s	整体	500 题	89.4%	跨会话检索、知识更新与时间推理
BEAM	100K 上下文	20 cases / 400 题	66.1%	十类长上下文记忆任务
BEAM	1M 上下文	35 cases / 700 题	65.0%	超长对话设置

在仓库的 π-Bench 评测中，ReMe Agent 在 5 种用户角色上的平均 PROC 得分为 0.580 ，比相同测试模型配置的 NanoBot 高 2.4%。PROC 用于评估隐藏意图完成、针对性澄清、跨会话偏好和规范复用、跨任务依赖推断以及欠规格请求推进等主动性能力。

🧩 扩展与工作流

插件是可选的独立 Python distribution，可以贡献 Component、Step、Job backend 和配置，并通过配置显式启用。每日论文与 Auto Fin 均已独立打包，源码 distribution 位于 plugins/。

插件	能力
每日论文	发现并排序论文，使用 Agent 解读 PDF，生成文件化论文笔记和五分钟简报。
Auto Fin	拉取主题相关财联社新闻，搜索 ReMe 历史材料并生成带 wikilink 的 Markdown 报告。

安装、查看、校验、启用和卸载 ReMe 插件的方法见插件管理。

📚 文档

下列文档覆盖主要使用流程，并以当前代码的运行时契约为准。

文档	主要内容
快速开始	安装 ReMe、启动服务，并执行首次文件和记忆操作。
Memory as File	理解 workspace 分层、frontmatter、wikilink、chunk 和文件事实来源模型。
Auto Memory	保留过滤后的对话来源记录，并提炼可复用的 daily 记忆卡片。
Auto Resource	导入支持的文本资料，转换为可追溯来源的 daily 卡片。
Auto Dream 与 Auto Link	将 daily 记忆整理为持续演化的 digest 节点和可读 wikilink 关系。
记忆检索	使用 BM25、可选向量、RRF 融合、行号范围召回和渐进式链接扩展。
Proactive	安全读取兴趣主题，并将其接入宿主 Agent 的决策流程。
Agent 接入场景	在 CLI/SKILL.md、HTTP、MCP 和嵌入式 Python 集成之间选择。
框架说明	理解 Application、Job、Step、Component、service、配置和生命周期边界。
ReMe 博客	了解完整产品故事、设计动机、使用示例和评测摘要。

🛠️ 常用命令

运行 reme help 可查看完整 job 列表。常用 workspace 与维护命令如下：

命令	作用
`reme status`	查看有状态数据组件的内存估算及进程 RSS。
`reme search`	默认使用 BM25 和 wikilink 检索，启用后增加向量检索。
`reme read` / `reme write` / `reme edit`	检查和维护 Markdown 记忆文件。
`reme traverse` / `reme graph_snapshot`	浏览 wikilink 邻域或按类别组织的 digest 图。
`reme chat`	与可感知 workspace 的只读 Agent 进行流式对话；需要 LLM 凭证。
`reme reindex`	基于已有文件重建检索和 wikilink 索引。

🤝 社区与贡献

问题反馈、需求与帮助：请先查看 Open Issues；如无相关讨论，可新建 Issue 说明背景、目标行为和影响范围。
代码贡献：改动前建议阅读贡献指南。架构与扩展方式以源码、schema 和测试为准。
文档贡献：用户可见文档请提交到统一文档仓库的 reme/<version>/{en,zh}/ 目录。
提交规范：建议使用 Conventional Commits，例如 feat(search): add link expansion option、 docs(zh): update quick start。
提交前检查：提交 PR 前请尽量运行 pre-commit run --all-files 和 pytest；如有依赖 LLM、embedding 或外部服务的测试无法运行，请在 PR 中说明。
项目文档：访问 reme.agentscope.io。

贡献者

感谢所有为 ReMe 做出贡献的朋友们：

📄 引用

@software{ReMe2026,
  title = {Remember me, Refine me: Memory Management Kit for Agents},
  author = {ReMe Team},
  url = {https://reme.agentscope.io},
  year = {2026}
}

⚖️ 许可证

本项目基于 Apache License 2.0 开源，详情参见 LICENSE 文件。

22 KiB Raw Blame History Unescape Escape