使用说明
Claude代码入门工具包
一个预先配置的Claude Code工作区,包含代理、技能、MCP服务器、钩子和规则。克隆一次,用于每个项目。
快速开始
git clone https://github.com/DevHammad0/claude-code-starter-kit my-project
cd my-project
bash scripts/setup.sh # one-time: installs generic rules to ~/.claude/rules/
然后在Claude Code中打开项目,并按照中的设置清单进行操作 CLAUDE.md.
运作原理
规则策略(上下文工程)
规则分为三层,以尽量减少不必要的上下文令牌使用:
| 图层 | 位置 | 加载时间 |
|---|---|---|
| 用户级别 | ~/.claude/rules/ |
这台机器上的每个会话、每个项目 |
| 始终在项目中 | .claude/rules/common/ |
此项目中的每个会话 |
| 路径范围 | .claude/rules/backend-standards.md |
仅在触碰时 backend/**/*.py |
| 路径范围 | .claude/rules/frontend-standards.md |
仅在触碰时 frontend/**/*.{ts,tsx} |
| 特定服务 | backend/CLAUDE.md, frontend/CLAUDE.md |
仅当在该目录中工作时 |
这意味着克劳德只看到与它实际工作相关的规则——更少的噪音,更好的遵守。
user-rules/ --通用规则(安装一次)
bash scripts/setup.sh
将7条通用规则复制到 ~/.claude/rules/:
coding-style.md--不变性、错误处理、文件大小限制git-workflow.md--常规提交、PR流程development-workflow.md--研究→ plan → TDD → 审查循环patterns.md-存储库模式,API响应格式performance.md--模型选择、上下文窗口管理security.md--OWASP检查表,秘密管理testing.md--TDD工作流程,80%覆盖率要求
这些适用于 每个项目 在你的机器上。运行安装程序一次;永远不要在每个项目中复制它们。
.claude/rules/ --项目规则
始终加载(否 paths 正面):
common/agents.md--代理列表以及何时使用每个代理common/hooks.md--吊钩行为指导
路径范围(根据堆栈进行编辑):
backend-standards.md--负载backend/**/*.pyfrontend-standards.md--负载frontend/**/*.{ts,tsx}
service-templates/ --子目录CLAUDE.md启动器
复制到您的实际服务目录中:
cp service-templates/backend/CLAUDE.md backend/CLAUDE.md
cp service-templates/frontend/CLAUDE.md frontend/CLAUDE.md
cp service-templates/auth/CLAUDE.md auth/CLAUDE.md
使用特定于服务的命令、结构和约束来编辑每个。这些仅在Claude在该目录中工作时按需加载。
包含的工具
代理商(.claude/agents/)
| 代理 | 何时使用 |
|---|---|
planner |
复杂功能、新阶段、分解任务 |
architect |
API结构、数据库架构、系统设计 |
tdd-guide |
任何新功能或错误修复 |
code-reviewer |
编写或修改任何代码后 |
security-reviewer |
身份验证流程、文件上传、用户输入 |
database-reviewer |
模式设计、迁移、查询优化 |
build-error-resolver |
Types/Python构建错误 |
e2e-runner |
需要Playwright测试的关键用户流 |
refactor-cleaner |
发布前清理死代码 |
doc-updater |
主要功能之后 |
技能(.claude/skills/)
| 技能 | 目的 |
|---|---|
api-design |
REST端点设计、分页、过滤 |
postgres-patterns |
PostGIS、查询优化、索引 |
database-migrations |
Alembic/Prisma迁移模式 |
security-review |
认证检查表、输入验证、上传安全 |
frontend-patterns |
React/Next.js,服务器与客户端组件 |
e2e-testing |
剧作家模式、页面对象模型 |
tdd-workflow |
TDD与pytest和剧作家 |
docker-patterns |
多级Dockerfile,编写设置 |
deployment-patterns |
Vercel+铁路部署 |
coding-standards |
通用干净代码规则 |
better-auth-best-practices |
更好的身份验证服务器/客户端设置 |
fastapi-templates |
生产就绪的FastAPI支架 |
shadcn |
shadcn/ui组件管理 |
vercel-react-best-practices |
Next.js性能模式 |
命令(.claude/commands/)
| 命令 | 它的作用 |
|---|---|
/plan |
在接触代码之前制定计划——写入 tasks/todo.md |
/tdd |
TDD工作流程:先测试,后实施 |
/code-review |
编写代码后的质量审查 |
/build-fix |
修复TypeScript/Python构建错误 |
/e2e |
生成并运行Playwright E2E测试 |
/quality-gate |
在标记阶段完成之前运行所有检查 |
/refactor-clean |
清除死代码 |
/verify |
对照计划验证实施情况 |
/test-coverage |
检查测试覆盖率报告 |
/update-docs |
功能后更新架构文档 |
MCP服务器(.mcp.json)
| 服务器 | 用途 |
|---|---|
supabase |
数据库管理、迁移、边缘功能 |
sequential-thinking |
复杂的多步骤推理 |
context7 |
最新的图书馆文档 |
magic |
UI组件生成 |
vercel |
部署管理 |
railway |
后端部署 |
shadcn |
shadcn/ui组件搜索 |
钩子(.claude/hooks/)
| Hook | 它做什么 |
|---|---|
post-edit-format.js |
文件编辑后自动格式化 |
post-edit-typecheck.js |
跑步 tsc --noEmit TS编辑后 |
post-edit-console-warn.js |
警告如果 console.log 留在prod代码中 |
pre-bash-git-push-reminder.js |
提醒推送前检查测试 |
cost-tracker.js |
跟踪每个会话的API使用成本 |
suggest-compact.js |
建议 /compact 近上下文限制 |
auto-tmux-dev.js |
在新终端窗口中打开开发服务器 |
session-start.js |
检测包管理器,设置别名 |
session-end.js |
会议工作总结 |
设置检查表(每个新项目)
- [ ]
bash scripts/setup.sh--安装用户级规则(每台机器一次) - []编辑
docs/development-stack.md--记录你的实际技术选择 - []更新
.mcp.json--替换占位符值 - []替换根
CLAUDE.md--项目标识+不可协商 - []复制
service-templates/→ 服务目录,填写详细信息 - []编辑
.claude/rules/backend-standards.md--您的后端规则 - []编辑
.claude/rules/frontend-standards.md--你的前端规则 - []审计
.claude/skills/--归档与您的堆栈无关的任何内容 - []创建
tasks/todo.md和tasks/lessons.md - []复制
.gitignore为您的项目创建模板和扩展
文档
docs/development-stack.md--技术栈模板docs/workflow.md--特征循环、相位图、快速参考service-templates/--每个服务的CLAUDE.md模板user-rules/--通过安装通用规则scripts/setup.sh