内容
# 克劳德代码启动套件
**一键从全新安装到高效使用。**
所有克劳德代码资源都是一个目录——“这里有200件事情，祝你好运。”这个仓库不同。它是一个**有倾向性的启动套件**，可以在一分钟内安装一个经过测试、精选的设置。
```bash
git clone https://github.com/ypollak2/claude-code-kickstart
cd claude-code-kickstart
./install.sh
```
就这样。你将获得一个配置文件选择器、自动备份现有配置的功能，以及以下所有内容的干净安装。
<p align="center">
<img src="assets/install-demo.svg" alt="安装演示" width="720">
</p>
---
## 您将获得
### 3 个 MCP 服务器（不是 200 个）
每个 MCP 服务器都需要上下文令牌才能存在。我们选择了 3 个值得的服务器：
| 服务器 | 为什么选择它 |
|--------|---------------|
| **Context7** | 实时库文档。克劳德停止产生过时的 API。 |
| **Playwright** | 浏览器自动化。测试 UI，抓取页面，验证部署。 |
| **Sequential Thinking** | 复杂问题的结构化多步骤推理。 |
> 为什么不更多？参见 [docs/WHY.md](docs/WHY.md#mcp-servers-why-only-3)
### 5 个经过实战测试的钩子
| 钩子 | 功能 |
|------|--------------|
| **自动格式化** | 在每次编辑后运行 Prettier/Ruff/goimports。零努力编写干净的代码。 |
| **阻止 rm -rf** | 防止破坏性删除事故。 |
| **阻止强制推送到 main** | 保护您的团队免受灾难。 |
| **阻止敏感文件** | 阻止克劳德编辑 .env、凭证、私钥。 |
| **桌面通知** | 在长时间任务完成后收到通知（macOS + Linux）。 |
### 15 个特定用途的代理
| 代理 | 模型 | 访问权限 | 目的 |
|-------|-------|--------|---------|
| **代码审查员** | Sonnet | 只读 | 查找错误、安全问题、质量问题 |
| **计划者** | Opus | 只读 | 在过早编码之前创建实现计划 |
| **安全审计员** | Sonnet | 只读 | OWASP Top 10、秘密扫描、依赖项检查 |
| **调试器** | Sonnet | 完全 | 系统地重现、隔离和修复错误 |
| **测试编写器** | Sonnet | 完全 | 编写全面测试 - 正常路径、边缘情况、错误 |
| **重构者** | Sonnet | 完全 | 改进代码结构 - 始终在前后运行测试 |
| **文档编写器** | Sonnet | 完全 | 通过阅读代码而不是猜测来生成文档 |
| **PR 审查员** | Sonnet | 只读 | 审查整个 PR - 所有提交、测试、设计 |
| **性能分析器** | Sonnet | 只读 | 查找 N+1 查询、内存泄漏、不必要的重新渲染 |
| **迁移者** | Opus | 完全 | 安全地升级依赖项和迁移框架 |
| **Git 助手** | Sonnet | 只读 | 复杂的 Git 操作 - 变基、冲突解决、双向追踪 |
| **API 设计器** | Opus | 完全 | 设计具有适当契约的一致 REST/GraphQL API |
| **无障碍检查器** | Sonnet | 只读 | WCAG 合规性、ARIA、键盘导航、颜色对比度 |
| **依赖项审计员** | Sonnet | 只读 | 过时包、CVE、未使用的依赖项、许可问题 |
| **入职培训员** | Sonnet | 只读 | 映射不熟悉的代码库 - 堆栈、结构、模式、工作流 |
特定于配置文件的代理：Rust 审查员、Go 审查员、Java 审查员、Laravel 审查员、基础设施审查员、数据分析师。
### 6 种斜杠命令技能
| 技能 | 功能 |
|-------|-------------|
| **/review** | 快速审查暂存/未暂存更改 |
| **/test** | 运行测试、报告结果、修复失败 |
| **/security-scan** | 全面的安全审计（代码 + 依赖项） |
| **/onboard** | 映射不熟悉的代码库并生成 CLAUDE.md |
| **/dep-check** | 审计依赖项：过时、易受攻击、未使用 |
| **/deploy-check** | 预部署检查清单：测试、构建、安全、环境、迁移 |
### 尊重隐私的默认设置
- 遥测和错误报告 **关闭**
- 凭证路径（`~/.ssh`、`~/.aws`、`~/.gnupg`）**拒绝**
- 项目 MCP 服务器 **需要明确选择**
- 细粒度权限（`Bash(git *)` 而不是 blanket `Bash`）
### Shell 集成
```bash
# 核心
cc # 'claude' 的简写
ccp # 计划模式
ccr # 恢复上一个会话
# 代码操作
ccreview # 审查当前 git diff
ccfix # 查找并修复失败的测试
cctest <file> # 为文件编写测试
ccrefactor <file> # 安全地重构文件
cce <file> # 解释文件
ccrf <file> # 审查特定文件
ccq 'question' # 快速一次性提问
# Git 帮助程序
cccommit # 智能提交消息
ccpr <number> # 通过编号审查 PR
ccrebase # 交互式变基帮助
ccbisect 'what broke' # 查找导致问题的提交
# 项目设置
ccinit # 创建启动 CLAUDE.md
ccscan # 通过扫描项目自动生成 CLAUDE.md
# 维护
cchealth # 健康检查 - 验证您的设置是否正常工作
ccupdate # 拉取最新的启动配置
ccsessions # 列出最近的克劳德会话
```
zsh 和 bash 包含标签补全。
---
## 配置文件
在安装期间选择配置文件，或传递 `--profile <name>`：
| 配置文件 | 添加内容 |
|---------|-------------|
| **essential** | 上面的所有内容。从这里开始。 |
| **web-dev** | + npm/yarn/pnpm/bun, vitest/jest, Playwright, ESLint, Prettier |
| **python** | + python/pip/uv/poetry, pytest, ruff/black/mypy |
| **fullstack** | + web-dev 和 python |
| **rust** | + cargo/clippy/rustfmt, **Rust 审查员代理** |
| **go** | + go 工具/golangci-lint, **Go 审查员代理** |
| **devops** | + Docker/K8s/Terraform/Helm, **基础设施审查员代理**, 阻止破坏性操作 |
| **data-science** | + jupyter/pandas/DVC, **数据分析师代理** |
| **java** | + Maven/Gradle/Spring Boot, **Java 审查员代理**, Spotless 自动格式化 |
| **php** | + Composer/Laravel/Artisan, **Laravel 审查员代理**, Pint 自动格式化 |
| **mobile** | + React Native/Expo/Flutter/Xcode/Gradle |
| **privacy-first** | + 强化凭证锁定，所有遥测禁用 |
配置文件 **堆栈**：essential 始终是基础，您的选择配置文件在此基础上添加。
每个语言配置文件都包括：
- **settings.json** - 该生态系统的工具权限
- **hooks.json** - 语言特定的自动格式化 + lockfile 保护
- **CLAUDE.md** - 具有堆栈、命令、架构、约束的启动模板
- **agents/** - 语言特定的审查代理（如果适用）
### 自动检测
不知道哪个配置文件？让安装程序自行判断：
```bash
cd your-project
/path/to/claude-code-kickstart/install.sh --auto
```
它读取 `package.json`、`Cargo.toml`、`go.mod`、`pom.xml`、`composer.json`、`requirements.txt`、`Dockerfile` 等文件，以建议正确的配置文件。
---
## 安装选项
```bash
# 交互式（推荐首次使用）
./install.sh
# 自动检测项目类型
./install.sh --auto
# 非交互式，指定配置文件
./install.sh --profile rust --no-prompt
# 预览而不进行更改
./install.sh --dry-run
# 跳过特定组件
./install.sh --skip-plugins --skip-mcp --skip-shell
# 撤销所有更改
./uninstall.sh
```
### 安装后
安装完成后，打开克劳德代码并安装推荐的插件：
/plugin install feature-dev@claude-plugins-official
/plugin install code-review@claude-plugins-official
/plugin install hookify@claude-plugins-official
然后运行 `cchealth` 以验证所有内容是否正常工作。
---
## 文档
| 文档 | 内容 |
|-----|-------------|
| [WHY.md](docs/WHY.md) | 每个选择背后的原因 - 每个组件背后的推理 |
| [CUSTOMIZE.md](docs/CUSTOMIZE.md) | 如何根据您的需求修改设置 |
| [RECIPES.md](docs/RECIPES.md) | 10 个端到端工作流程：入职培训、TDD、PR 审查、迁移 |
| [TIPS.md](docs/TIPS.md) | 高级用户技巧 - 代理链接、令牌效率、钩子技巧 |
| [FAQ.md](docs/FAQ.md) | 关于配置文件、代理、钩子和 MCP 服务器的常见问题 |
| [TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md) | 常见问题的快速解决方法 |
---
## 项目结构
```
claude-code-kickstart/
├── install.sh # 一键安装，自动检测
├── uninstall.sh # 干净地删除并恢复备份
├── CHANGELOG.md # 版本历史
├── profiles/
│ ├── essential/ # 基础配置（始终安装）
│ │ ├── settings.json # 权限、隐私、思考
│ │ ├── hooks.json # 自动格式化、安全防护
│ │ ├── keybindings.json # 高级用户快捷键
│ │ ├── mcp-servers.json # Context7、Playwright、Sequential Thinking
│ │ ├── CLAUDE.md # 启动模板
│ │ ├── agents/ # 15 个特定用途的代理
│ │ └── skills/ # 6 种斜杠命令技能
│ ├── web-dev/ # JS/TS：设置、钩子、CLAUDE.md 模板
│ ├── python/ # Python：设置、钩子、CLAUDE.md 模板
│ ├── rust/ # Rust：设置、钩子、CLAUDE.md、审查代理
│ ├── go/ # Go：设置、钩子、CLAUDE.md、审查代理
│ ├── java/ # Java：设置、钩子、CLAUDE.md、审查代理
│ ├── php/ # PHP：设置、钩子、CLAUDE.md、审查代理
│ ├── devops/ # DevOps：设置、CLAUDE.md、基础设施审查员
│ ├── data-science/ # 数据科学：设置、CLAUDE.md、数据分析师代理
│ ├── mobile/ # 移动端：设置
│ └── privacy-first/ # 强化安全设置
├── assets/
│ └── install-demo.svg # README 的终端截图
├── shell/
│ └── aliases.sh # 20+ 命令，支持标签补全
└── docs/
├── WHY.md # 每个选择背后的原因
├── CUSTOMIZE.md # 如何修改以适应您的需求
├── RECIPES.md # 10 个端到端工作流程
├── TIPS.md # 高级用户技巧
├── FAQ.md # 常见问题解答
└── TROUBLESHOOTING.md # 常见问题的快速解决方法
```
---
## 哲学
1. **有倾向性 > 全面性。** 我们选择最好的东西，而不是列出所有东西。
2. **解释每个选择。** 阅读 [WHY.md](docs/WHY.md) 以了解背后的推理。
3. **安全的默认设置。** 隐私开启，破坏性命令被阻止，凭证受到保护。
4. **易于撤销。** 安装时自动备份，干净的卸载脚本。
5. **配置文件，而不是分支。** 一个仓库适应您的堆栈。
6. **验证您的设置。** `cchealth` 告诉您哪些功能正常，哪些功能不正常。
---
## 要求
- [克劳德代码 CLI](https://docs.anthropic.com/en/docs/claude-code) 已安装
- Node.js 18+（用于通过 npx 的 MCP 服务器）
- `jq`（如果缺少，则通过 Homebrew 自动安装）
- macOS 或 Linux
---
## 贡献
发现一个改变您工作流程的钩子？一个特别有效的代理提示？欢迎提交 PR - 但请记住我们的哲学：每个新增内容都必须赢得它的位置。我们宁愿拥有 10 件优秀的东西，而不是 50 件普通的。
---
## 许可证
MIT
