Definition
CLAUDE.md
CLAUDE.md 是放置在项目根目录中的 Markdown 配置文件,为 Claude Code 提供持久化的项目专属指令。它向代理说明编码规范、架构、常用命令和规则,充当适用于该项目每次会话的长期记忆。
CLAUDE.md 的工作原理
当 Claude Code 启动会话时,它会自动读取项目根目录中的 CLAUDE.md 文件(以及父目录或子目录中的任何 CLAUDE.md 文件)。文件内容成为代理系统上下文的一部分,因此代理无需每次提醒即可遵循你的指令。这使代理的行为与团队规范保持一致。
CLAUDE.md 应包含哪些内容
- +项目架构概览和关键文件位置
- +编码规范(命名、格式、应使用或避免的模式)
- +测试、构建和部署的常用命令
- +"始终为新函数编写测试"或"不得直接修改认证模块"等规则
- +代理应了解的技术栈详情
markdown
# CLAUDE.md
## Project
Next.js 14 app with App Router, TypeScript, Tailwind CSS.
## Commands
- `npm run dev` — start dev server
- `npm test` — run Jest tests
- `npm run lint` — ESLint check
## Conventions
- Use server components by default
- Client components go in `components/client/`
- All API routes must validate input with Zod
- Write tests for every new utility function
## Do NOT
- Modify files in `lib/core/` without explicit approval
- Use `any` type in TypeScript
- Add new dependencies without justification保持 CLAUDE.md 简洁。代理每次会话都会读取它,因此只应包含跨多个任务都相关的信息。任务专属的细节放在提示词中即可。
CLAUDE.md 文件应该放在哪里?+
放在项目根目录中。Claude Code 也支持子目录中的 CLAUDE.md 文件,用于模块专属指令;以及父目录中的 CLAUDE.md 文件,用于组织级规则。所有适用文件会被合并。
CLAUDE.md 适用于其他 AI 工具吗?+
CLAUDE.md 是 Claude Code 专用的。但其他一些工具也采用了类似概念。Cursor 使用 .cursorrules,其他代理可能读取自定义配置文件。项目级 AI 指令的概念正在成为一种通行模式。
CLAUDE.md 应该多长?+
保持在 500 行以内。聚焦于最重要的规范和规则。代理可以随时读取单个文件了解详情——CLAUDE.md 应提供跨任务适用的高层上下文。
Related terms
Master Claude Code in days, not months
37 hands-on lessons from beginner to CI/CD automation. Module 1 is free.
START FREE →