记忆文件说明

记忆文件用来告诉 Claude Code 或 Codex：这个项目是什么、要遵守什么规则、常用命令是什么。它能减少你每次重新解释项目背景的次数。

适合谁看

• 经常在同一个项目里使用 Claude Code 或 Codex。
• 希望 CLI 自动知道构建命令、测试命令和项目边界。
• 希望团队共享同一套 AI 使用规则。

Claude Code：CLAUDE.md

Claude Code 使用 CLAUDE.md。你可以在仓库根目录放一份，也可以在子目录放更具体的规则。

多个层级会一起生效。越靠近当前文件的规则，越应该写得具体。

常见位置：

位置	用途
~/CLAUDE.md	个人全局偏好
项目根目录/CLAUDE.md	项目规则
子目录/CLAUDE.md	模块级规则

Codex：AGENTS.md

Codex 使用 AGENTS.md。如果同一个项目同时用 Claude Code 和 Codex，可以维护两份内容相近的文件：

• CLAUDE.md 给 Claude Code。
• AGENTS.md 给 Codex。

建议写什么

内容	示例
项目定位	这是一个 Elucid Relay 文档站
常用命令	npm run dev、npm run build
目录说明	文档在 docs/，主题在 .vitepress/theme/
写作规则	先给步骤，再解释原因
安全规则	不写入真实 API Key、Cookie、Token
验证规则	改完文档后跑 npm run build

示例

# 项目说明

这是一个 VitePress 文档站，用来维护 Elucid Relay 使用文档。

## 常用命令

- 安装依赖：npm install
- 本地开发：npm run dev
- 构建检查：npm run build

## 写作规则

- 面向新手用户，先给操作步骤，再解释原因。
- 不把 API Key、Cookie、Token 写进文档。
- 示例 Key 使用 sk-relay-xxxxxxxx。
- 截图统一放在 docs/public/screenshots/。

和上下文压缩的关系

记忆文件不能阻止上下文压缩，但可以降低压缩后的遗忘风险。因为项目规则被写在文件里，CLI 可以重新读取，而不是只依赖聊天历史。

场景	建议
临时任务	直接在对话里说明
长期规则	写进 CLAUDE.md / AGENTS.md
验收标准	写进 issue、计划或任务文档
敏感信息	不写进记忆文件

记忆文件也会被提交

如果文件在项目仓库里，默认会进入版本控制。不要把真实 Key、私有链接或客户数据写进去。