📋 项目概述
MyClaude 是一个基于 双智能体架构 的 AI 开发自动化框架。它将 Claude Code 作为编排器(Orchestrator),Codex 作为执行器(Executor),通过职责分离实现高效的软件开发自动化。
双智能体协作
Claude 负责规划与验证,Codex 负责代码生成与执行,各司其职,发挥各自优势
并行任务执行
支持 2-5 个任务并行开发,大幅提升开发效率,缩短项目周期
强制质量门禁
内置 ≥90% 测试覆盖率要求,确保代码质量,减少线上问题
模块化设计
可选择性安装不同工作流模块,按需配置,灵活扩展
核心价值
- 职责分离:规划与执行解耦,提高系统可靠性
- 自动化流程:从需求到代码的全流程自动化
- 质量保障:内置测试覆盖率检查和代码审查
- 灵活配置:支持多种工作流,适应不同项目需求
- 企业级支持:BMAD 敏捷工作流支持完整的团队协作模式
🏗️ 架构设计
MyClaude 采用双智能体架构,将复杂的开发任务分解为规划和执行两个阶段,由不同的 AI 智能体负责:
- 📝 需求理解与澄清
- 📊 代码库分析
- 📋 任务规划与分解
- ✅ 结果验证与汇总
- 💬 用户交互与沟通
- 💻 代码生成与编辑
- 🧪 测试编写与执行
- 📁 文件操作
- 🔧 重构与优化
- 📖 文档生成
目录结构
myclaude/
├── .claude-plugin/ # Claude 插件配置
├── dev-workflow/ # 核心开发工作流
│ ├── commands/ # 命令定义
│ ├── agents/ # 智能体定义
│ └── README.md
├── bmad-agile-workflow/ # BMAD 敏捷工作流
│ ├── commands/
│ ├── agents/
│ └── .claude-plugin/
├── requirements-driven-workflow/ # 需求驱动工作流
│ ├── commands/
│ ├── agents/
│ └── .claude-plugin/
├── development-essentials/ # 开发常用命令
│ ├── commands/
│ └── agents/
├── skills/ # 技能包
│ ├── codex/ # Codex 集成技能
│ └── gemini/ # Gemini 集成技能
├── config.json # 安装配置
├── config.schema.json # 配置模式定义
├── install.py # Python 安装脚本
├── install.sh # Shell 安装脚本
├── install.bat # Windows 安装脚本
└── README.md # 项目文档
🔄 工作流程详解
1. Dev Workflow(推荐)
核心开发工作流,采用六步流程实现从需求到代码的自动化,是大多数项目的最佳选择。
需求澄清 (Clarify Requirements)
使用 AskUserQuestion 工具进行交互式问答,确保完全理解用户需求
代码库分析 (Codex Analysis)
分析现有代码库,提取核心功能模块,创建任务分解方案
生成开发文档 (Generate Dev Doc)
生成单一的 dev-plan.md 文件,包含完整的开发计划
并行开发 (Concurrent Development)
根据依赖关系,同时执行 2-5 个独立任务,最大化开发效率
测试验证 (Testing & Verification)
强制执行 ≥90% 代码覆盖率要求,确保代码质量
完成汇总 (Complete)
汇总所有任务结果,生成完成报告,交付最终成果
在 Claude Code 中输入:/dev "实现用户登录功能,支持邮箱和密码验证"
2. BMAD Agile Workflow(企业级)
企业级敏捷开发工作流,通过六个专业智能体协作,模拟完整的敏捷团队协作模式。
| 智能体 | 角色 | 职责 |
|---|---|---|
| PO | 产品负责人 | 需求收集、优先级排序、用户故事编写 |
| Architect | 架构师 | 系统设计、技术选型、架构决策 |
| Tech Lead | 技术负责人 | Sprint 规划、任务分配、技术指导 |
| Developer | 开发者 | 代码实现、单元测试、功能开发 |
| Reviewer | 代码审查员 | 代码审查、质量把控、最佳实践建议 |
| QA | 质量工程师 | 测试策略、验收测试、质量报告 |
3. Requirements-Driven Workflow(轻量级)
轻量级的需求驱动工作流,适合快速原型开发和小型功能迭代。
- 直接从需求文档生成代码
- 自动生成质量评分的规格说明
- 快速迭代,减少中间环节
工作流选择指南
| 场景 | 推荐工作流 | 原因 |
|---|---|---|
| 日常功能开发 | Dev Workflow | 平衡效率与质量,六步流程清晰明确 |
| 大型项目/团队协作 | BMAD Agile | 完整的角色分工,模拟真实团队 |
| 快速原型/小功能 | Requirements-Driven | 流程简单,快速交付 |
| 单一任务(调试/重构) | Development Essentials | 直接命令,无工作流开销 |
⌨️ 常用命令
Development Essentials 模块提供了一系列开箱即用的开发命令,无需启动完整工作流即可执行常见任务。
功能实现,完整的开发流程
系统性问题排查与修复
全面的测试策略设计
多维度代码质量评估
性能瓶颈识别与优化
代码结构改进与重构
自动化文档生成
架构咨询(不生成代码)
快速 Bug 定位与修复
深度分析与问题解决
指令优化与澄清
命令使用示例
# 实现新功能
/code 添加用户注册功能,包含邮箱验证
# 调试问题
/debug 用户登录时偶尔出现 500 错误
# 编写测试
/test 为 UserService 类编写单元测试
# 代码审查
/review src/services/payment.ts
# 性能优化
/optimize 数据库查询在高并发下响应变慢
# 代码重构
/refactor 将 monolithic 模块拆分为微服务架构
# 生成文档
/docs 为 API 接口生成 OpenAPI 规范文档
📦 安装指南
环境要求
- Python:3.8 或更高版本
- Git:用于克隆仓库
- Claude Code:已安装并配置好的 Claude Code CLI
- Codex CLI(可选):如需使用 Codex 执行功能
方式一:自动安装(推荐)
Linux / macOS
# 1. 克隆仓库
git clone https://github.com/cexll/myclaude.git
# 2. 进入目录
cd myclaude
# 3. 运行 Python 安装脚本
python3 install.py --install-dir ~/.claude
Windows (PowerShell)
# 1. 克隆仓库
git clone https://github.com/cexll/myclaude.git
# 2. 进入目录
cd myclaude
# 3. 运行安装脚本
python install.py --install-dir $env:USERPROFILE\.claude
安装选项
| 参数 | 说明 | 示例 |
|---|---|---|
--install-dir |
指定安装目录 | --install-dir ~/.claude |
--module |
安装指定模块 | --module bmad |
--list-modules |
列出所有可用模块 | --list-modules |
--force |
强制覆盖现有文件 | --force |
--config |
指定配置文件 | --config custom.json |
模块说明
| 模块 | 默认状态 | 说明 |
|---|---|---|
dev |
✅ 启用 | 核心开发工作流 + Codex 集成 |
essentials |
✅ 启用 | 常用开发命令集 |
bmad |
❌ 禁用 | BMAD 敏捷工作流 |
requirements |
❌ 禁用 | 需求驱动工作流 |
安装额外模块
# 安装 BMAD 敏捷工作流
python3 install.py --module bmad
# 安装需求驱动工作流
python3 install.py --module requirements
# 查看所有可用模块
python3 install.py --list-modules
安装前请备份现有的 ~/.claude/ 配置。安装日志会保存在 install.log 文件中。
验证安装
# 启动 Claude Code
claude
# 查看可用命令
/help
# 测试 dev 工作流
/dev "创建一个简单的 Hello World 程序"
⚙️ 配置说明
安装后的目录结构
~/.claude/
├── commands/ # 斜杠命令定义
│ ├── dev.md # /dev 命令
│ ├── code.md # /code 命令
│ ├── debug.md # /debug 命令
│ ├── test.md # /test 命令
│ ├── review.md # /review 命令
│ └── ...
├── agents/ # 智能体定义
│ ├── develop-doc-generator.md
│ └── ...
├── skills/ # 技能包
│ ├── codex/
│ │ └── SKILL.md
│ └── gemini/
│ └── SKILL.md
├── specs/ # 生成的规格文档
│ └── {feature_name}/
│ └── dev-plan.md
└── installed_modules.json # 已安装模块记录
config.json 配置文件
{
"version": "1.0",
"install_dir": "~/.claude",
"log_file": "install.log",
"modules": {
"dev": {
"enabled": true,
"operations": [
{"type": "merge_dir", "source": "dev-workflow/commands", "target": "commands"},
{"type": "merge_dir", "source": "dev-workflow/agents", "target": "agents"},
{"type": "merge_dir", "source": "skills/codex", "target": "skills/codex"}
]
},
"essentials": {
"enabled": true,
"operations": [
{"type": "merge_dir", "source": "development-essentials/commands", "target": "commands"}
]
},
"bmad": {
"enabled": false,
"operations": [...]
},
"requirements": {
"enabled": false,
"operations": [...]
}
}
}
自定义命令
你可以在 ~/.claude/commands/ 目录下创建自定义命令:
# ~/.claude/commands/my-command.md
---
description: "我的自定义命令"
---
# 自定义命令模板
当用户调用 /my-command 时,执行以下操作:
1. 分析用户输入
2. 执行特定任务
3. 返回结果
📚 完整案例:开发 RESTful API
以下是一个完整的案例,展示如何使用 MyClaude 的 Dev Workflow 开发一个用户管理 API。
使用 Go + Gin 框架开发一个用户管理 RESTful API,包含以下功能:
- 用户注册(POST /users)
- 用户登录(POST /login)
- 获取用户信息(GET /users/:id)
- 更新用户信息(PUT /users/:id)
- JWT 认证
步骤 1:启动 Dev Workflow
# 在 Claude Code 中输入
/dev "使用 Go + Gin 框架开发用户管理 RESTful API,
包含注册、登录、获取用户信息、更新用户功能,
使用 JWT 进行身份认证,PostgreSQL 存储数据"
步骤 2:需求澄清(自动执行)
Claude 会使用 AskUserQuestion 工具询问关键问题:
Claude:关于用户管理 API,我需要确认以下几点:
- 用户注册需要哪些字段?(如:用户名、邮箱、密码、手机号)
- JWT token 的有效期设为多长时间?
- 是否需要实现 refresh token 机制?
- 密码加密使用什么算法?(推荐 bcrypt)
用户:注册需要用户名、邮箱、密码;token 有效期 24 小时;需要 refresh token;使用 bcrypt
步骤 3:代码库分析(Codex 执行)
系统自动分析项目结构,生成任务分解方案:
# 任务分解结果
Task 1: 项目初始化与依赖配置
Task 2: 数据库模型与迁移
Task 3: 用户注册接口实现
Task 4: 用户登录与 JWT 实现
Task 5: 用户信息 CRUD 接口
Task 6: 中间件与错误处理
步骤 4:生成开发文档
系统在 .claude/specs/user-api/dev-plan.md 生成详细计划:
# User API 开发计划
## 概述
开发一个基于 Go + Gin 的用户管理 RESTful API
## 技术栈
- Go 1.21+
- Gin Web Framework
- GORM (PostgreSQL)
- JWT-Go
- Bcrypt
## API 端点
| Method | Path | Description |
|--------|------|-------------|
| POST | /api/v1/register | 用户注册 |
| POST | /api/v1/login | 用户登录 |
| POST | /api/v1/refresh | 刷新 Token |
| GET | /api/v1/users/:id | 获取用户信息 |
| PUT | /api/v1/users/:id | 更新用户信息 |
## 目录结构
```
user-api/
├── cmd/
│ └── main.go
├── internal/
│ ├── config/
│ ├── handler/
│ ├── middleware/
│ ├── model/
│ ├── repository/
│ └── service/
├── pkg/
│ └── jwt/
├── go.mod
└── docker-compose.yml
```
## 任务依赖
- Task 2 依赖 Task 1
- Task 3, 4 可并行执行
- Task 5 依赖 Task 4
- Task 6 可与 Task 3-5 并行
步骤 5:并行开发执行
Codex 开始并行执行独立任务:
同时执行 Task 1(项目初始化)、Task 6(中间件)...
完成后自动进入 Task 2 → Task 3, 4(并行)→ Task 5
生成的核心代码示例
// internal/handler/user.go
package handler
import (
"net/http"
"github.com/gin-gonic/gin"
"user-api/internal/service"
)
type UserHandler struct {
userService *service.UserService
}
func NewUserHandler(us *service.UserService) *UserHandler {
return &UserHandler{userService: us}
}
func (h *UserHandler) Register(c *gin.Context) {
var req RegisterRequest
if err := c.ShouldBindJSON(&req); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
user, err := h.userService.Register(c.Request.Context(), req.Username, req.Email, req.Password)
if err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
return
}
c.JSON(http.StatusCreated, gin.H{"user": user})
}
func (h *UserHandler) Login(c *gin.Context) {
var req LoginRequest
if err := c.ShouldBindJSON(&req); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
tokens, err := h.userService.Login(c.Request.Context(), req.Email, req.Password)
if err != nil {
c.JSON(http.StatusUnauthorized, gin.H{"error": "invalid credentials"})
return
}
c.JSON(http.StatusOK, tokens)
}
步骤 6:测试验证
系统强制执行 ≥90% 测试覆盖率检查:
# 自动生成的测试文件: internal/handler/user_test.go
func TestUserHandler_Register(t *testing.T) {
tests := []struct {
name string
body RegisterRequest
wantStatus int
}{
{
name: "valid registration",
body: RegisterRequest{Username: "test", Email: "test@example.com", Password: "password123"},
wantStatus: http.StatusCreated,
},
{
name: "invalid email",
body: RegisterRequest{Username: "test", Email: "invalid", Password: "password123"},
wantStatus: http.StatusBadRequest,
},
// 更多测试用例...
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// 测试实现...
})
}
}
# 测试覆盖率报告
=== Coverage Report ===
handler/user.go: 92.3%
service/user.go: 94.1%
repository/user.go: 91.5%
middleware/auth.go: 95.0%
-----------------------
Total Coverage: 93.2% ✅ (≥90% requirement met)
步骤 7:完成汇总
完成摘要:
- ✅ 项目结构初始化完成
- ✅ 数据库模型与迁移完成
- ✅ 用户注册/登录 API 实现完成
- ✅ JWT 认证中间件完成
- ✅ 用户 CRUD 接口完成
- ✅ 测试覆盖率 93.2%(达标)
输出文件: 12 个文件,共 1,847 行代码
运行项目
# 启动 PostgreSQL
docker-compose up -d postgres
# 运行迁移
go run cmd/migrate/main.go
# 启动服务
go run cmd/main.go
# 测试 API
curl -X POST http://localhost:8080/api/v1/register \
-H "Content-Type: application/json" \
-d '{"username":"john","email":"john@example.com","password":"secret123"}'
❓ 常见问题
Q1: 如何在 Dev Workflow 和 BMAD 之间选择?
Dev Workflow 适合大多数日常开发任务,流程简洁,执行效率高。BMAD Agile 适合需要完整规划、多角色协作的大型项目,或者需要生成详细文档和设计决策记录的场景。
Q2: 测试覆盖率要求能否调整?
默认要求 ≥90%,这是为了确保代码质量。如果项目有特殊需求,可以修改 ~/.claude/commands/dev.md 中的覆盖率阈值配置。
Q3: Codex 集成是必须的吗?
不是必须的。如果没有安装 Codex CLI,系统会回退到使用 Claude 直接执行代码任务。但 Codex 在代码生成和执行方面的效率更高,推荐配合使用。
Q4: 如何添加自定义智能体?
在 ~/.claude/agents/ 目录下创建 Markdown 文件,定义智能体的角色、能力和行为规范。参考现有智能体的格式即可。
Q5: 支持哪些编程语言?
MyClaude 是语言无关的框架,支持 Claude 和 Codex 能处理的所有编程语言。项目本身主要使用 Go 和 Python 编写,但可以用于任何语言的项目开发。
Q6: 如何更新到最新版本?
# 进入项目目录
cd myclaude
# 拉取最新代码
git pull origin master
# 重新安装(使用 --force 覆盖)
python3 install.py --install-dir ~/.claude --force
Q7: 生成的开发计划保存在哪里?
所有生成的规格文档和开发计划保存在 ~/.claude/specs/{feature_name}/ 目录下,方便后续查阅和追溯。