cexll/myclaude
1
0
Fork 0
mirror of https://github.com/cexll/myclaude.git synced 2026-02-13 03:31:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: rewrite documentation for v5.0 modular architecture

Browse Source 
完全重写 README 以反映新的模块化架构:

核心变更:
- 版本号升级至 5.0
- 聚焦 Claude Code + Codex 双智能体协作概念
- 重组工作流说明(Dev/BMAD/Requirements/Essentials)
- 新增模块化安装详细指南
- 移除过时的插件系统引用
- 添加工作流选择决策树
- 更新故障排查章节

文档结构:
1. 核心概念 - 双智能体架构
2. 快速开始 - python3 install.py
3. 工作流对比 - 适用场景清晰化
4. 安装配置 - config.json 操作类型
5. Codex 集成 - wrapper 使用和并行执行
6. 故障排查 - 常见问题解决方案

中英文文档同步更新。

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
cexll
2025-12-05 10:27:21 +08:00
parent 2b8efd42a9
commit c89ad3df2d
2 changed files with 538 additions and 202 deletions
Download Patch File Download Diff File Expand all files Collapse all files

373
README.md
View File

@@ -2,127 +2,292 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Claude Code](https://img.shields.io/badge/Claude-Code-blue)](https://claude.ai/code)
[![Version](https://img.shields.io/badge/Version-4.4-green)](https://github.com/cexll/myclaude)
[![Plugin Ready](https://img.shields.io/badge/Plugin-Ready-purple)](https://docs.claude.com/en/docs/claude-code/plugins)
[![Version](https://img.shields.io/badge/Version-5.0-green)](https://github.com/cexll/myclaude)
> Enterprise-grade agile development automation with AI-powered multi-agent orchestration
> AI-powered development automation with Claude Code + Codex collaboration
[中文文档](README_CN.md) | [Documentation](docs/)
## Core Concept: Claude Code + Codex
## 🚀 Quick Start
This system leverages a **dual-agent architecture**:
### Installation
| Role | Agent | Responsibility |
|------|-------|----------------|
| **Orchestrator** | Claude Code | Planning, context gathering, verification, user interaction |
| **Executor** | Codex | Code editing, test execution, file operations |
**Plugin System (Recommended)**
```bash
/plugin marketplace add cexll/myclaude
```
**Why this separation?**
- Claude Code excels at understanding context and orchestrating complex workflows
- Codex excels at focused code generation and execution
- Together they provide better results than either alone
## Quick Start
**Traditional Installation**
```bash
git clone https://github.com/cexll/myclaude.git
cd myclaude
make install
python3 install.py --install-dir ~/.claude
```
### Basic Usage
## Workflows Overview
### 1. Dev Workflow (Recommended)
**The primary workflow for most development tasks.**
```bash
# Full agile workflow
/bmad-pilot "Build user authentication with OAuth2 and MFA"
# Lightweight development
/requirements-pilot "Implement JWT token refresh"
# Direct development commands
/code "Add API rate limiting"
/dev "implement user authentication with JWT"
```
## 📦 Plugin Modules
**6-Step Process:**
1. **Requirements Clarification** - Interactive Q&A to clarify scope
2. **Codex Deep Analysis** - Codebase exploration and architecture decisions
3. **Dev Plan Generation** - Structured task breakdown with test requirements
4. **Parallel Execution** - Codex executes tasks concurrently
5. **Coverage Validation** - Enforce ≥90% test coverage
6. **Completion Summary** - Report with file changes and coverage stats
| Plugin | Description | Key Commands |
|--------|-------------|--------------|
| **[bmad-agile-workflow](docs/BMAD-WORKFLOW.md)** | Complete BMAD methodology with 6 specialized agents | `/bmad-pilot` |
| **[requirements-driven-workflow](docs/REQUIREMENTS-WORKFLOW.md)** | Streamlined requirements-to-code workflow | `/requirements-pilot` |
| **[dev-workflow](dev-workflow/README.md)** | Extreme lightweight end-to-end development workflow | `/dev` |
| **[codex-wrapper](codex-wrapper/)** | Go binary wrapper for Codex CLI integration | `codex-wrapper` |
| **[development-essentials](docs/DEVELOPMENT-COMMANDS.md)** | Core development slash commands | `/code` `/debug` `/test` `/optimize` |
| **[advanced-ai-agents](docs/ADVANCED-AGENTS.md)** | GPT-5 deep reasoning integration | Agent: `gpt5` |
| **[requirements-clarity](docs/REQUIREMENTS-CLARITY.md)** | Automated requirements clarification with 100-point scoring | Auto-activated skill |
**Key Features:**
- Claude Code orchestrates, Codex executes all code changes
- Automatic task parallelization for speed
- Mandatory 90% test coverage gate
- Rollback on failure
## 💡 Use Cases
**BMAD Workflow** - Full agile process automation
- Product requirements → Architecture design → Sprint planning → Development → Code review → QA testing
- Quality gates with 90% thresholds
- Automated document generation
**Requirements Workflow** - Fast prototyping
- Requirements generation → Implementation → Review → Testing
- Lightweight and practical
**Development Commands** - Daily coding
- Direct implementation, debugging, testing, optimization
- No workflow overhead
**Requirements Clarity** - Automated requirements engineering
- Auto-detects vague requirements and initiates clarification
- 100-point quality scoring system
- Generates complete PRD documents
## 🎯 Key Features
- **🤖 Role-Based Agents**: Specialized AI agents for each development phase
- **📊 Quality Gates**: Automatic quality scoring with iterative refinement
- **✅ Approval Points**: User confirmation at critical workflow stages
- **📁 Persistent Artifacts**: All specs saved to `.claude/specs/`
- **🔌 Plugin System**: Native Claude Code plugin support
- **🔄 Flexible Workflows**: Choose full agile or lightweight development
- **🎯 Requirements Clarity**: Automated requirements clarification with quality scoring
## 📚 Documentation
- **[BMAD Workflow Guide](docs/BMAD-WORKFLOW.md)** - Complete methodology and agent roles
- **[Requirements Workflow](docs/REQUIREMENTS-WORKFLOW.md)** - Lightweight development process
- **[Development Commands](docs/DEVELOPMENT-COMMANDS.md)** - Slash command reference
- **[Plugin System](docs/PLUGIN-SYSTEM.md)** - Installation and configuration
- **[Quick Start Guide](docs/QUICK-START.md)** - Get started in 5 minutes
## 🛠️ Installation Methods
**Codex Wrapper** (Go binary for Codex CLI)
```bash
curl -fsSL https://raw.githubusercontent.com/cexll/myclaude/refs/heads/master/install.sh | bash
```
**Method 1: Plugin Install** (One command)
```bash
/plugin install bmad-agile-workflow
```
**Method 2: Make Commands** (Selective installation)
```bash
make deploy-bmad # BMAD workflow only
make deploy-requirements # Requirements workflow only
make deploy-all # Everything
```
**Method 3: Manual Setup**
- Copy `./commands/*.md` to `~/.config/claude/commands/`
- Copy `./agents/*.md` to `~/.config/claude/agents/`
Run `make help` for all options.
## 📄 License
MIT License - see [LICENSE](LICENSE)
## 🙋 Support
- **Issues**: [GitHub Issues](https://github.com/cexll/myclaude/issues)
- **Documentation**: [docs/](docs/)
- **Plugin Guide**: [PLUGIN_README.md](PLUGIN_README.md)
**Best For:** Feature development, refactoring, bug fixes with tests
---
**Transform your development with AI-powered automation** - One command, complete workflow, quality assured.
### 2. BMAD Agile Workflow
**Full enterprise agile methodology with 6 specialized agents.**
```bash
/bmad-pilot "build e-commerce checkout system"
```
**Agents:**
| Agent | Role |
|-------|------|
| Product Owner | Requirements & user stories |
| Architect | System design & tech decisions |
| Tech Lead | Sprint planning & task breakdown |
| Developer | Implementation |
| Code Reviewer | Quality assurance |
| QA Engineer | Testing & validation |
**Process:**
```
Requirements → Architecture → Sprint Plan → Development → Review → QA
↓ ↓ ↓ ↓ ↓ ↓
PRD.md DESIGN.md SPRINT.md Code REVIEW.md TEST.md
```
**Best For:** Large features, team coordination, enterprise projects
---
### 3. Requirements-Driven Workflow
**Lightweight requirements-to-code pipeline.**
```bash
/requirements-pilot "implement API rate limiting"
```
**Process:**
1. Requirements generation with quality scoring
2. Implementation planning
3. Code generation
4. Review and testing
**Best For:** Quick prototypes, well-defined features
---
### 4. Development Essentials
**Direct commands for daily coding tasks.**
| Command | Purpose |
|---------|---------|
| `/code` | Implement a feature |
| `/debug` | Debug an issue |
| `/test` | Write tests |
| `/review` | Code review |
| `/optimize` | Performance optimization |
| `/refactor` | Code refactoring |
| `/docs` | Documentation |
**Best For:** Quick tasks, no workflow overhead needed
---
## Installation
### Modular Installation (Recommended)
```bash
# Install all enabled modules (dev + essentials by default)
python3 install.py --install-dir ~/.claude
# Install specific module
python3 install.py --module dev
# List available modules
python3 install.py --list-modules
# Force overwrite existing files
python3 install.py --force
```
### Available Modules
| Module | Default | Description |
|--------|---------|-------------|
| `dev` | ✓ Enabled | Dev workflow + Codex integration |
| `essentials` | ✓ Enabled | Core development commands |
| `bmad` | Disabled | Full BMAD agile workflow |
| `requirements` | Disabled | Requirements-driven workflow |
### What Gets Installed
```
~/.claude/
├── CLAUDE.md # Core instructions and role definition
├── commands/ # Slash commands (/dev, /code, etc.)
├── agents/ # Agent definitions
├── skills/
│ └── codex/
│ └── SKILL.md # Codex integration skill
└── installed_modules.json # Installation status
```
### Configuration
Edit `config.json` to customize:
```json
{
"version": "1.0",
"install_dir": "~/.claude",
"modules": {
"dev": {
"enabled": true,
"operations": [
{"type": "merge_dir", "source": "dev-workflow"},
{"type": "copy_file", "source": "memorys/CLAUDE.md", "target": "CLAUDE.md"},
{"type": "copy_file", "source": "skills/codex/SKILL.md", "target": "skills/codex/SKILL.md"},
{"type": "run_command", "command": "bash install.sh"}
]
}
}
}
```
**Operation Types:**
| Type | Description |
|------|-------------|
| `merge_dir` | Merge subdirs (commands/, agents/) into install dir |
| `copy_dir` | Copy entire directory |
| `copy_file` | Copy single file to target path |
| `run_command` | Execute shell command |
---
## Codex Integration
The `codex` skill enables Claude Code to delegate code execution to Codex CLI.
### Usage in Workflows
```bash
# Codex is invoked via the skill
codex-wrapper - <<'EOF'
implement @src/auth.ts with JWT validation
EOF
```
### Parallel Execution
```bash
codex-wrapper --parallel <<'EOF'
---TASK---
id: backend_api
workdir: /project/backend
---CONTENT---
implement REST endpoints for /api/users
---TASK---
id: frontend_ui
workdir: /project/frontend
dependencies: backend_api
---CONTENT---
create React components consuming the API
EOF
```
### Install Codex Wrapper
```bash
# Automatic (via dev module)
python3 install.py --module dev
# Manual
bash install.sh
```
---
## Workflow Selection Guide
| Scenario | Recommended Workflow |
|----------|---------------------|
| New feature with tests | `/dev` |
| Quick bug fix | `/debug` or `/code` |
| Large multi-sprint feature | `/bmad-pilot` |
| Prototype or POC | `/requirements-pilot` |
| Code review | `/review` |
| Performance issue | `/optimize` |
---
## Troubleshooting
### Common Issues
**Codex wrapper not found:**
```bash
# Check PATH
echo $PATH | grep -q "$HOME/bin" || echo 'export PATH="$HOME/bin:$PATH"' >> ~/.zshrc
# Reinstall
bash install.sh
```
**Permission denied:**
```bash
python3 install.py --install-dir ~/.claude --force
```
**Module not loading:**
```bash
# Check installation status
cat ~/.claude/installed_modules.json
# Reinstall specific module
python3 install.py --module dev --force
```
---
## License
MIT License - see [LICENSE](LICENSE)
## Support
- **Issues**: [GitHub Issues](https://github.com/cexll/myclaude/issues)
- **Documentation**: [docs/](docs/)
---
**Claude Code + Codex = Better Development** - Orchestration meets execution.