ReMe/README_ZH.md at b8f48c800421dcd5192052bd94f1ec77025fd57d

scriptoriumadmin/ReMe

Fork 0

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

jinliyl c7dbf31c3f

docs: expand ReMe guides and agent integrations (#445 )

2026-08-11 13:31:11 +08:00

17 KiB

Raw Blame History

ReMe Logo

一个将对话和资料转化为可读、可编辑、可检索 Markdown 记忆的 Agent 记忆层。

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

🧠 ReMe 是一个面向 AI 智能体 的 local-first 记忆层。它把对话和资料沉淀为文件化长期记忆，并持续完成索引、链接和整理，让后续 Agent 能够可靠召回。

✨ 核心创新

Memory as File：以带 frontmatter 和 wikilink 的 Markdown 作为记忆节点，让用户和 Agent 都能直接读写。
自进化知识库：通过 Auto Memory、Auto Resource 和 Auto Dream，把对话与资料逐步加工为长期记忆，并自动建立 wikilink 关系。
渐进式混合搜索：融合 wikilink、BM25 和 embedding，支持从关键词匹配到语义召回、关系扩展的混合检索。
Agent 友好集成：通过 SKILL.md + CLI 接入，方便不同 Agent 读写、维护与复用记忆。

ReMe 设计理念

🔭 适用场景

Personal assistants：为 QwenPaw、 OpenClaw、Hermes 等个人助理提供用户可编辑的长期记忆层。
Coding agents：在接入 Claude Code 等 coding agent 时，跨会话保留代码风格、项目背景、仓库决策和流程经验。
LLM Wiki：把对话、笔记和资料转化为可检索、可追溯、可链接的 Markdown 知识库，由用户和 Agent 共同维护。
Self-evolving agents：帮助 Agent 从经验中学习，把成功路径、失败尝试、可复用流程和阶段性反思沉淀为记忆。

📰 新闻

[2026.08] - 基于 ReMe 的智能体工具使用经验驱动增强方法已发布，见 arXiv:2608.03403。
[2026.07] - 新增可选 Cookbook 工作流：每日论文用于论文发现与解析， Auto Fin用于结合财联社新闻和历史行情开展文件化 ETF 事件研究。
[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 ".[core]"

环境变量

如果需要 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 start

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

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

启动后可以检查服务状态；如果使用了自定义端口，请将下面 URL 中的 2333 替换为对应端口。

reme version
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]]

🧑‍🍳 Cookbooks

Cookbook 是由 ReMe jobs 和 steps 组装而成的可选端到端工作流。默认配置不会开启它们；启动 ReMe 时选择对应的独立配置即可启用。后续新增的 cookbook 会继续在表格中按行追加。

Cookbook	能力
每日论文	发现并排序论文，使用 Agent 解读 PDF，生成文件化论文笔记和五分钟简报。
Auto Fin	将财联社事件匹配到高流动性 ETF，研究历史反应并生成文件化研究报告。

📁 记忆系统

Memory as File, File as Memory.

ReMe 将 记忆视为文件，让原始对话和外部资料从 session/、resource/ 渐进加工到 daily/，再沉淀为 digest/ 中可长期复用的知识节点。

目录结构

<workspace_dir>/
├── metadata/       # 系统索引、图谱、catalog 等持久状态
├── session/        # 原始对话和 Agent session
│   ├── dialog/
│   │   └── <session_id>.jsonl
│   ├── agentscope/
│   └── claude_code/
├── resource/            # 外部原始材料
│   └── YYYY-MM-DD/
│       └── <resource>.<ext>
├── daily/               # 浅加工记忆：当天事实、对话摘要、资源解读
│   ├── YYYY-MM-DD.md
│   └── YYYY-MM-DD/
│       ├── <session_event>.md
│       ├── <resource_stem>.md
│       └── interests.yaml
└── digest/              # 长期记忆：个人事实、流程经验、知识节点
    ├── personal/
    │   └── {topic/event}.md
    ├── procedure/
    │   └── {topic/event}.md
    └── wiki/
        └── {topic/event}.md

