简介
Claude Code 模板工程是一套预先配置好的项目脚手架,内置 .claude 配置目录、CLAUDE.md、忽略规则、技能、钩子。新建项目时直接复用模板,一次性统一编码规范、Agent权限、上下文规则,避免每个项目重复配置。
适用场景:个人开发脚手架、团队统一规范、批量新建同类型项目。
一、模板工程目录结构
claude-code-template/
├── CLAUDE.md # 项目规则、编码规范、项目介绍
├── .env.example # 环境变量示例(提交仓库,不含密钥)
├── .gitignore # Git忽略文件
└── .claude/
├── config.json # Claude Code 核心配置
├── ignore # Claude Code 文件忽略规则
├── skills/ # 自定义技能目录
│ └── README.md
└── hooks/ # 钩子脚本目录
└── README.md
文件说明
| 文件 | 作用 |
|---|---|
CLAUDE.md | 定义项目栈、编码风格、Agent行为约束,每次会话自动读取 |
.env.example | 环境变量模板,团队成员复制为 .env 填入自己密钥 |
.claude/config.json | 项目默认模型、权限、最大工具轮次、记忆开关 |
.claude/ignore | Claude Code 读取文件过滤,独立于 .gitignore |
.claude/skills/ | 存放通用可复用技能,例如代码检查、文档生成 |
.claude/hooks/ | 全局钩子,如会话启动钩子、保存文件后钩子 |
二、模板核心文件示例
1. .claude/config.json
{
"model": "claude-3-5-sonnet-latest",
"maxToolTurns": 10,
"autoMemory": false,
"permissions": {
"read": true,
"write": true,
"bash": false
},
"skillsDir": "./.claude/skills",
"hooksDir": "./.claude/hooks"
}
2. .claude/ignore
# 密钥与环境文件 .env *.env构建产物 node_modules/
dist/
build/
*.log 操作系统文件.DS_Store
Thumbs.db
3. CLAUDE.md 模板
# 项目说明 本项目基于 Claude Code 模板工程。## 技术栈
TypeScript / Nuxt / TailwindCSS v4 ## 编码规范
1. 优先使用TypeScript,严格类型校验。
2. 组件使用 shadcn/ui。
3. 修改代码前先阅读相关文件,理解上下文。
4. 批量修改前先列出改动清单。
5. 禁止修改 .env 文件。## Agent约束
1. 禁止自动执行bash命令,如需执行必须先征得确认。
2. 达到最大工具轮次时输出总结,停止继续迭代。
3. 不要读取 .env、日志文件。
4. .env.example
ANTHROPIC_API_KEY=
CLAUDE_CODE_LOG_LEVEL=debug
CLAUDE_CODE_NO_MEMORY=true
CLAUDE_CODE_NO_MCP=true
三、模板工程使用流程
1. 创建模板仓库
- 新建Git仓库,创建上面全套目录与配置文件
- 检查:不要放入真实API密钥,只保留
.env.example - 提交到Git,作为模板源
2. 基于模板新建项目
方式1:Git模板克隆
# 克隆模板 git clone https://xxx/claude-code-template.git my-new-project cd my-new-project# 删除模板Git历史
rm -rf .git
git init
方式2:IDE模板(VS Code)
将模板目录保存为本地模板,新建项目时一键生成目录结构。
3. 新项目初始化
# 复制环境变量模板
cp .env.example .env
编辑 .env,填入个人 ANTHROPIC_API_KEY。
启动 Claude Code,执行:
/config
验证配置加载成功。
四、模板工程自定义扩展
添加通用Skills
将项目通用技能放入 .claude/skills/,例如:
- code-review:代码审查
- doc-generator:自动生成API文档
- plan-creator:生成Coding Plan
技能会在项目启动自动加载,使用
/skills查看。
添加Hooks
在 .claude/hooks/ 添加钩子脚本,例如:
- onSessionStart:会话启动提示,输出项目开发规范
- onFileWrite:保存文件后自动运行格式化
五、多模板方案
可以维护多套模板,适配不同技术栈:
template-nuxt:Nuxt + TailwindCSS v4 前端项目模板template-node:Node.js后端模板template-python:Python后端模板template-empty:最简空白模板
六、最佳实践
- 模板仓库只存放通用配置,不存放业务代码、密钥。真实密钥放在本地
.env,不提交Git。 - 模板默认安全配置:关闭bash、关闭autoMemory,降低误操作风险。
- 模板更新后,已有项目按需合并
.claude、CLAUDE.md 变更,不要直接覆盖业务代码。 - 模板内固定
maxToolTurns,防止Agent无限循环调用工具。 - 团队使用模板时,统一CLAUDE.md编码规范,保证AI输出风格一致。
七、常见问题
- 新建项目后配置不生效
检查:复制模板后,确认
.claude目录完整;启动会话执行/reset。
- 技能无法加载
确认
skillsDir路径配置正确;技能文件语法无误,执行/skills查看加载列表。
- 模板迁移到Windows路径异常
配置统一使用相对路径,不要写死绝对路径。
小结
Claude Code模板工程的核心价值:标准化脚手架,统一项目配置与编码规则,一键初始化新项目,减少重复配置工作。模板包含 .claude 配置、CLAUDE.md、忽略规则、通用技能钩子。团队可维护多套技术栈模板,新项目基于模板快速启动。
0 条笔记