Claude Code|使用 CLAUDE.md 添加规则

Claude Code|使用 CLAUDE.md 添加规则

CLAUDE.md 是一个特殊文件,Claude 在开始对话时会自动将其纳入上下文。类似于 Cursor 中的 Rules。

CLAUDE.md 文件没有固定格式要求,应当保持内容简洁且易于阅读。

# Bash 命令
- npm run build:构建项目  
- npm run typecheck:运行类型检查器

# 代码风格
- 使用 ES 模块(import/export)语法,避免使用 CommonJS(require)  
- 尽可能使用解构导入(例如:import { foo } from 'bar')

# 工作流程
- 完成一系列代码更改后务必运行类型检查  
- 为了性能,优先运行单个测试而不是整个测试套件

创建规则文件

用户规则文件

类似于 Cursor 的User Rules,会应用于所有的 Claude 会话。

创建在用户主目录中:~/.claude/CLAUDE.md 

项目规则文件

CLAUDE.md 文件可放在项目根目录、上级目录以及下级目录。

  • 当前目录及上级目录:​Claude Code总是从当前工作目录开始,向上递归至根目录/,并读取找到的所有 CLAUDE.md 或 CLAUDE.local.md 文件。
  • 下级目录:只有当 Claude 读取这些子树中的文件时才会被包含进来。

初始化

使用 /init 初始化 CLAUDE.md 文档,Claude Code 会自动在 Project 根目录创建规则文档。

迭代

CLAUDE.md 文件应该像项目本身一样,持续的迭代和改进。

官方建议花时间进行实验,找出最能引导模型遵循指令的方案。

使用 # 自动修改规则文件

使用 /memory 快速打开规则文件

会在系统编辑器中打开。

最佳实践

  • 具体明确:与其写“格式化代码”,不如写“使用 2 个空格缩进”这样更具体。
  • 使用结构组织内容:将每条内存格式化为项目符号,并使用有描述性的 Markdown 标题对相关内容进行分组。
  • 定期审查:随着项目发展,及时更新内存,确保 Claude 始终使用最新的信息和上下文。

使用 Git 来管理规则