CLAUDE.md 模板大全:50+ 框架模板示例
浏览 50+ 真实 CLAUDE.md 模板:React、Python、Go、TypeScript、Next.js 等框架,复制到项目根目录即可配置 Claude Code。
William Wang — TokRepo & GEOScore AI 创始人,专注 AI 开发者工具和搜索可见性。
一句话答案
CLAUDE.md 是放在项目根目录的配置文件,告诉 Claude Code 如何理解你的代码库约定、架构和首选模式。相当于 AI 版的 .editorconfig。本指南给出 50+ 按 React、Python、Go、TypeScript、Next.js 组织的即用模板,touch CLAUDE.md 后复制粘贴就生效。
了解如何使用 CLAUDE.md 模板为任何框架配置 Claude Code。本指南提供 50+ 按语言和框架组织的真实示例,以及编写自己模板的最佳实践。
前置条件
- 已安装 Claude Code
- 一个需要配置 Claude Code 行为的项目
- 基本了解你使用的框架约定
什么是 CLAUDE.md?
CLAUDE.md 是放在项目根目录的配置文件,告诉 Claude Code 如何与你的代码库协作。Claude Code 启动会话时自动读取此文件,理解项目约定、架构、首选模式和约束。
可以把它理解为 AI 版的 .editorconfig —— 不是配置缩进和换行,而是配置 AI 助手如何理解并贡献你的项目。
touch CLAUDE.md
CLAUDE.md vs .cursorrules vs AGENTS.md
| 文件 | 工具 | 用途 |
|---|---|---|
CLAUDE.md | Claude Code | 项目上下文和编码约定 |
.cursorrules | Cursor AI | Cursor 规则和模式 |
AGENTS.md | Codex CLI | Agent 行为配置 |
所有文件服务于同一目的,内容可在格式间迁移。
模板结构
# 项目名
## 概述
[项目做什么、技术栈、架构]
## 技术栈
- 前端:[框架,版本]
- 后端:[框架,版本]
## 项目结构
[关键目录及其内容]
## 开发命令
- `npm run dev` — 启动开发服务器
## 编码约定
[语言特定模式、命名、格式]
## 重要规则
[绝对不能做的事]
各框架模板
React + TypeScript
重点:函数组件、Tailwind、TanStack Query、Vitest。完整模板查看英文版。
Next.js 15(App Router)
重点:Server Components 优先、Server Actions 做数据变更、Prisma ORM。
Nuxt 3 + Vue 3
重点:Composition API、<script setup>、auto-imports、SSR 安全。
Python + FastAPI
重点:Pydantic v2、SQLAlchemy 2.0 async、uv 包管理、服务层模式。
Django 5.x
重点:Fat Model Thin View、DRF ViewSets、select_related 防 N+1。
Go + Chi
重点:标准布局、sqlc 类型安全 SQL、Context 传播、table-driven tests。
Rust + Axum
重点:thiserror 错误类型、Arc
完整模板内容请查看 英文版指南 或 TokRepo CLAUDE.md 模板合集。
编写最佳实践
1. 具体约束
## 差
- 遵循最佳实践
## 好
- 所有变量声明用 `const`,除非需要重新赋值
- 函数最大长度:30 行
- 每个导出函数必须有 JSDoc 注释
2. 包含实际命令
## 差
- 提交前跑测试
## 好
- 提交前运行 `npm test`
- 运行 `npm run lint:fix` 自动修复样式
3. 控制在 500 行以内
CLAUDE.md 读入上下文窗口,2000 行的文件浪费 token。保持专注于约定和约束。
FAQ
Q: 什么是 CLAUDE.md? A: 放在项目根目录的 markdown 配置文件,告诉 Claude Code 你的编码约定、项目结构和重要约束。
Q: 必须有 CLAUDE.md 吗? A: 不是必须,但添加后能显著提升代码质量。
Q: 放在哪里?
A: 项目根目录(和 package.json、go.mod 等同级)。Claude Code 启动时自动读取。
下一步
常见问题
CLAUDE.md、.cursorrules 和 AGENTS.md 有什么区别?+
CLAUDE.md 给 Claude Code 用,.cursorrules 给 Cursor AI 用,AGENTS.md 给 Codex CLI 用。三者服务于同一目的——告诉 AI 项目规范——内容可以跨格式迁移,只是文件名和加载位置不同。团队用多种工具时建议同时维护三份或用软链。
CLAUDE.md 应该写多少内容?+
建议控制在 200-500 行以内。太短没信息量,Claude 会凭直觉猜;太长会占用宝贵的上下文 Token。优先写别人容易写错的约定(架构、命名、依赖),通用的代码风格让 linter 去管。每次会话开始时 CLAUDE.md 会自动加载。
CLAUDE.md 里应该写什么内容?+
标准结构:项目名/概述、技术栈(框架+版本)、架构约定、目录结构、命名规范、禁止事项(don't do X)、常用命令(test/build/deploy)。关键是写项目特有的规则,不要写 React 最佳实践这种通用内容。
多人协作时 CLAUDE.md 如何管理?+
和源代码一起提交 Git,纳入 PR Review 流程。团队规范变更必须先改 CLAUDE.md 再改代码,确保 AI 和人类的执行标准一致。CLAUDE.md 变更频率通常比代码低 10 倍,但每次改动影响面很大,要慎重。
CLAUDE.md 生效吗?怎么验证?+
启动 Claude Code 后让它读一下 CLAUDE.md 并复述本项目的三条最重要规则,如果能准确回答说明加载成功。也可以让它按某个约定写一段代码,看是否遵守。如果没生效,检查文件是否在项目根目录且文件名大小写正确。