[English](README.md) | **简体中文**

# user-md / 一份会成长的 USER.md

> 你的 AI 对你的理解——存在一个你自己拥有的文件里。你的文件夹搬到哪，它跟到哪。

## 让你的 AI 认识你

user-md 是一套纪律，把你的 AI 对你的理解统一保存在一个你自己拥有的 Markdown 文件里：`USER.md`。它终结了"每次都要重新解释一遍"——你的角色、你的标准、你喜欢答案怎么给你——而且和厂商的云端记忆不同，它随你的文件夹一起搬家。手写区记录你是谁；agent 养护区随着带日期、带置信标签的观察持续生长。

**每个 agent 都有一份"关于我"。你也该有一份"关于你"。**

`USER.md` 留空，agent 照样能跑——只是每次会话都对你一无所知。而且和被锁在厂商云端账号里的记忆功能不同，这份文件就放在你的文件夹里——你可读可改，你指给哪个 agent 用它就能用。正如一位评论者谈到某厂商"仅为满足 GDPR 而做"的记忆导出功能时所说："这个导出功能是为了应付监管，不是为了用户。"（Nick Sawinyh）

## 三层结构，两条轨道

```mermaid
flowchart TB
    subgraph U["USER.md —— 可迁移，每会话加载"]
        direction TB
        subgraph H["手写轨道 —— 你亲笔写，agent 只能建议"]
            W1["我是谁"]
            W2["我怎么工作"]
            W3["我们的关系"]
            W4["我在忙什么"]
        end
        subgraph A["agent 养护轨道 —— 只追加、带日期、带置信标签"]
            W5["agent 学到的"]
        end
    end
    LOCAL["USER.local.md —— 机器本地，已 gitignore<br/>环境 · 工具链 · 路径 · 凭据指针"]
    PROJ["项目本地文件<br/>只在单个项目里成立的事实"]
    OVER["user/*.md 溢出文件<br/>主文件体量超预算时下沉的细节"]

    W5 -- "重复观察 + 你明确同意" --> H
    W5 -- "溢出" --> OVER
    U -. "换机器就失效？→ 改存这里" .-> LOCAL
    U -. "只在单个项目里成立？→ 改存这里" .-> PROJ
```

**三层**——关于你的一条事实该归哪：

| 层 | 文件 | 判据 |
|---|---|---|
| 可迁移画像 | `USER.md` | 换任何机器、任何项目依然成立 |
| 机器本地 | `USER.local.md`（已 gitignore） | 换机器就不再成立 |
| 项目本地 | 该项目自己的上下文文件 | 出了这个项目就不成立 |

`USER.md` 内部的**两条轨道**：

- **手写轨道**——`我是谁`、`我怎么工作`、`我们的关系`、`我在忙什么`。由你亲笔撰写。agent 可以建议修改，但只有在你明确确认后才能应用——绝不静默改写这条轨道。
- **agent 养护轨道**——`agent 学到的`。只追加。每条记录都带日期、来源事件与置信标签；单次观察必须显式标注"待验证"。重复出现的观察可以被*升级*进手写轨道——但必须经你明确同意。任何内容都不会被静默改写；一切内容对你可见、可编辑、可删除。

主文件刻意保持小体量，好让它能每次会话都全量加载；细节溢出到 `user/*.md` 辅助文件里。确切的体量、升级与整合阈值统一定义在一处：[`references/curation.md`](references/curation.md)。

## 它和同类方案的区别

| | **user-md** | 云端记忆功能 | 记忆层产品（服务+数据库） | 原生 OpenClaw `USER.md` |
|---|---|---|---|---|
| 存在哪 | 你文件夹里的一个文件 | 你的厂商账号里 | 一个服务+数据库 | 你文件夹里的一个文件 |
| 能否直接读写 | 纯 Markdown，任意编辑器 | 仅限产品自带界面 | API/SDK | 纯 Markdown |
| 能否跨厂商迁移 | 能——拷贝文件夹即可 | 不能 | 取决于是否自建 | 能 |
| 成长机制 | 双轨养护纪律 | 自动，有时静默 | 自动化管道 | 无——静态、纯手填 |
| 审计轨迹 | 每条都带日期+来源 | 有限 | 因产品而异 | 无 |