ReMe 文件化记忆系统总览

🧭 记忆设计理念

捕获原始对话和资料，将其整理为长期偏好、可复用经验和有价值的知识，并让结果始终能被用户和 Agent 直接编辑。

自动记忆流程

ReMe 遵循 capture → index → consolidate → recall 的循环。对话和资料先变成 daily 记忆卡片；后台任务保持文件可检索； auto_dream 将稳定知识沉淀到 digest/；Agent 再通过搜索、wikilink 或 proactive topics 召回记忆。

能力	入口	作用	输出
`auto_memory`	Agent hook 或 `reme auto_memory`	提炼有长期价值的对话事实，同时保留原始 session。	`session/dialog/*.jsonl`、`daily/<date>/<session>.md`
`auto_resource`	资源监听或 `reme auto_resource`	将 `resource/<date>/` 下的文件转为带来源链接的 daily 卡片。	`daily/<date>/<resource-card>.md`
`auto_index`	后台监听或 `reme reindex`	维护 chunks、BM25 索引、wikilink 图谱及可选的 embedding 索引。	可检索的 `daily/`、`digest/`、`resource/` 内容
`auto_dream`	`dream_cron` 或 `reme auto_dream`	将变化的 daily 卡片整理为长期 personal、procedure 和 wiki 记忆。	`digest/**`、`daily/<date>/interests.yaml`
`proactive`	Agent 决定主动行动前调用 `reme proactive`	读取 `auto_dream` 生成的 topics；是否以及如何提醒用户由宿主 Agent 决定。	来自 `daily/<date>/interests.yaml` 的结构化 topics

🤝 Agent-friendly Integration

ReMe 既可以作为本地记忆服务，通过 CLI、HTTP API 或 MCP server 接入，也可以通过 Python API 嵌入宿主进程。不同 Agent 可以选择适合自身 runtime 的路径，并按需共享同一个本地 memory workspace。

Agent	推荐接入方式	接入后能力
QwenPaw	通过 Python API 在进程内嵌入 ReMe。	复用宿主应用的生命周期和模型配置，同时保持 memory 本地、文件化。
Claude Code	启动 streamable HTTP MCP service，并安装 plugins/claude_code/reme。	MCP recall tools、`reme-memory` skill，以及自动记录会话的 Stop hook。
Hermes	启动 HTTP service，并安装 plugins/hermes_agent。	在模型调用前自动召回相关记忆，并在每轮对话完成后异步调用 `auto_memory`。
Other CLI-capable agents (OpenClaw/Codex)	复制或安装 skills/reme_memory/SKILL.md。	通过 CLI 搜索、读取和写入记忆；自动记录需要宿主 Agent 显式接入会话生命周期。

集成演示

	Auto Memory	Auto Dream
QwenPaw
Claude Code

🛠️ ReMe Operations

ReMe 通过 CLI 暴露的统一 job interface 操作 workspace。Agent 通常只需要使用检索、读取、写入、编辑和自动记忆相关命令；更底层的索引、 frontmatter 和文件操作接口主要用于维护、调试或高级集成。完整 job 列表可以运行 reme help 查看。

命令	作用
`reme start`	启动本地 ReMe 服务。
`reme version` / `reme health_check`	检查包版本和组件状态。
`reme status`	查看有状态数据组件的内存估算及进程 RSS。
`reme search`	默认使用 BM25 和 wikilink 检索，启用后增加向量检索。
`reme read` / `reme write` / `reme edit`	检查和维护 Markdown 记忆文件。
`reme auto_memory`	将对话 messages 转为 daily 记忆卡片；需要 LLM 凭证。
`reme auto_resource`	将 `resource/` 下的文件解读为 daily 资料卡片；需要 LLM 凭证。
`reme auto_dream` / `reme proactive`	将 daily 记忆整理为长期 digest，并暴露值得关注的主题。
`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 中说明。
获取帮助：如需反馈 Bug 或功能请求，请使用 GitHub Issues；项目文档见 https://docs.agentscope.io/reme。

贡献者

感谢所有为 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 文件。

17 KiB Raw Blame History Unescape Escape