This commit is contained in:
jinli.yl 2026-06-22 10:10:00 +08:00
parent c389221b56
commit 3a6c087797

View file

@ -3,7 +3,7 @@
</p>
<p align="center">
<a href="https://pypi.org/project/reme-ai/"><img src="https://img.shields.io/badge/python-3.10+-blue" alt="Python Version"></a>
<a href="https://pypi.org/project/reme-ai/"><img src="https://img.shields.io/badge/python-3.11+-blue" alt="Python Version"></a>
<a href="https://pypi.org/project/reme-ai/"><img src="https://img.shields.io/pypi/v/reme-ai.svg?logo=pypi" alt="PyPI Version"></a>
<a href="https://pepy.tech/project/reme-ai/"><img src="https://img.shields.io/pypi/dm/reme-ai" alt="PyPI Downloads"></a>
<a href="https://github.com/agentscope-ai/ReMe"><img src="https://img.shields.io/github/commit-activity/m/agentscope-ai/ReMe?style=flat-square" alt="GitHub commit activity"></a>
@ -30,11 +30,11 @@
## ✨ 核心创新
- **Memory as files**:以带 frontmatter 和 wikilink 的 Markdown 作为记忆节点,让人和 Agent 都能直接读写。
- **自进化知识库**:通过 Auto Memory、Auto Resource、Auto Dream 和 Auto Link,把对话与资料渐进加工、梦境整理为长期 Markdown
- **Memory as File**:以带 frontmatter 和 wikilink 的 Markdown 作为记忆节点,让人和 Agent 都能直接读写。
- **自进化知识库**:通过 Auto Memory、Auto Resource、Auto Dream 和 Auto Link,把对话与资料逐步加工为长期 Markdown
记忆,并自动构建 wikilink 关系。
- **渐进式混合搜索**:构建 wikilink + BM25 + embedding 的渐进式混合搜索。
- **Agent 友好集成**:通过SKILL.md + CLI 接入,方便不同 Agent 维护和复用。
- **渐进式混合搜索**:融合 wikilink、BM25 和 embedding,支持从关键词到语义与关系扩展的混合检索。
- **Agent 友好集成**:通过 SKILL.md + CLI 接入,方便不同 Agent 读写、维护和复用记忆。
<details>
<summary><b>适用场景</b></summary>
@ -48,7 +48,7 @@
## 📁 记忆系统
> Memory as files, files as memory.
> Memory as File, File as Memory.
ReMe 将**记忆视为文件**,让原始对话和外部资料从 `reme_session/`、`resource/` 渐进加工到 `daily/`,再沉淀为 `digest/`
中可长期复用的知识节点。
@ -121,33 +121,35 @@ EOF
reme start
```
默认服务地址是 `127.0.0.1:2333`。如果端口被占用:
默认服务地址是 `127.0.0.1:2333`。如果端口被占用,可以指定其它端口:
```bash
reme start service.port=23333
reme start service.port=8181
# reme start vault_dir=/tmp/reme-demo service.port=8181
```
启动后可以检查服务状态;如果使用了自定义端口,请把下面 URL 中的 `2333` 替换为对应端口。
```bash
reme version
curl -s http://127.0.0.1:23333/version -H 'Content-Type: application/json' -d '{}'
curl -s http://127.0.0.1:2333/version -H 'Content-Type: application/json' -d '{}'
```
更多细节见 [快速开始](docs/zh/quick_start.md)。
## 🔌 接入 ReMe
ReMe 通过SKILL.md + cli + hook(可选)接入支持的 Agent 框架:
ReMe 通过 SKILL.md + CLI + hook(可选)接入支持的 Agent 框架:
- 将 [reme_memory skill](reme/skills/reme_memory/SKILL.md) 加入 Agent,并允许 Agent 调用
- 为 Agent 加入 [reme_memory](reme/skills/reme_memory/SKILL.md) skill,并允许它调用
`reme search/read/write/auto_memory/proactive` 等 CLI
- 在 Agent hook 加入 `auto_memory`(after reply) 调用点
- 在 Agent 的 after-reply hook 中调用 `auto_memory`
QwenPaw 2.0 将会集成新版 ReMe;未来也会推出 Claude Code plugin,降低手动接入成本。
## 🧰能力介绍
## 🧰 能力介绍
理解 ReMe 的能力,自动记忆流程 + CLI 的方式看:
ReMe 的能力可以分为两类:自动记忆流程和 Vault 操作接口。
### 自动记忆流程
@ -215,8 +217,8 @@ QwenPaw 2.0 将会集成新版 ReMe;未来也会推出 Claude Code plugin,
`docs(zh): update quick start`。
- **提交前检查**:提交 PR 前请尽量运行 `pre-commit run --all-files` 和 `pytest`;如有依赖 LLM、embedding 或外部服务的测试无法运行,请在
PR 中说明。
- **获取帮助**:Bugs 和功能请求使用 [GitHub Issues](https://github.com/agentscope-ai/ReMe/issues)
,项目文档见 [https://reme.agentscope.io/](https://reme.agentscope.io/)。
- **获取帮助**:Bugs 和功能请求使用 [GitHub Issues](https://github.com/agentscope-ai/ReMe/issues),项目文档见
[https://reme.agentscope.io/](https://reme.agentscope.io/)。
### 贡献者