mirror of
https://github.com/agentscope-ai/ReMe.git
synced 2026-10-10 03:30:56 +00:00
docs: align package guides and documentation site
This commit is contained in:
parent
03810dc94a
commit
bd226bd140
22 changed files with 199 additions and 71 deletions
1
.github/workflows/deploy-docs.yml
vendored
1
.github/workflows/deploy-docs.yml
vendored
|
|
@ -10,6 +10,7 @@ on:
|
|||
- "README_ZH.md"
|
||||
- "reme_studio/README*.md"
|
||||
- "reme_studio/public/og.jpg"
|
||||
- "typescript/README*.md"
|
||||
- "plugins/*/README*.md"
|
||||
- "benchmark/*/README*.md"
|
||||
- "skills/reme_memory/SKILL.md"
|
||||
|
|
|
|||
24
README.md
24
README.md
|
|
@ -30,8 +30,8 @@
|
|||
## ✨ Why ReMe?
|
||||
|
||||
🧠 ReMe turns conversations and resources into readable, editable, searchable, and interconnected Markdown memory. Agents
|
||||
such as QwenPaw, OpenClaw, Hermes, and Claude Code can share the same workspace to retrieve, maintain, and evolve
|
||||
knowledge, while users retain control of the durable files.
|
||||
such as QwenPaw and DeepSeek Harness can share the same workspace to retrieve, maintain, and evolve knowledge, while
|
||||
users retain control of the durable files.
|
||||
|
||||
- **Memory as File, File as Memory**: ReMe stores durable memory as ordinary Markdown with frontmatter and wikilinks.
|
||||
Users and agents can inspect, edit, move, sync, and back it up with familiar tools, while indexes and generated
|
||||
|
|
@ -49,8 +49,8 @@ knowledge, while users retain control of the durable files.
|
|||
|
||||
## 📰 Latest Updates
|
||||
|
||||
- [2026.08] - Published [`@agentscope-ai/reme`](https://www.npmjs.com/package/@agentscope-ai/reme), providing a native
|
||||
ReMe memory integration for DeepSeek Harness.
|
||||
- [2026.08] - Published [`@agentscope-ai/reme`](https://www.npmjs.com/package/@agentscope-ai/reme), providing native
|
||||
ReMe memory integrations for DeepSeek Harness and OpenClaw plus a shared TypeScript HTTP client.
|
||||
- [2026.08] - Published the [ReMe blog](https://agentscope-ai.github.io/ReMe/?doc=en-reme-blog), an end-to-end introduction to its local-first memory
|
||||
architecture, self-evolving workflows, hybrid search, proactive discovery, and benchmark results.
|
||||
- [2026.08] - [Experience-driven enhancement method](https://reme.agentscope.io/?doc=toolmemory-en) of agent tool-use execution built
|
||||
|
|
@ -321,7 +321,8 @@ dependencies, and underspecified requests.
|
|||
|
||||
Plugins are optional Python distributions that contribute Component, Step, or Job backends and configuration. They are
|
||||
installed separately and enabled explicitly by configuration. Daily Paper and Auto Fin are independently packaged
|
||||
plugins; their source distributions live under [`plugins/`](plugins/README.md).
|
||||
plugins; see the source distributions and their documentation for [Daily Paper](plugins/daily_paper/README.md) and
|
||||
[Auto Fin](plugins/auto-fin/README.md).
|
||||
|
||||
| Plugin | Capability |
|
||||
| ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
|
|
@ -343,8 +344,9 @@ These guides cover the main user workflows and the runtime contracts implemented
|
|||
| [Auto Dream](docs/en/auto_dream.md) and [Auto Link](docs/en/auto_link.md) | Consolidate daily notes into evolving digest nodes and readable wikilink relationships. |
|
||||
| [Memory Search](docs/en/memory_search.md) | Use BM25, optional vectors, RRF fusion, line-range recall, and progressive link expansion. |
|
||||
| [Proactive](docs/en/proactive.md) | Read interest topics safely and integrate them into a host agent's decision flow. |
|
||||
| [Agent Integration Scenarios](docs/en/reme_scene.md) | Choose among CLI/SKILL.md, HTTP, MCP, and embedded Python integration. |
|
||||
| [Application Scenarios](docs/en/reme_scene.md) | Follow concrete financial research, coding-memory, and personal knowledge-base examples. |
|
||||
| [Framework](docs/en/framework.md) | Understand Application, Job, Step, Component, service, configuration, and lifecycle boundaries. |
|
||||
| [TypeScript integrations](typescript/README.md) | Configure the shared client and native DeepSeek Harness and OpenClaw adapters. |
|
||||
| [ReMe Blog](https://agentscope-ai.github.io/ReMe/?doc=en-reme-blog) | Read the product story, design rationale, examples, and benchmark summary. |
|
||||
|
||||
## 🛠️ Common Commands
|
||||
|
|
@ -364,11 +366,11 @@ Run `reme help` for the full job list. Common workspace and maintenance commands
|
|||
|
||||
- **Issues, requests, and help**: Check [Open Issues](https://github.com/agentscope-ai/ReMe/issues) first. If there is no
|
||||
related discussion, open one with the background, expected behavior, and impact scope.
|
||||
- **Code contributions**: Before making changes, read
|
||||
the [contribution guide](https://docs.agentscope.io/reme/latest/en/contribution). Source, schemas, and tests are the
|
||||
authoritative architecture and extension guide.
|
||||
- **Documentation contributions**: Submit user-facing documentation changes to the
|
||||
[unified documentation repository](https://github.com/agentscope-ai/docs) under `reme/<version>/{en,zh}/`.
|
||||
- **Code contributions**: Before making changes, read the repository's
|
||||
[contribution guide](docs/en/contributing.md). Source, schemas, and tests are the authoritative architecture and
|
||||
extension guide.
|
||||
- **Documentation contributions**: Update the canonical files under `docs/en/`, `docs/zh/`, or the relevant package
|
||||
directory in this repository. The documentation site is generated from these files.
|
||||
- **Commit convention**: Conventional Commits are recommended, for example `feat(search): add link expansion option` or
|
||||
`docs(zh): update quick start`.
|
||||
- **Pre-submit checks**: Before submitting a PR, try to run `pre-commit run --all-files` and `pytest`. If tests that
|
||||
|
|
|
|||
19
README_ZH.md
19
README_ZH.md
|
|
@ -29,8 +29,8 @@
|
|||
|
||||
## ✨ 为什么选择 ReMe?
|
||||
|
||||
🧠 ReMe 将对话和资料持续沉淀为可读、可编辑、可检索、相互链接的 Markdown 记忆。QwenPaw、OpenClaw、Hermes 和
|
||||
Claude Code 等 Agent 可以共享同一个 workspace,共同检索、维护和演化知识,而持久文件始终由用户掌控。
|
||||
🧠 ReMe 将对话和资料持续沉淀为可读、可编辑、可检索、相互链接的 Markdown 记忆。QwenPaw、DeepSeek Harness 等 Agent
|
||||
可以共享同一个 workspace,共同检索、维护和演化知识,而持久文件始终由用户掌控。
|
||||
|
||||
- **Memory as File, File as Memory**:ReMe 使用带 frontmatter 和 wikilink 的普通 Markdown 保存持久记忆。用户和 Agent
|
||||
都可以使用熟悉的工具查看、编辑、移动、同步和备份;索引及生成的元数据均可重建。
|
||||
|
|
@ -47,8 +47,8 @@ Claude Code 等 Agent 可以共享同一个 workspace,共同检索、维护和
|
|||
|
||||
## 📰 最新动态
|
||||
|
||||
- [2026.08] - 发布 [`@agentscope-ai/reme`](https://www.npmjs.com/package/@agentscope-ai/reme),为 DeepSeek Harness
|
||||
提供原生 ReMe 记忆集成。
|
||||
- [2026.08] - 发布 [`@agentscope-ai/reme`](https://www.npmjs.com/package/@agentscope-ai/reme),提供统一 TypeScript HTTP
|
||||
client,以及 DeepSeek Harness 和 OpenClaw 的原生 ReMe 记忆集成。
|
||||
- [2026.08] - 发布 [ReMe 博客](https://agentscope-ai.github.io/ReMe/?doc=zh-reme-blog),系统介绍本地优先的记忆架构、自进化工作流、混合检索、
|
||||
主动发现与评测结果。
|
||||
- [2026.08] - 基于 ReMe 的智能体工具使用
|
||||
|
|
@ -311,7 +311,8 @@ ReMe 通过 Agent 多轮搜索与读取的方式,评测多会话和超长上
|
|||
## 🧩 扩展与工作流
|
||||
|
||||
插件是可选的独立 Python distribution,可以贡献 Component、Step、Job backend 和配置,并通过配置显式启用。每日论文与 Auto Fin
|
||||
均已独立打包,源码 distribution 位于 [`plugins/`](plugins/README.md)。
|
||||
均已独立打包,源码 distribution 及说明分别见[每日论文](plugins/daily_paper/README_ZH.md)和
|
||||
[Auto Fin](plugins/auto-fin/README_ZH.md)。
|
||||
|
||||
| 插件 | 能力 |
|
||||
| ---------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
|
|
@ -333,8 +334,9 @@ ReMe 通过 Agent 多轮搜索与读取的方式,评测多会话和超长上
|
|||
| [Auto Dream](docs/zh/auto_dream.md) 与 [Auto Link](docs/zh/auto_link.md) | 将 daily 记忆整理为持续演化的 digest 节点和可读 wikilink 关系。 |
|
||||
| [记忆检索](docs/zh/memory_search.md) | 使用 BM25、可选向量、RRF 融合、行号范围召回和渐进式链接扩展。 |
|
||||
| [Proactive](docs/zh/proactive.md) | 安全读取兴趣主题,并将其接入宿主 Agent 的决策流程。 |
|
||||
| [Agent 接入场景](docs/zh/reme_scene.md) | 在 CLI/SKILL.md、HTTP、MCP 和嵌入式 Python 集成之间选择。 |
|
||||
| [应用场景](docs/zh/reme_scene.md) | 查看金融研究、研发记忆和个人知识库的完整使用示例。 |
|
||||
| [框架说明](docs/zh/framework.md) | 理解 Application、Job、Step、Component、service、配置和生命周期边界。 |
|
||||
| [TypeScript 集成](typescript/README_ZH.md) | 配置统一 client,以及 DeepSeek Harness 和 OpenClaw 原生适配器。 |
|
||||
| [ReMe 博客](https://agentscope-ai.github.io/ReMe/?doc=zh-reme-blog) | 了解完整产品故事、设计动机、使用示例和评测摘要。 |
|
||||
|
||||
## 🛠️ 常用命令
|
||||
|
|
@ -354,9 +356,8 @@ ReMe 通过 Agent 多轮搜索与读取的方式,评测多会话和超长上
|
|||
|
||||
- **问题反馈、需求与帮助**:请先查看 [Open Issues](https://github.com/agentscope-ai/ReMe/issues);如无相关讨论,可新建 Issue
|
||||
说明背景、目标行为和影响范围。
|
||||
- **代码贡献**:改动前建议阅读 [贡献指南](https://docs.agentscope.io/reme/latest/zh/contribution)。架构与扩展方式以源码、schema
|
||||
和测试为准。
|
||||
- **文档贡献**:用户可见文档请提交到[统一文档仓库](https://github.com/agentscope-ai/docs)的 `reme/<version>/{en,zh}/` 目录。
|
||||
- **代码贡献**:改动前建议阅读仓库内的[贡献指南](docs/zh/contributing.md)。架构与扩展方式以源码、schema 和测试为准。
|
||||
- **文档贡献**:请直接更新本仓库 `docs/en/`、`docs/zh/` 或对应 package 目录中的规范源文件;文档站点会从这些文件生成。
|
||||
- **提交规范**:建议使用 Conventional Commits,例如 `feat(search): add link expansion option`、
|
||||
`docs(zh): update quick start`。
|
||||
- **提交前检查**:提交 PR 前请尽量运行 `pre-commit run --all-files` 和 `pytest`;如有依赖 LLM、embedding 或外部服务的测试无法运行,请在
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ A typical plugin workflow has three stages:
|
|||
|
||||
1. Install ReMe and the plugin distribution.
|
||||
2. Configure the plugin's runtime environment as described in the
|
||||
[ReMe environment-variable guide](../../README.md#environment-variables).
|
||||
[ReMe model-configuration guide](../../README.md#optional-model-configuration).
|
||||
3. Start an Application with the plugin explicitly enabled, for example
|
||||
`reme start plugins='["auto-fin"]'`.
|
||||
|
||||
|
|
|
|||
|
|
@ -315,10 +315,12 @@ that best fits their runtime environment and share the same local memory workspa
|
|||
|
||||
| Agent | Recommended integration | Capabilities after integration |
|
||||
|-------|-------------------------|--------------------------------|
|
||||
| **DeepSeek Harness** | Install [`@agentscope-ai/reme`](../../typescript/README.md#deepseek-harness) as a DSH profile bundle. | Long-term memory guidance, `reme_search`, automatic capture of completed main-agent turns, and scheduled Auto Dream. |
|
||||
| **OpenClaw** | Install [`@agentscope-ai/reme`](../../typescript/README.md#openclaw) as the native memory plugin. | Recall before conversational root-agent runs, explicit search, automatic turn capture, and scheduled Auto Dream. |
|
||||
| **QwenPaw** | Embed ReMe in-process through the Python API. | Reuse the host application's lifecycle and model configuration while keeping memories local and file-based. |
|
||||
| **Claude Code** | Start the streamable HTTP MCP Service and install [`integrations/claude_code/reme`](../../integrations/claude_code/reme). | MCP memory-recall tools, the `reme-memory` skill, and a Stop hook that automatically records sessions. |
|
||||
| **Hermes** | Start the HTTP Service and install [`integrations/hermes_agent`](../../integrations/hermes_agent). | Automatically recall relevant memories before model calls and invoke `auto_memory` asynchronously after each conversation turn. |
|
||||
| **OpenClaw, Codex, and other CLI-capable agents** | Copy or install [`skills/reme_memory/SKILL.md`](../../skills/reme_memory/SKILL.md). | Search, read, and write memories through the CLI; automatic recording requires the host agent to integrate explicitly with the conversation lifecycle. |
|
||||
| **Codex and other CLI-capable agents** | Copy or install [`skills/reme_memory/SKILL.md`](../../skills/reme_memory/SKILL.md). | Search, read, and write memories through the CLI; automatic recording requires the host agent to integrate explicitly with the conversation lifecycle. |
|
||||
|
||||
For installation, configuration, and integration demos, see the [README](../../README.md).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
# ReMe 接入 Codex、DSH、OpenClaw、Claude Code 与 Hermes Agent 的方案
|
||||
|
||||
> 状态:设计方案;统一 TypeScript 包及 DSH、OpenClaw 适配器已完成首版,统一服务端接入能力尚未实施
|
||||
> 调研基线:ReMe、OpenViking、DSH 与 OpenClaw 的本地检出版本,以及 2026-08-19 的 Codex 官方文档
|
||||
> 状态:历史设计与调研记录。统一 TypeScript 包及 DSH、OpenClaw 适配器已完成首版,尚未实现的内容仍是提案,
|
||||
> 不代表当前公开契约。当前安装、配置和行为以 [TypeScript 集成文档](../../typescript/README_ZH.md)、代码和测试为准。
|
||||
>
|
||||
> 调研基线:ReMe、OpenViking、DSH 与 OpenClaw 的本地检出版本,以及 2026-08-19 的 Codex 官方文档。
|
||||
> 文中引用的历史版本号和宿主接口仅用于解释当时的设计决策。
|
||||
|
||||
## 1. 结论
|
||||
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ plugins: [auto-fin] 为一个 Application 启用已安装插件
|
|||
典型的插件使用流程分为三个阶段:
|
||||
|
||||
1. 安装 ReMe 和插件 distribution。
|
||||
2. 按照 [ReMe 环境变量说明](../../README_ZH.md#环境变量)配置插件运行所需的环境变量。
|
||||
2. 按照 [ReMe 可选模型配置说明](../../README_ZH.md#可选模型配置)配置插件运行所需的环境变量。
|
||||
3. 启动 Application 时显式启用插件,例如 `reme start plugins='["auto-fin"]'`。
|
||||
|
||||
## 查看已安装插件
|
||||
|
|
|
|||
|
|
@ -334,10 +334,12 @@ ReMe 既可以作为本地记忆服务,通过 CLI、HTTP API 或 MCP Server
|
|||
|
||||
| Agent | 推荐接入方式 | 接入后能力 |
|
||||
|----------------------------------------|--------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
|
||||
| **DeepSeek Harness** | 将 [`@agentscope-ai/reme`](../../typescript/README_ZH.md#deepseek-harness) 安装为 DSH profile bundle。 | 长期记忆指引、`reme_search`、自动捕获主 Agent 已完成的对话,以及定时 Auto Dream。 |
|
||||
| **OpenClaw** | 将 [`@agentscope-ai/reme`](../../typescript/README_ZH.md#openclaw) 安装为原生 memory plugin。 | 根 Agent 对话运行前召回、显式搜索、自动捕获对话,以及定时 Auto Dream。 |
|
||||
| **QwenPaw** | 通过 Python API 在进程内嵌入 ReMe。 | 复用宿主应用的生命周期和模型配置,同时保持记忆本地、文件化。 |
|
||||
| **Claude Code** | 启动 streamable HTTP MCP Service,并安装 [`integrations/claude_code/reme`](../../integrations/claude_code/reme)。 | MCP 记忆召回工具、`reme-memory` skill,以及自动记录会话的 Stop hook。 |
|
||||
| **Hermes** | 启动 HTTP Service,并安装 [`integrations/hermes_agent`](../../integrations/hermes_agent)。 | 在模型调用前自动召回相关记忆,并在每轮对话完成后异步调用 `auto_memory`。 |
|
||||
| **OpenClaw、Codex 等支持 CLI 的 Agent** | 复制或安装 [`skills/reme_memory/SKILL.md`](../../skills/reme_memory/SKILL.md)。 | 通过 CLI 搜索、读取和写入记忆;自动记录需要宿主 Agent 显式接入会话生命周期。 |
|
||||
| **Codex 等支持 CLI 的 Agent** | 复制或安装 [`skills/reme_memory/SKILL.md`](../../skills/reme_memory/SKILL.md)。 | 通过 CLI 搜索、读取和写入记忆;自动记录需要宿主 Agent 显式接入会话生命周期。 |
|
||||
|
||||
安装、配置与集成演示可查看 [README 中文版](../../README_ZH.md)。
|
||||
|
||||
|
|
|
|||
|
|
@ -51,6 +51,7 @@ The build script reads the canonical repository files directly. Do not edit gene
|
|||
- `docs/en/` and `docs/zh/`: English and Chinese guides
|
||||
- `docs/figure/`: documentation images
|
||||
- `reme_studio/README.md` and `reme_studio/README_ZH.md`: ReMe Studio guide
|
||||
- `typescript/README.md` and `typescript/README_ZH.md`: TypeScript client, DeepSeek Harness, and OpenClaw integration guide
|
||||
- `plugins/*/README*.md`: plugin and research workflow guides
|
||||
- `benchmark/{beam,longmemeval,pibench,toolmemory}/README*.md`: benchmark guides and results
|
||||
- `skills/reme_memory/SKILL.md`: ReMe Memory skill guide
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@
|
|||
"dev": "node scripts/generate-content.mjs && vite",
|
||||
"build": "node scripts/generate-content.mjs && vite build",
|
||||
"preview": "vite preview",
|
||||
"test": "node --test tests/*.test.mjs"
|
||||
"test": "node scripts/generate-content.mjs && node --test tests/*.test.mjs"
|
||||
},
|
||||
"dependencies": {
|
||||
"dompurify": "^3.2.6",
|
||||
|
|
|
|||
|
|
@ -55,6 +55,16 @@ const localizedTitles = {
|
|||
};
|
||||
|
||||
const productDocuments = [
|
||||
{
|
||||
slug: "typescript",
|
||||
source: "typescript",
|
||||
titles: { zh: "TypeScript Agent 集成", en: "TypeScript Agent Integrations" },
|
||||
descriptions: {
|
||||
zh: "配置统一 HTTP client,以及 DeepSeek Harness 和 OpenClaw 原生适配器。",
|
||||
en: "Configure the shared HTTP client and native DeepSeek Harness and OpenClaw adapters.",
|
||||
},
|
||||
group: "integration",
|
||||
},
|
||||
{
|
||||
slug: "studio",
|
||||
source: "reme_studio",
|
||||
|
|
@ -179,6 +189,15 @@ async function buildManifest() {
|
|||
group: "overview",
|
||||
language: "en",
|
||||
},
|
||||
{
|
||||
id: "zh-agent-integration-plan",
|
||||
path: "docs/zh/agent_integration_plan.md",
|
||||
sourcePath: "docs/zh/agent_integration_plan.md",
|
||||
title: "Agent 集成设计与调研记录",
|
||||
description: "Codex、DSH、OpenClaw、Claude Code 与 Hermes Agent 的历史设计和调研记录。",
|
||||
group: "integration",
|
||||
language: "zh",
|
||||
},
|
||||
];
|
||||
|
||||
for (const language of ["zh", "en"]) {
|
||||
|
|
|
|||
23
github-pages/tests/content-manifest.test.mjs
Normal file
23
github-pages/tests/content-manifest.test.mjs
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
import assert from "node:assert/strict";
|
||||
import { readFile } from "node:fs/promises";
|
||||
import test from "node:test";
|
||||
|
||||
const manifestUrl = new URL("../.generated/content/manifest.json", import.meta.url);
|
||||
|
||||
test("includes the historical Agent integration plan in Chinese navigation", async () => {
|
||||
const manifest = JSON.parse(await readFile(manifestUrl, "utf8"));
|
||||
const document = manifest.documents.find(
|
||||
(item) => item.id === "zh-agent-integration-plan",
|
||||
);
|
||||
|
||||
assert.deepEqual(document, {
|
||||
id: "zh-agent-integration-plan",
|
||||
path: "docs/zh/agent_integration_plan.md",
|
||||
sourcePath: "docs/zh/agent_integration_plan.md",
|
||||
title: "Agent 集成设计与调研记录",
|
||||
description:
|
||||
"Codex、DSH、OpenClaw、Claude Code 与 Hermes Agent 的历史设计和调研记录。",
|
||||
group: "integration",
|
||||
language: "zh",
|
||||
});
|
||||
});
|
||||
|
|
@ -7,4 +7,5 @@ plugin API, hooks, MCP configuration, or client interface, but it does not exten
|
|||
The shared TypeScript client and the DeepSeek Harness and OpenClaw adapters live in
|
||||
[`../typescript`](../typescript/README.md).
|
||||
|
||||
Installable extensions of ReMe itself belong in [`../plugins`](../plugins/README.md).
|
||||
Installable extensions of ReMe itself include [Auto Fin](../plugins/auto-fin/README.md) and
|
||||
[Daily Paper](../plugins/daily_paper/README.md).
|
||||
|
|
|
|||
|
|
@ -1,29 +0,0 @@
|
|||
# ReMe Plugins
|
||||
|
||||
This directory contains installable extensions of ReMe itself. A plugin exposes its package through the `reme.plugins`
|
||||
Python entry-point group and declares backend classes plus a low-priority `ApplicationConfig` fragment under
|
||||
`application_defaults` in that package's `plugin.yaml`.
|
||||
|
||||
Manage plugin packages with the local CLI:
|
||||
|
||||
```bash
|
||||
reme plugins list
|
||||
reme plugins show auto-fin
|
||||
reme plugins show daily-paper
|
||||
reme plugins install reme-auto-fin
|
||||
reme plugins install reme-daily-paper
|
||||
reme plugins install ./plugins/auto-fin --editable
|
||||
reme plugins install ./plugins/daily_paper --editable
|
||||
reme plugins validate auto-fin
|
||||
reme plugins validate daily-paper
|
||||
reme plugins uninstall auto-fin
|
||||
reme plugins uninstall daily-paper
|
||||
```
|
||||
|
||||
Installation and activation are separate. Enable an installed plugin for one application through its config or CLI:
|
||||
|
||||
```bash
|
||||
reme start plugins='["auto-fin","daily-paper"]'
|
||||
```
|
||||
|
||||
Adapters for external agent hosts belong in [`../integrations`](../integrations/README.md).
|
||||
|
|
@ -24,7 +24,8 @@ reme plugins install reme-auto-fin
|
|||
### 2. Configure the model environment
|
||||
|
||||
Configure the LLM environment variables as described in the
|
||||
[ReMe README](../../README.md#environment-variables). Other compatible models and providers can also be used.
|
||||
[ReMe model-configuration guide](../../README.md#optional-model-configuration). Other compatible models and providers
|
||||
can also be used.
|
||||
|
||||
### 3. Start ReMe with the plugin
|
||||
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ reme plugins install reme-auto-fin
|
|||
|
||||
### 2. 配置模型环境变量
|
||||
|
||||
按照 ReMe README 的[环境变量说明](../../README_ZH.md#环境变量)配置 LLM 环境变量,也可以使用其他兼容的模型和服务商。
|
||||
按照 ReMe README 的[可选模型配置说明](../../README_ZH.md#可选模型配置)配置 LLM 环境变量,也可以使用其他兼容的模型和服务商。
|
||||
|
||||
### 3. 带插件启动 ReMe
|
||||
|
||||
|
|
|
|||
|
|
@ -91,11 +91,21 @@ The regular `npm run build` command remains the vinext/Sites deployment build;
|
|||
|
||||
## Configuration
|
||||
|
||||
The workspace hides dotfiles and dot-directories. It displays only Markdown and text files by default. Configure the
|
||||
allowed extensions as a comma-separated list in `.env.local`:
|
||||
Copy `.env.example` to `.env.local` when persistent local overrides are useful. The vinext/Sites build reads
|
||||
`NEXT_PUBLIC_*`; the FastAPI/static build reads the matching `VITE_*` names:
|
||||
|
||||
| Setting | Build | Purpose |
|
||||
| --------------------------------------- | ------------ | -------------------------------------------------------------- |
|
||||
| `NEXT_PUBLIC_REME_API_URL` | vinext/Sites | ReMe HTTP service URL; defaults to `http://127.0.0.1:2333` |
|
||||
| `NEXT_PUBLIC_REME_WORKSPACE_EXTENSIONS` | vinext/Sites | Comma-separated file extensions visible in the workspace |
|
||||
| `VITE_REME_API_URL` | static | ReMe HTTP service URL; use `/` for same-origin FastAPI hosting |
|
||||
| `VITE_REME_WORKSPACE_EXTENSIONS` | static | Static-build counterpart of the workspace extension list |
|
||||
|
||||
The workspace hides dotfiles and dot-directories. It displays Markdown and text files by default. For example:
|
||||
|
||||
```bash
|
||||
NEXT_PUBLIC_REME_WORKSPACE_EXTENSIONS=md,txt,mdx
|
||||
VITE_REME_WORKSPACE_EXTENSIONS=md,txt,mdx
|
||||
```
|
||||
|
||||
The memory graph requires an index built by ReMe. Rebuilding the index from the Studio settings regenerates derived data
|
||||
|
|
|
|||
|
|
@ -85,10 +85,21 @@ reme start
|
|||
|
||||
## 配置
|
||||
|
||||
工作区会隐藏点文件和点目录,并且默认只显示 Markdown 和文本文件。可以在 `.env.local` 中通过逗号分隔的列表配置允许显示的扩展名:
|
||||
如需持久保存本地覆盖,可以将 `.env.example` 复制为 `.env.local`。vinext/Sites 构建读取
|
||||
`NEXT_PUBLIC_*`,FastAPI/static 构建读取对应的 `VITE_*` 变量:
|
||||
|
||||
| 配置项 | 构建类型 | 作用 |
|
||||
| --------------------------------------- | ------------ | ------------------------------------------------- |
|
||||
| `NEXT_PUBLIC_REME_API_URL` | vinext/Sites | ReMe HTTP 服务地址,默认 `http://127.0.0.1:2333` |
|
||||
| `NEXT_PUBLIC_REME_WORKSPACE_EXTENSIONS` | vinext/Sites | 工作区允许显示的扩展名,使用逗号分隔 |
|
||||
| `VITE_REME_API_URL` | static | ReMe HTTP 服务地址;由 FastAPI 同源托管时使用 `/` |
|
||||
| `VITE_REME_WORKSPACE_EXTENSIONS` | static | static 构建使用的工作区扩展名列表 |
|
||||
|
||||
工作区会隐藏点文件和点目录,并且默认只显示 Markdown 和文本文件。例如:
|
||||
|
||||
```bash
|
||||
NEXT_PUBLIC_REME_WORKSPACE_EXTENSIONS=md,txt,mdx
|
||||
VITE_REME_WORKSPACE_EXTENSIONS=md,txt,mdx
|
||||
```
|
||||
|
||||
记忆图谱依赖 ReMe 构建的索引。在 Studio 设置中重建索引时,只会根据工作区文件重新生成派生数据,不会修改记忆源文件。
|
||||
|
|
|
|||
|
|
@ -9,6 +9,7 @@
|
|||
"esModuleInterop": true,
|
||||
"module": "esnext",
|
||||
"moduleResolution": "bundler",
|
||||
"allowImportingTsExtensions": true,
|
||||
"resolveJsonModule": true,
|
||||
"isolatedModules": true,
|
||||
"types": ["@cloudflare/workers-types"],
|
||||
|
|
|
|||
|
|
@ -1,11 +1,14 @@
|
|||
import { readFileSync } from "node:fs";
|
||||
import vinext from "vinext";
|
||||
import { defineConfig } from "vite";
|
||||
import hostingConfig from "./.openai/hosting.json";
|
||||
import { sites } from "./tooling/sites-vite-plugin";
|
||||
import { sites } from "./tooling/sites-vite-plugin.ts";
|
||||
|
||||
const SITE_CREATOR_PLACEHOLDER_DATABASE_ID =
|
||||
"00000000-0000-4000-8000-000000000000";
|
||||
|
||||
const hostingConfig = JSON.parse(
|
||||
readFileSync(new URL("./.openai/hosting.json", import.meta.url), "utf8"),
|
||||
) as { d1: string | null; r2: string | null };
|
||||
const { d1, r2 } = hostingConfig;
|
||||
|
||||
// macOS Seatbelt blocks FSEvents, so Codex previews need polling for HMR.
|
||||
|
|
|
|||
|
|
@ -15,6 +15,12 @@ reme start workspace_dir=/absolute/path/to/workspace
|
|||
The default endpoint is `http://127.0.0.1:2333`. All entries support `REME_URL`, or `REME_HOST` plus `REME_PORT`.
|
||||
ReMe's HTTP service does not use API-key authentication.
|
||||
|
||||
## Requirements
|
||||
|
||||
- A running ReMe HTTP service with the jobs required by the selected adapter.
|
||||
- Node.js `22.22.3+`, `24.15.0+`, or `25.9.0+` on the corresponding supported major-version line.
|
||||
- DeepSeek Harness or OpenClaw only when using that host-specific entry; the root client has no host runtime dependency.
|
||||
|
||||
## DeepSeek Harness
|
||||
|
||||
Install the package as a DSH profile bundle:
|
||||
|
|
@ -56,7 +62,9 @@ The test-only `dreamIntervalMs` value remains outside the user-settings section.
|
|||
| `autoMemoryInterval` | `5` | Submit after this many completed turns |
|
||||
| `autoDreamEnabled` | `true` | Enable daily dream maintenance |
|
||||
| `dreamCron` | `0 23 * * *` | Daily schedule in the workspace timezone |
|
||||
| `dreamHint` | empty | Optional guidance sent to `auto_dream` |
|
||||
| `rootAgentsOnly` | `true` | Exclude subagents from guidance and capture |
|
||||
| `searchLimit` | `5` | Maximum results returned by `reme_search` |
|
||||
| `requestTimeoutMs` | `10000` | Search request timeout |
|
||||
| `backgroundTimeoutMs` | `3600000` | Automatic-memory and dream timeout |
|
||||
| `shutdownTimeoutMs` | `5000` | Best-effort shutdown drain budget |
|
||||
|
|
@ -133,3 +141,5 @@ npm run test:package
|
|||
|
||||
`npm pack` runs the TypeScript build and includes only `dist`, the DSH patch, the OpenClaw manifest, and the English and
|
||||
Chinese READMEs.
|
||||
|
||||
Stable releases use npm's `latest` distribution tag; prereleases use `next`.
|
||||
|
|
|
|||
|
|
@ -10,6 +10,12 @@ reme start workspace_dir=/absolute/path/to/workspace
|
|||
|
||||
默认服务地址为 `http://127.0.0.1:2333`。所有入口均支持 `REME_URL`,也支持组合使用 `REME_HOST` 和 `REME_PORT`。ReMe HTTP 服务不使用 API Key 认证。
|
||||
|
||||
## 环境要求
|
||||
|
||||
- 已启动 ReMe HTTP 服务,并提供所选适配器需要的 Job。
|
||||
- 对应受支持主版本线上的 Node.js `22.22.3+`、`24.15.0+` 或 `25.9.0+`。
|
||||
- 只有使用宿主专用入口时才需要 DeepSeek Harness 或 OpenClaw;包根 client 不依赖宿主 runtime。
|
||||
|
||||
## DeepSeek Harness
|
||||
|
||||
将本包安装为 DSH profile bundle:
|
||||
|
|
@ -20,7 +26,49 @@ dsh plugin --profile web add @agentscope-ai/reme
|
|||
|
||||
安装后可在 **设置 → 插件 → 插件配置 → ReMe Memory** 中配置服务地址、记忆指引语言、自动记忆、每日记忆整理和超时时间,并查看服务健康状态。每日记忆整理和每日批次统一使用配置的 workspace 时区。
|
||||
|
||||
完整配置项和 `cordis.patch.yml` 示例请参阅[英文文档](./README.md#deepseek-harness)。
|
||||
Bundle 会在隔离的 `remeMemory` realm 中加载 `@agentscope-ai/reme/dsh`,注入长期记忆指引,注册
|
||||
`reme_search`,将主 Agent 已完成的对话提交给 `auto_memory`,并按可选的每日计划运行 `auto_dream`。召回的
|
||||
plugin context 和工具结果不会再次进入自动记忆。
|
||||
|
||||
如需直接修改 profile,可以替换 `cordis.patch.yml` 中对应条目:
|
||||
|
||||
```yaml
|
||||
- id: reme-memory
|
||||
config:
|
||||
- id: reme-memory-runtime
|
||||
name: "@agentscope-ai/reme/dsh"
|
||||
config:
|
||||
endpoint: http://127.0.0.1:2333
|
||||
language: zh
|
||||
timezone: Asia/Shanghai
|
||||
autoMemoryInterval: 5
|
||||
autoDreamEnabled: true
|
||||
dreamCron: "0 23 * * *"
|
||||
```
|
||||
|
||||
DSH Web profile 也可以在 **设置 → 插件 → 插件配置 → ReMe Memory** 中编辑同一组配置。设置会保存到 DSH
|
||||
用户设置文档,并从后续请求和捕获开始生效;修改每日计划会重新调度下一次任务,修改语言只影响新会话。
|
||||
仅供测试的 `dreamIntervalMs` 不属于用户设置。
|
||||
|
||||
| 配置项 | 默认值 | 作用 |
|
||||
| --------------------- | ----------------------- | ------------------------------- |
|
||||
| `endpoint` | `http://127.0.0.1:2333` | ReMe HTTP 服务地址 |
|
||||
| `language` | `en` | 记忆指引语言:`en` 或 `zh` |
|
||||
| `autoMemoryEnabled` | `true` | 捕获主 Agent 已完成的对话 |
|
||||
| `autoMemoryInterval` | `5` | 每完成多少轮提交一次 |
|
||||
| `autoDreamEnabled` | `true` | 启用每日记忆整理 |
|
||||
| `dreamCron` | `0 23 * * *` | workspace 时区下的每日计划 |
|
||||
| `dreamHint` | 空字符串 | 传给 `auto_dream` 的可选指引 |
|
||||
| `rootAgentsOnly` | `true` | 不为子 Agent 注入指引或捕获对话 |
|
||||
| `searchLimit` | `5` | `reme_search` 返回结果上限 |
|
||||
| `requestTimeoutMs` | `10000` | 搜索请求超时 |
|
||||
| `backgroundTimeoutMs` | `3600000` | 自动记忆和 Auto Dream 超时 |
|
||||
| `shutdownTimeoutMs` | `5000` | 退出时尽力排空任务的时间预算 |
|
||||
| `timezone` | `Asia/Shanghai` | 每日批次和计划使用的 IANA 时区 |
|
||||
|
||||
ReMe 配置卡会按需调用 `health_check` 和 `status`,显示 ReMe 版本、组件健康状态、chunk/index 数量、进程 RSS
|
||||
与组件内存估算;它也可以显示脱敏后的 `app_config`,并手动触发一次 `auto_dream`。页面首次打开或用户主动刷新时才会
|
||||
更新诊断,不会持续轮询。浏览器必须能够访问所配置的 ReMe HTTP 地址,且 ReMe 服务需要允许 DSH 页面所在的 origin。
|
||||
|
||||
## OpenClaw
|
||||
|
||||
|
|
@ -36,12 +84,28 @@ openclaw plugins install @agentscope-ai/reme
|
|||
已完成的用户/助手消息按会话、日期分批提交给 `auto_memory`;失败批次会保留重试,Gateway 退出时会在有限时间内刷新。
|
||||
插件还会按 workspace 时区运行一份每日 `auto_dream` 计划。默认不会处理子 Agent、Cron、Heartbeat、Memory 或 Overflow 触发的运行。
|
||||
|
||||
主要配置包括 `language`、`autoRecall`、`searchLimit`、`autoMemoryEnabled`、`autoMemoryInterval`、
|
||||
`autoDreamEnabled`、`dreamCron`、`dreamHint`、`rootAgentsOnly` 和 `timezone`。默认每 5 轮写入一次记忆,
|
||||
每日 23:00(`Asia/Shanghai`)执行 Auto Dream。OpenClaw 的会话访问和 Prompt 注入权限仍由宿主侧配置,
|
||||
本适配器不会修改 Gateway 设置。
|
||||
召回内容包裹在 `<reme-context>` 中并标记为不可信历史数据。OpenClaw 插件配置如下:
|
||||
|
||||
完整配置项请参阅[英文文档](./README.md#openclaw)。
|
||||
| 配置项 | 默认值 | 作用 |
|
||||
| --------------------- | ----------------------- | ------------------------------------ |
|
||||
| `endpoint` | `http://127.0.0.1:2333` | ReMe HTTP 服务地址 |
|
||||
| `language` | `en` | 记忆指引语言:`en` 或 `zh` |
|
||||
| `autoRecall` | `true` | 在根 Agent 对话运行前自动召回 |
|
||||
| `searchLimit` | `5` | 搜索结果上限 |
|
||||
| `recallMinScore` | `0` | 自动召回的最低搜索分数 |
|
||||
| `autoMemoryEnabled` | `true` | 捕获已完成的对话 |
|
||||
| `autoMemoryInterval` | `5` | 每完成多少轮提交一次 |
|
||||
| `autoDreamEnabled` | `true` | 启用每日记忆整理 |
|
||||
| `dreamCron` | `0 23 * * *` | workspace 时区下的每日计划 |
|
||||
| `dreamHint` | 空字符串 | 传给 `auto_dream` 的可选指引 |
|
||||
| `rootAgentsOnly` | `true` | 不为子 Agent 注入指引或捕获对话 |
|
||||
| `timezone` | `Asia/Shanghai` | 每日批次和计划使用的 IANA 时区 |
|
||||
| `requestTimeoutMs` | `10000` | 自动召回和显式搜索超时 |
|
||||
| `backgroundTimeoutMs` | `3600000` | 自动记忆和 Auto Dream 超时 |
|
||||
| `shutdownTimeoutMs` | `5000` | Gateway 退出时尽力排空任务的时间预算 |
|
||||
|
||||
OpenClaw 的会话访问和 Prompt 注入权限仍由宿主侧配置;策略要求显式授权时,需要为 ReMe 开启相应权限。本适配器不会修改
|
||||
Gateway 配置。
|
||||
|
||||
## 客户端库
|
||||
|
||||
|
|
@ -65,4 +129,6 @@ npm test
|
|||
npm run test:package
|
||||
```
|
||||
|
||||
正式版本 `0.1.0` 使用 npm 的 `latest` distribution tag 发布。
|
||||
`npm pack` 会先构建 TypeScript,并且只打包 `dist`、DSH patch、OpenClaw manifest 和中英文 README。
|
||||
|
||||
稳定版本使用 npm 的 `latest` distribution tag 发布,预发布版本使用 `next`。
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue