项目配置
项目配置
在开始使用 Claude Code 之前,先让它理解你的项目。
/init — 自动生成项目文档
运行 /init,Claude 会读取代码库并自动生成 CLAUDE.md:
- 构建和测试命令
- 关键目录及其用途
- 代码约定和模式
- 重要的架构决策
这是在任何新项目中应该运行的第一条命令。
CLAUDE.md — 项目记忆
CLAUDE.md 是 Claude Code 理解项目的核心文件。Claude Code 从工作目录向上遍历,将所有 CLAUDE.md 文件串联加载。
放置位置与优先级
| 文件位置 | 作用域 | 场景 |
|---|---|---|
~/.claude/CLAUDE.md | 用户全局 | 个人偏好 |
项目根/CLAUDE.md | 项目共享 | 提交到 Git,团队共享 |
项目根/.claude/CLAUDE.md | 项目共享 | 同上 |
项目根/.claude/CLAUDE.local.md | 项目本地 | 不提交,个人定制 |
编写有效的 CLAUDE.md
原则:保持简短(目标 200 行以内),使用 Markdown 结构,具体可验证,保持一致性。
# 项目:AI 文档站点
## 构建
- `pnpm docs:dev` 启动开发服务器
- `pnpm docs:build` 构建生产版本
## 约定
- 使用 Vue 3 Composition API
- TypeScript 严格模式
- 组件按功能目录分组,不按类型分组导入额外文件
使用 @path/to/import 语法导入其他文件内容,支持最多 5 层递归:
@./docs/api-conventions.md
@./docs/testing-guide.md也支持 @AGENTS.md 导入兼容其他 AI 工具的指令。
提示
大型团队可以部署组织级 CLAUDE.md 到共享位置,通过 CLAUDE_CODE_ADDITIONAL_DIRECTORIES_CLAUDE.md 环境变量加载。
记忆更新
无需手动编辑文件,直接告诉 Claude 来更新:
"更新 Claude.md:在这个项目中始终使用 bun 而不是 npm"
.claude/rules/ — 模块化规则
对于较大的项目,创建 .claude/rules/ 目录存放按主题分组的指令。每个 .md 文件都会自动加载。
支持 YAML frontmatter 按文件路径条件匹配:
---
paths: src/api/**/*.ts
---
# API 开发规则
- 所有 API 端点必须包含输入验证
- 使用 Zod 进行 schema 验证
- 错误响应遵循 RFC 7807 格式用户级规则放在 ~/.claude/rules/。支持 symlink。
Auto Memory — Claude 自主记忆
除了你写的 CLAUDE.md,Claude Code 还有自动记忆功能(默认开启)。Claude 会自主决定记住什么,存储在 ~/.claude/projects/<project>/memory/,通过 MEMORY.md 作为入口。
/memory命令浏览和编辑记忆内容- Auto memory 的内容 Claude 自己决定,你不需要手动管理
注意
CLAUDE.md 是你写的指令,Auto Memory 是 Claude 自己写的笔记。两者互补但不冲突。
@ 提及 — 即时添加上下文
@ 提及是向 Claude 提供上下文的最快方式:
| 语法 | 说明 |
|---|---|
@src/auth.ts | 将文件添加到上下文 |
@src/components/ | 引用整个目录 |
@mcp:github | 启用/禁用 MCP 服务器 |
@AGENTS.md | 引用 AI 工具配置 |
@browser | 触发浏览器自动化 |
在 Git 仓库中支持模糊匹配,速度约快 3 倍。
