docs: import reviewed Screenpipe notes as resources

This commit is contained in:
Louis Beaumont 2026-10-01 11:46:00 -07:00
parent 1648b7ce93
commit 07767214a9
4 changed files with 152 additions and 0 deletions

View file

@ -20,6 +20,11 @@ ReMe keeps memory in an independent service and a user-owned workspace. Multiple
| Hermes Agent | Memory provider adapter |
| Codex or another coding agent | `reme_memory` Skill or MCP |
## Screenpipe notes
[Import reviewed Screenpipe notes](./screenpipe.md) through the existing resource
pipeline, preserving source references for later recall.
## General memory loop
1. Before answering, call `search` for relevant memory.

78
docs/en/screenpipe.md Normal file
View file

@ -0,0 +1,78 @@
# Import reviewed Screenpipe notes
[Screenpipe](https://github.com/screenpipe/screenpipe) records desktop activity and
meeting context. ReMe can keep a selected, reviewed note from that history as a
resource, interpret it into a daily card, and retrieve it from later agent sessions.
This is a manual resource-import recipe using existing ReMe jobs.
## Prepare a source note
Choose one completed meeting or work episode in Screenpipe. Review the saved
notes, correct errors, and copy only the information you want ReMe to retain to a
UTF-8 Markdown file outside the ReMe workspace first. Include:
- A title and the recording time, including its timezone.
- The Screenpipe meeting ID or another source reference you can resolve locally.
- The reviewed note and any uncertainty that remains.
For example, a synthetic note might read:
```markdown
# Example project handoff
Source: Screenpipe meeting 42 on my-work-laptop
Recorded: 2026-01-15T10:00:00Z
Reviewed: yes
The team chose the CSV export for the handoff. The delivery date was not agreed.
```
Keep the source device label stable: meeting IDs can overlap across installations.
A note describing a workflow does not prove that every action succeeded.
## Add it to the workspace
Finish the [quick start](./quick_start.md) and identify the workspace used by your
running ReMe service. Copy the reviewed file into that workspace, for example:
```text
resource/2026-01-15/screenpipe-my-work-laptop-meeting-42.md
```
Use the meeting date in the directory name. Do not overwrite an unrelated file.
Only copy after review: an enabled resource watcher can process a new file as soon
as it appears. Processing may send the note to ReMe's configured model provider.
If the resource watcher is disabled, invoke the existing job against the same
workspace explicitly:
```bash
reme auto_resource workspace_dir=/absolute/path/to/your/workspace changes='[{"path":"resource/2026-01-15/screenpipe-my-work-laptop-meeting-42.md","change":"added"}]'
```
Replace the example path with your actual resource path. Use either the watcher
or the explicit call for initial ingestion, not both at once.
## Verify before relying on memory
Check the daily card under `daily/2026-01-15/` and confirm that its
`source_resource` points to the copied Markdown file. Compare the interpreted
card with the original note. Then use ReMe's [search and read interfaces](./memory_search.md)
to retrieve the handoff decision from another session, keeping the source path
with the answer. A file copy alone is not proof that interpretation or indexing
succeeded. Inspect errors before retrying a failed job.
## Corrections and removal
Keep the same resource path when correcting the note. The watcher can process the
edit; with the watcher disabled, call `auto_resource` with `change="modified"`.
The existing resource contract uses the exact `source_resource` link to update
the corresponding card.
Deleting the Screenpipe original does not delete the imported copy. To remove it
from ReMe, remove the selected resource and let the enabled watcher handle its
deletion, or explicitly submit its path with `change="deleted"`. Review any
later digest knowledge separately; deleting a source card is not a claim that
all derived knowledge has been erased.
See [Auto Resource](./auto_resource.md) for processing, retry and deletion semantics.

View file

@ -32,6 +32,10 @@ ReMe 把记忆能力放在独立服务和用户拥有的 workspace 中。Agent
搜索不到内容时应明确返回空结果,不应把模型推测当成历史记忆。
## Screenpipe 笔记
通过现有资源流程[导入已审核的 Screenpipe 笔记](./screenpipe.md),保留来源引用以便后续检索。
## MCP
默认 HTTP 服务在 `http://127.0.0.1:2333/mcp` 提供 streamable HTTP MCP。常用工具包括:

65
docs/zh/screenpipe.md Normal file
View file

@ -0,0 +1,65 @@
# 导入已审核的 Screenpipe 笔记
[Screenpipe](https://github.com/screenpipe/screenpipe) 记录桌面活动和会议上下文。
可以把从这些记录中选出并审核过的笔记作为 ReMe 资源,生成每日记忆卡片,供后续 Agent 会话检索。
本指南使用现有的资源处理流程,手动导入笔记。
## 准备来源笔记
在 Screenpipe 中选择一次已结束的会议或工作片段。审核并修正保存的笔记,然后只把希望 ReMe 保留的信息
复制到 UTF-8 Markdown 文件中。先将文件保存在 ReMe 工作区之外,并包含:
- 标题,以及带时区的记录时间。
- Screenpipe 会议 ID,或可以在本机查找的其他来源标识。
- 审核后的笔记,以及尚未确认的信息。
以下为虚构示例:
```markdown
# 示例项目交接
来源:my-work-laptop 上的 Screenpipe 会议 42
记录时间:2026-01-15T10:00:00Z
已审核:是
团队选择用 CSV 导出进行交接。交付日期尚未确定。
```
保持来源设备标识稳定:不同安装中的会议 ID 可能相同。描述工作流程的笔记本身不能证明每一步都已成功执行。
## 添加到工作区
完成[快速开始](./quick_start.md),确认正在运行的 ReMe 服务所使用的工作区。
把审核后的文件复制到该工作区,例如:
```text
resource/2026-01-15/screenpipe-my-work-laptop-meeting-42.md
```
目录名使用会议日期。不要覆盖无关文件。审核完成后再复制:已启用的资源监听器可能在文件出现后立即处理它。
处理过程可能将笔记发送给 ReMe 配置的模型提供方。
如果资源监听器未启用,可以显式指定同一个工作区并调用现有 Job:
```bash
reme auto_resource workspace_dir=/absolute/path/to/your/workspace changes='[{"path":"resource/2026-01-15/screenpipe-my-work-laptop-meeting-42.md","change":"added"}]'
```
将示例路径替换为实际资源路径。首次导入时选择监听器或显式调用之一,不要同时使用两种方式。
## 确认后再使用记忆
检查 `daily/2026-01-15/` 下生成的卡片,确认 `source_resource` 指向复制的 Markdown 文件。
将卡片与原始笔记对照。随后通过 ReMe 的[搜索和读取接口](./memory_search.md),在另一会话中检索交接决定,
并保留来源路径。文件复制成功不等于解释和索引成功;重试失败的 Job 前先检查错误。
## 修正和删除
修正笔记时保留资源路径。监听器可以处理修改;如果监听器未启用,则使用 `change="modified"` 调用
`auto_resource`。现有资源契约通过精确的 `source_resource` 链接更新对应卡片。
删除 Screenpipe 中的原始记录不会删除导入的副本。要从 ReMe 删除该资源,可以删除选定的资源文件并让已启用的
监听器处理删除事件,或显式提交该路径并设置 `change="deleted"`。另外检查后续生成的 digest 知识;
删除来源卡片不代表所有衍生知识都已清除。
处理、重试和删除语义见 [Auto Resource](./auto_resource.md)。