user-md 填补的空档：文件形态的工具没有成长机制，会成长的工具又不是文件形态。这是一份**会成长的文件**——在显式、可审计的规则之下成长。

## 兼容性

`USER.md` 这个约定源自 **OpenClaw** agent 工作台，该文件在那里被定义为"用户是谁、该怎么称呼他们。每次会话都会加载。"（docs.openclaw.ai）。它*不属于* AGENTS.md 标准的一部分——那个标准里没有用户画像这个槽位。user-md 沿用了 OpenClaw 的命名与每会话加载模型，并在其上加了分层与养护纪律。

### OpenClaw

即插即用。`USER.md` 只占据"用户"这一根轴；`SOUL.md`、`IDENTITY.md`、`MEMORY.md` 保持不动。把模板拷进你的工作台即可。

### Claude Code

在你的 `CLAUDE.md`（项目级，或全局用 `~/.claude/CLAUDE.md`）里加一行引用：

```
@USER.md
```

也可以选择改挂 SessionStart hook——示例配置见 [`SKILL.md`](SKILL.md)。这个 hook 是可选接法，不是内置运行时；不挂它纪律照样成立。

### 其他任意 harness

任何在会话开始时读取指令的工具都能用这套。在它的系统提示或规则文件里加一句类似"开工前先读 USER.md 的相关小节"。跨厂商传输与会话内注入都需要用户授权；只加载任务所需的小节，别把"可迁移"当成无条件的全量披露许可。

## 安装（2 分钟）

1. 把 `templates/USER.md` 和 `templates/USER.local.md` 拷进你的工作台根目录。
2. 在第一次 commit 之前，把 `USER.local.md` 加进 `.gitignore`。
3. 按你的 harness 接上会话加载（见上面「兼容性」）。

然后花五分钟填好 `USER.md` 的前四节。诚实的要点胜过打磨过的长句。

想让你的 agent 也学会养护规则，把这个文件夹也装成 skill/plugin：

```
gh skill install LucioLiu/user-md user-md --agent claude-code --scope user
```

或者直接把文件夹拷进你 harness 的 skills 目录（中文用户请改拷贝 [`SKILL.zh-CN.md`](SKILL.zh-CN.md) 并在本地重命名为 `SKILL.md`）。或者干脆跟你的 agent 说："读一下这个文件夹里的 `SKILL.md`，帮我把 user-md 配起来。"

本次发行以根目录的 `plugin.json` 作为包清单。（另有一份 `.claude-plugin` 打包变体留在未发布的工作区里，**刻意不随本次发行分发**——别在你装到的副本里找那个目录。）

## 卸载

删掉 plugin/skill 文件夹即可。你的 `USER.md` 文件族原地不动——那些文件是你的，这正是重点所在。

## 版本与自检

- 当前版本：**1.1.0**（见 `plugin.json`）。
- 仓库地址：`https://github.com/LucioLiu/user-md`
- 自检方式：把你装的 `SKILL.md` 与 `plugin.json` 对比仓库 main 分支的 diff。

## 验证边界

统一结构测试入口、隐私/gitignore 检查、独立行为 case bundle **尚未在本仓发布**——别指望你装到的副本里有 `tests` 目录。何况结构测试 PASS 本来也不能证明养护行为或跨 harness 加载已验证：两条冻结行为用例在被独立执行与裁决之前保持 `not-run`。

## 隐私

这个文件族天生就是 PII——按你手上最敏感的内容来对待它。`USER.local.md` 必须 gitignore。推到任何公开仓库之前必须人工审阅一遍 `USER.md`。两个文件都绝不能存明文凭据——只放指针。"随你搬家"指的是用户自己可以携带这份文件，不代表自动获得跨项目、跨厂商或跨模型的共享授权。每一次转移/加载都必须遵循用户的明确授权与最小必要披露原则。模板里附带的全部示例均为虚构。

## License

[PolyForm Noncommercial 1.0.0](LICENSE) — 个人与非商业使用免费。

---

> 中英文双版同步维护；如有出入，以**英文版**为准——发现不一致请开 [issue](https://github.com/LucioLiu/user-md/issues)。