内容
# 克劳德初始化 — 将克劳德代码转变为自主工程团队,只需一条命令
> 将规范驱动、TDD优先、验证门控、安全意识的代理工作流添加到**任何**仓库中,只需一行命令。克劳德从聊天框转变为有纪律的团队:规范 → 计划 → 任务 → 实现(严格的TDD)→ 验证 → 审查 → 发布。
<!-- 添加一个演示GIF图以获得最大的第一印象提升。参见docs/DEMO.md以录制一个:
 -->
**为什么要给这个项目点赞:**
- 🏭 **一行命令,适用于任何仓库** — 新项目或旧项目。安全协调,不会覆盖您的文件。
- 🔒 **安全优先** — 钩子硬阻止破坏性命令 + 在代理执行前扫描秘密。
- ✅ **证据,而不是感觉** — 没有任务是“完成”的,除非有红→绿的TDD分类账和通过验证器。
[](.github/workflows/harness-validate.yml)
[](https://code.claude.com)
[](https://modelcontextprotocol.io)
[](LICENSE)
[](CONTRIBUTING.md)
## 一行命令安装
从您想要利用的仓库的**根目录**:
```bash
curl -fsSL https://raw.githubusercontent.com/qyndex/claude-init/main/scripts/install.sh | bash
```
就这样了。安装程序将工厂克隆到一个临时目录中,安全地协调到您的仓库中(**备份**任何它将覆盖的文件到`.brownfield-backup/`,永远不会静默覆盖您的`README.md`/`CLAUDE.md`),然后运行设置。它适用于全新的仓库和现有的仓库。如果您不喜欢将内容输送到shell中?下载并先阅读:
```bash
curl -fsSLO https://raw.githubusercontent.com/qyndex/claude-init/main/scripts/install.sh
less install.sh && bash install.sh
```
**然后**完成[手动设置](#手动设置-安装程序无法完成)(GitHub规则集,Actions秘密,可选部署)。参见下面的[完整逐步指南](#逐步采用)。
<details>
<summary>安装程序选项(环境变量)</summary>
| 变量 | 效果 |
|---|---|
| `CLAUDE_INIT_REF=<ref>` | 安装特定的分支/标签/SHA(默认为`main`) |
| `INTO=<dir>` | 目标仓库目录(默认为当前目录) |
| `UPGRADE=1` | 已经采用?刷新工厂拥有的文件(首先备份) |
| `SKIP_SETUP=1` | 仅协调,不运行`setup.sh` |
| `SKIP_PLUGINS=1` | 跳过设置中的插件安装 |
| `YES=1` | 非交互式(允许脏工作树) |
</details>
## 这是什么
一个完整的克劳德代码代理套件,包括:
- **宪法** — `.claude/CLAUDE.md` — 代理的操作规则
- **工程团队** — `.claude/agents/`下的10个专门的子代理
- **工作流** — 八个阶段(构建 → 指定 → 澄清 → 计划 → 任务 → 分析 → 实现 → 验证 → 审查 → 发布),每个阶段都是一个斜杠命令
- **纪律** — TDD,验证完成前,浏览器E2E,安全防护,令牌预算,自动循环,研究基础
- **记忆系统** — `.claude/memory/`包含决策,模式,事件,剧本
- **安全防护栏** — `.claude/hooks/`阻止破坏性命令,扫描秘密,审计依赖项
- **MCP服务器** — `.mcp.json`预连到文件系统,git,github,chrome-devtools,playwright,context7,postgres,sentry
- **CI/CD** — `.github/workflows/`包含claude-code-action,claude-code-security-review,CI矩阵,E2E在预览,自动合并Dependabot,release-please
- **模板** — `specs/templates/`,`plans/templates/`(Spec Kit样式)
## 逐步采用
### 1. 安装(一行命令)
从您的仓库根目录运行(参见[一行命令安装](#一行命令安装)以获取安全详细信息):
```bash
curl -fsSL https://raw.githubusercontent.com/qyndex/claude-init/main/scripts/install.sh | bash
```
**先决条件**(安装程序检查这些):`git`,`jq`(必需 — 安全钩子在没有它的情况下会失败:`brew install jq` / `apt-get install jq`),`gh`(用于`/ship` + 规则集自动化),以及`claude` CLI([安装](https://code.claude.com))。
### 2. 审查和提交差异
套件落在您的工作树中,但未提交。检查并提交它:
```bash
git status && git diff
git add -A && git commit -m "chore: 采用克劳德初始化套件"
```
### 3. <a id="手动设置"></a>手动设置(安装程序无法完成)
这些需要**您** — 它们涉及到GitHub设置,秘密或您的平台,而本地脚本无法(也不应该)更改:
| # | 步骤 | 操作方法 |
|---|---|---|
| 1 | **在仓库上启用GitHub Actions** | 设置 → Actions → General → Allow。同时确保计费是活跃的,否则CI作业会立即失败。 |
| 2 | **添加CI秘密** | 设置 → Secrets → Actions → `ANTHROPIC_API_KEY`(由`claude-review.yml` / `claude-security.yml`使用)。 |
| 3 | **应用分支保护** | `gh api repos/<owner>/<repo>/rulesets --method POST --input .github/rulesets/main-protection.json` — 使CI门控成为合并的必需条件。 |
| 4 | **设置CODEOWNERS** | 编辑`.github/CODEOWNERS`到您的团队的处理程序(或删除它,如果您不想要代码所有者审查)。 |
| 5 | **连接部署(可选)** | 发布的`canary-deploy.yml`是一个**存根**。按照[docs/DEPLOY-INTEGRATION.md](docs/DEPLOY-INTEGRATION.md)配置您的平台。 |
| 6 | **调整到您的堆栈** | 编辑`.claude/CLAUDE.md`(宪法),`.claude/settings.json`(允许/询问/拒绝),`.mcp.json`(服务器),`.claude/scripts/run.sh`(启动命令)。 |
完整的运营手册:[docs/OPERATOR-MANUAL.md](docs/OPERATOR-MANUAL.md)。引入旧仓库:[docs/ADOPTION.md](docs/ADOPTION.md)(`/adopt start`)。
### 4. 打开克劳德代码并开始
```bash
claude
# 新团队成员?参加交互式游览:
/onboard # 遍历八阶段工作流,并使用具体示例
# 否则,驱动工作流:
/constitution # 设置项目原则(一次)
/specify "添加用户登录,包含电子邮件和密码"
/clarify # 解决开放问题
/plan # 技术计划
/tasks # 分解为原子任务
/analyze # 一致性检查
/implement all # 遍历DAG,严格TDD
/verify # 运行应用程序,锻炼旅程
/review # 代码 + 安全审查
/ship # PR,CI,合并,部署
```
## 为什么存在
没有套件,每个项目的克劳德代码设置都是定制的且容易被遗忘。有了这个黄金仓库,每个采用它的团队都会得到:
- 相同八阶段工作流
- 相同的安全基线
- 相同的可观察性(令牌使用,日志,快照)
- 相同的质量标准(TDD + 验证 + 多次审查)
- 相同的发布管道(claude-code-action + CI门控 + 自动合并)
它以2026年5月的共识最佳实践为模型:github/spec-kit,obra/superpowers,anthropics/claude-plugins-official,anthropics/claude-code-action,chrome-devtools-mcp,playwright-mcp,Anthropic自己的工程博客帖子关于有效的长期代理套件。
参见[docs/RESEARCH.md](docs/RESEARCH.md)以获取完整的参考列表,包含GitHub链接。
## 里面有什么
```
.
├── .claude/
│ ├── CLAUDE.md # 项目宪法(每个会话自动加载)
│ ├── settings.json # 团队共享的权限,钩子,环境变量
│ ├── agents/
│ │ ├── core/ # 建筑师,规划师,实现者,协调员,功能流,路线图建筑师
│ │ ├── quality/ # 测试者,审查者,安全,验证者,防滑审查者
│ │ └── specialists/ # 调试器,研究人员,文档编写者,发布者,设计师,提取者,反馈提取者
│ ├── skills/
│ │ ├── constitution/ # /constitution工作流
│ │ ├── specify/ # /specify工作流
│ │ ├── clarify/ # /clarify工作流
│ │ ├── plan/ # /plan工作流
│ │ ├── tasks/ # /tasks工作流
│ │ ├── analyze/ # /analyze跨工件一致性
│ │ ├── implement/ # /implement(委托给实现者)
│ │ ├── verify/ # /verify(委托给验证者)
│ │ ├── review/ # /review(委托给审查者和安全)
│ │ ├── ship/ # /ship(委托给发布者)
│ │ ├── loop/ # /loop(自主运行)
│ │ ├── debug/ # /debug(委托给调试器)
│ │ ├── research/ # /research(委托给研究人员)
│ │ ├── tdd-loop/ # TDD纪律(红绿重构)
│ │ ├── verification/ # 验证完成前纪律
│ │ ├── browser-e2e/ # 浏览器驱动的E2E纪律
│ │ ├── security-guard/ # OWASP + LLM Top 10检查清单
│ │ ├── token-budget/ # 缓存/委托/压缩纪律
│ │ ├── auto-loop/ # 安全自主循环纪律
│ │ ├── research-grounding/ # 基于证据的决策
│ │ ├── spec-driven/ # 规范→计划→任务方法论
│ │ └── … # 总共58种技能 — ls .claude/skills/
│ ├── hooks/
│ │ ├── pre-bash-guard.sh # 阻止破坏性bash
│ │ ├── pre-write-secret-scan.sh # 扫描写入的秘密(gitleaks)
│ │ ├── post-write-format.sh # 编辑后自动格式化
│ │ ├── post-bash-log.sh # 审计日志每个bash运行
│ │ ├── user-prompt-context.sh # 注入分支/规范/计划上下文
│ │ ├── session-start.sh # 启动时总结
│ │ ├── session-end.sh # 捕获用法
│ │ ├── stop-verify.sh # 提示/验证结束前
│ │ ├── subagent-stop.sh # 日志子代理运行
│ │ ├── pre-compact-witness.sh # 异步见证压缩(mvara-ai模式)
│ │ ├── workflow-state.sh # 每转状态 + 循环检测(ccg-workflow端口)
│ │ ├── session-start-context.sh # 附加启动上下文
│ │ ├── subagent-context.sh # PreToolUse on Agent/Task — 注入规范
│ │ ├── skill-router.sh # 用户提示提交 — 提示覆盖
│ │ ├── auto-dream-check.sh # 停止钩子 — 每24小时触发/dream
│ │ ├── instinct-observer.sh # PostToolUse — 追加到本能日志
│ │ └── … # 总共25个钩子 — ls .claude/hooks/
│ ├── memory/
│ │ ├── MEMORY.md # 决策/模式/事件/剧本索引
│ │ ├── decisions/ # ADR
│ │ ├── patterns/ # 可重用代码模式
│ │ ├── incidents/ # 事后分析
│ │ └── playbooks/ # 新功能,flaky-test,rollback
│ ├── plugins/marketplace.json # 选定的插件市场
│ ├── output-styles/ # 简洁(默认),教学
│ ├── statuslines/ # 预算状态行
│ └── scripts/ # 设置,验证,运行,验证,lint,测试,循环
├── .mcp.json # 固定的MCP服务器
├── .github/
│ ├── workflows/
│ │ ├── claude.yml # @claude提及处理程序
│ │ ├── claude-review.yml # PR代码审查
│ │ ├── claude-security.yml # PR安全审查 + gitleaks + 依赖项
│ │ ├── ci.yml # lint + typecheck + 测试
│ │ ├── e2e-preview.yml # Playwright在预览部署
│ │ ├── auto-merge-dependabot.yml # 自动合并patch/minor
│ │ ├── release-please.yml # Conventional Commits → CHANGELOG
│ │ ├── harness-validate.yml # lint .claude/文件夹本身
│ │ └── … # 总共36个工作流 — ls .github/workflows/
│ ├── rulesets/main-protection.json # 分支保护(规则集)
│ ├── ISSUE_TEMPLATE/ # bug,feature
│ ├── PULL_REQUEST_TEMPLATE.md
│ ├── CODEOWNERS
│ └── dependabot.yml
├── specs/templates/spec.md # 功能规范模板
├── plans/templates/plan.md # 技术计划模板
├── tasks/TASKS.md # 追加任务账本
└── docs/
├── README.md # 本文
├── OPERATOR-MANUAL.md # ⭐ 如何运行工厂(先阅读本文)
├── STARTING-PROMPT.md # 全新产品的第一个提示(/kickoff)
├── ADOPTION.md # 引入现有/旧项目(/adopt)
├── ONBOARDING.md # 15分钟采用指南
├── ARCHITECTURE.md # 各个部分如何组合
├── PLAYBOOK.md # 操作配方
└── RESEARCH.md # 影响每个决策的研究
```