diff --git a/README.md b/README.md index 96c459d..a8b4d6e 100644 --- a/README.md +++ b/README.md @@ -3,29 +3,13 @@ # Claude Code Multi-Agent Workflow System [![Run in Smithery](https://smithery.ai/badge/skills/cexll)](https://smithery.ai/skills?ns=cexll&utm_source=github&utm_medium=badge) - - [![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0) [![Claude Code](https://img.shields.io/badge/Claude-Code-blue)](https://claude.ai/code) -[![Version](https://img.shields.io/badge/Version-5.6-green)](https://github.com/cexll/myclaude) +[![Version](https://img.shields.io/badge/Version-6.x-green)](https://github.com/cexll/myclaude) -> AI-powered development automation with multi-backend execution (Codex/Claude/Gemini) +> AI-powered development automation with multi-backend execution (Codex/Claude/Gemini/OpenCode) -## Core Concept: Multi-Backend Architecture - -This system leverages a **dual-agent architecture** with pluggable AI backends: - -| Role | Agent | Responsibility | -|------|-------|----------------| -| **Orchestrator** | Claude Code | Planning, context gathering, verification, user interaction | -| **Executor** | codeagent-wrapper | Code editing, test execution (Codex/Claude/Gemini backends) | - -**Why this separation?** -- Claude Code excels at understanding context and orchestrating complex workflows -- Specialized backends (Codex for code, Claude for reasoning, Gemini for prototyping) excel at focused execution -- Backend selection via `--backend codex|claude|gemini` matches the model to the task - -## Quick Start(Please execute in Powershell on Windows) +## Quick Start ```bash git clone https://github.com/cexll/myclaude.git @@ -33,199 +17,23 @@ cd myclaude python3 install.py --install-dir ~/.claude ``` -## Workflows Overview +## Modules Overview -### 0. OmO Multi-Agent Orchestrator (Recommended for Complex Tasks) - -**Intelligent multi-agent orchestration that routes tasks to specialized agents based on risk signals.** - -```bash -/omo "analyze and fix this authentication bug" -``` - -**Agent Hierarchy:** -| Agent | Role | Backend | Model | -|-------|------|---------|-------| -| `oracle` | Technical advisor | Claude | claude-opus-4-5 | -| `librarian` | External research | Claude | claude-sonnet-4-5 | -| `explore` | Codebase search | OpenCode | grok-code | -| `develop` | Code implementation | Codex | gpt-5.2 | -| `frontend-ui-ux-engineer` | UI/UX specialist | Gemini | gemini-3-pro | -| `document-writer` | Documentation | Gemini | gemini-3-flash | - -**Routing Signals (Not Fixed Pipeline):** -- Code location unclear → `explore` -- External library/API → `librarian` -- Risky/multi-file change → `oracle` -- Implementation needed → `develop` / `frontend-ui-ux-engineer` - -**Common Recipes:** -- Explain code: `explore` -- Small fix with known location: `develop` directly -- Bug fix, location unknown: `explore → develop` -- Cross-cutting refactor: `explore → oracle → develop` -- External API integration: `explore + librarian → oracle → develop` - -**Best For:** Complex bug investigation, multi-file refactoring, architecture decisions - ---- - -### 1. Dev Workflow (Recommended) - -**The primary workflow for most development tasks.** - -```bash -/dev "implement user authentication with JWT" -``` - -**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 - -**Key Features:** -- Claude Code orchestrates, Codex executes all code changes -- Automatic task parallelization for speed -- Mandatory 90% test coverage gate -- Rollback on failure - -**Best For:** Feature development, refactoring, bug fixes with tests - ---- - -### 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 - -## Enterprise Workflow Features - -- **Multi-backend execution:** `codeagent-wrapper --backend codex|claude|gemini` (default `codex`) so you can match the model to the task without changing workflows. -- **GitHub workflow commands:** `/gh-create-issue "short need"` creates structured issues; `/gh-issue-implement 123` pulls issue #123, drives development, and prepares the PR. -- **Skills + hooks activation:** .claude/hooks run automation (tests, reviews), while `.claude/skills/skill-rules.json` auto-suggests the right skills. Keep hooks enabled in `.claude/settings.json` to activate the enterprise workflow helpers. - ---- - -## Version Requirements - -### Codex CLI -**Minimum version:** Check compatibility with your installation - -The codeagent-wrapper uses these Codex CLI features: -- `codex e` - Execute commands (shorthand for `codex exec`) -- `--skip-git-repo-check` - Skip git repository validation -- `--json` - JSON stream output format -- `-C ` - Set working directory -- `resume ` - Resume previous sessions - -**Verify Codex CLI is installed:** -```bash -which codex -codex --version -``` - -### Claude CLI -**Minimum version:** Check compatibility with your installation - -Required features: -- `--output-format stream-json` - Streaming JSON output format -- `--setting-sources` - Control setting sources (prevents infinite recursion) -- `--dangerously-skip-permissions` - Skip permission prompts (use with caution) -- `-p` - Prompt input flag -- `-r ` - Resume sessions - -**Security Note:** The wrapper adds `--dangerously-skip-permissions` for Claude by default. Set `CODEAGENT_SKIP_PERMISSIONS=false` to disable if you need permission prompts. - -**Verify Claude CLI is installed:** -```bash -which claude -claude --version -``` - -### Gemini CLI -**Minimum version:** Check compatibility with your installation - -Required features: -- `-o stream-json` - JSON stream output format -- `-y` - Auto-approve prompts (non-interactive mode) -- `-r ` - Resume sessions -- `-p` - Prompt input flag - -**Verify Gemini CLI is installed:** -```bash -which gemini -gemini --version -``` - ---- +| Module | Description | Documentation | +|--------|-------------|---------------| +| [do](skills/do/README.md) | **Recommended** - 7-phase feature development with codeagent orchestration | `/do` command | +| [dev](dev-workflow/README.md) | Lightweight dev workflow with Codex integration | `/dev` command | +| [omo](skills/omo/README.md) | Multi-agent orchestration with intelligent routing | `/omo` command | +| [bmad](bmad-agile-workflow/README.md) | BMAD agile workflow with 6 specialized agents | `/bmad-pilot` command | +| [requirements](requirements-driven-workflow/README.md) | Lightweight requirements-to-code pipeline | `/requirements-pilot` command | +| [essentials](development-essentials/README.md) | Core development commands and utilities | `/code`, `/debug`, etc. | +| [sparv](skills/sparv/README.md) | SPARV workflow (Specify→Plan→Act→Review→Vault) | `/sparv` command | +| course | Course development (combines dev + product-requirements + test-cases) | Composite module | ## Installation -### Modular Installation (Recommended) - ```bash -# Install all enabled modules (dev + essentials by default) +# Install all enabled modules python3 install.py --install-dir ~/.claude # Install specific module @@ -234,173 +42,72 @@ python3 install.py --module dev # List available modules python3 install.py --list-modules -# Force overwrite existing files +# Force overwrite python3 install.py --force ``` -### Available Modules +### Module Configuration -| 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/ -├── bin/ -│ └── codeagent-wrapper # Main executable -├── CLAUDE.md # Core instructions and role definition -├── commands/ # Slash commands (/dev, /code, etc.) -├── agents/ # Agent definitions -├── skills/ -│ └── codex/ -│ └── SKILL.md # Codex integration skill -├── config.json # Configuration -└── installed_modules.json # Installation status -``` - -### Customizing Installation Directory - -By default, myclaude installs to `~/.claude`. You can customize this using the `INSTALL_DIR` environment variable: - -```bash -# Install to custom directory -INSTALL_DIR=/opt/myclaude bash install.sh - -# Update your PATH accordingly -export PATH="/opt/myclaude/bin:$PATH" -``` - -**Directory Structure:** -- `$INSTALL_DIR/bin/` - codeagent-wrapper binary -- `$INSTALL_DIR/skills/` - Skill definitions -- `$INSTALL_DIR/config.json` - Configuration file -- `$INSTALL_DIR/commands/` - Slash command definitions -- `$INSTALL_DIR/agents/` - Agent definitions - -**Note:** When using a custom installation directory, ensure that `$INSTALL_DIR/bin` is added to your `PATH` environment variable. - -### Configuration - -Edit `config.json` to customize: +Edit `config.json` to enable/disable modules: ```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"} - ] - } + "dev": { "enabled": true }, + "bmad": { "enabled": false }, + "requirements": { "enabled": false }, + "essentials": { "enabled": false }, + "omo": { "enabled": false }, + "sparv": { "enabled": false }, + "do": { "enabled": false }, + "course": { "enabled": false } } } ``` -**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 -codeagent-wrapper - <<'EOF' -implement @src/auth.ts with JWT validation -EOF -``` - -### Parallel Execution - -```bash -codeagent-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 -``` - -#### Windows - -Windows installs place `codeagent-wrapper.exe` in `%USERPROFILE%\bin`. - -```powershell -# PowerShell (recommended) -powershell -ExecutionPolicy Bypass -File install.ps1 - -# Batch (cmd) -install.bat -``` - -**Add to PATH** (if installer doesn't detect it): - -```powershell -# PowerShell - persistent for current user -[Environment]::SetEnvironmentVariable('PATH', "$HOME\bin;" + [Environment]::GetEnvironmentVariable('PATH','User'), 'User') - -# PowerShell - current session only -$Env:PATH = "$HOME\bin;$Env:PATH" -``` - -```batch -REM cmd.exe - persistent for current user (use PowerShell method above instead) -REM WARNING: This expands %PATH% which includes system PATH, causing duplication -REM Note: Using reg add instead of setx to avoid 1024-character truncation limit -reg add "HKCU\Environment" /v Path /t REG_EXPAND_SZ /d "%USERPROFILE%\bin;%PATH%" /f -``` - ---- - ## 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` | +| Scenario | Recommended | +|----------|-------------| +| Feature development (default) | `/do` | +| Lightweight feature | `/dev` | +| Bug investigation + fix | `/omo` | +| Large enterprise project | `/bmad-pilot` | +| Quick prototype | `/requirements-pilot` | +| Simple task | `/code`, `/debug` | ---- +## Core Architecture + +| Role | Agent | Responsibility | +|------|-------|----------------| +| **Orchestrator** | Claude Code | Planning, context gathering, verification | +| **Executor** | codeagent-wrapper | Code editing, test execution (Codex/Claude/Gemini/OpenCode) | + +## Backend CLI Requirements + +| Backend | Required Features | +|---------|-------------------| +| Codex | `codex e`, `--json`, `-C`, `resume` | +| Claude | `--output-format stream-json`, `-r` | +| Gemini | `-o stream-json`, `-y`, `-r` | + +## Directory Structure After Installation + +``` +~/.claude/ +├── bin/codeagent-wrapper +├── CLAUDE.md +├── commands/ +├── agents/ +├── skills/ +└── config.json +``` + +## Documentation + +- [Codeagent-Wrapper Guide](docs/CODEAGENT-WRAPPER.md) +- [Hooks Documentation](docs/HOOKS.md) +- [codeagent-wrapper](codeagent-wrapper/README.md) ## Troubleshooting @@ -408,214 +115,38 @@ reg add "HKCU\Environment" /v Path /t REG_EXPAND_SZ /d "%USERPROFILE%\bin;%PATH% **Codex wrapper not found:** ```bash -# Installer auto-adds PATH, check if configured -if [[ ":$PATH:" != *":$HOME/.claude/bin:"* ]]; then - echo "PATH not configured. Reinstalling..." - bash install.sh -fi - -# Or manually add (idempotent command) -[[ ":$PATH:" != *":$HOME/.claude/bin:"* ]] && echo 'export PATH="$HOME/.claude/bin:$PATH"' >> ~/.zshrc -``` - -**Permission denied:** -```bash -python3 install.py --install-dir ~/.claude --force +bash install.sh ``` **Module not loading:** ```bash -# Check installation status cat ~/.claude/installed_modules.json - -# Reinstall specific module -python3 install.py --module dev --force +python3 install.py --module --force ``` -### Version Compatibility Issues - -**Backend CLI not found:** +**Backend CLI errors:** ```bash -# Check if backend CLIs are installed -which codex -which claude -which gemini - -# Install missing backends -# Codex: Follow installation instructions at https://codex.docs -# Claude: Follow installation instructions at https://claude.ai/docs -# Gemini: Follow installation instructions at https://ai.google.dev/docs +which codex && codex --version +which claude && claude --version +which gemini && gemini --version ``` -**Unsupported CLI flags:** -```bash -# If you see errors like "unknown flag" or "invalid option" +## FAQ -# Check backend CLI version -codex --version -claude --version -gemini --version +| Issue | Solution | +|-------|----------| +| "Unknown event format" | Logging display issue, can be ignored | +| Gemini can't read .gitignore files | Remove from .gitignore or use different backend | +| `/dev` slow | Check logs, try faster model, use single repo | +| Codex permission denied | Set `approval_policy = "never"` in ~/.codex/config.yaml | -# For Codex: Ensure it supports `e`, `--skip-git-repo-check`, `--json`, `-C`, and `resume` -# For Claude: Ensure it supports `--output-format stream-json`, `--setting-sources`, `-r` -# For Gemini: Ensure it supports `-o stream-json`, `-y`, `-r`, `-p` - -# Update your backend CLI to the latest version if needed -``` - -**JSON parsing errors:** -```bash -# If you see "failed to parse JSON output" errors - -# Verify the backend outputs stream-json format -codex e --json "test task" # Should output newline-delimited JSON -claude --output-format stream-json -p "test" # Should output stream JSON - -# If not, your backend CLI version may be too old or incompatible -``` - -**Infinite recursion with Claude backend:** -```bash -# The wrapper prevents this with `--setting-sources ""` flag -# If you still see recursion, ensure your Claude CLI supports this flag - -claude --help | grep "setting-sources" - -# If flag is not supported, upgrade Claude CLI -``` - -**Session resume failures:** -```bash -# Check if session ID is valid -codex history # List recent sessions -claude history - -# Ensure backend CLI supports session resumption -codex resume "test" # Should continue from previous session -claude -r "test" - -# If not supported, use new sessions instead of resume mode -``` - ---- - -## FAQ (Frequently Asked Questions) - -### Q1: `codeagent-wrapper` execution fails with "Unknown event format" - -**Problem:** -``` -Unknown event format: {"type":"turn.started"} -Unknown event format: {"type":"assistant", ...} -``` - -**Solution:** -This is a logging event format display issue and does not affect actual functionality. It will be fixed in the next version. You can ignore these log outputs. - -**Related Issue:** [#96](https://github.com/cexll/myclaude/issues/96) - ---- - -### Q2: Gemini cannot read files ignored by `.gitignore` - -**Problem:** -When using `codeagent-wrapper --backend gemini`, files in directories like `.claude/` that are ignored by `.gitignore` cannot be read. - -**Solution:** -- **Option 1:** Remove `.claude/` from your `.gitignore` file -- **Option 2:** Ensure files that need to be read are not in `.gitignore` list - -**Related Issue:** [#75](https://github.com/cexll/myclaude/issues/75) - ---- - -### Q3: `/dev` command parallel execution is very slow - -**Problem:** -Using `/dev` command for simple features takes too long (over 30 minutes) with no visibility into task progress. - -**Solution:** -1. **Check logs:** Review `C:\Users\User\AppData\Local\Temp\codeagent-wrapper-*.log` to identify bottlenecks -2. **Adjust backend:** - - Try faster models like `gpt-5.1-codex-max` - - Running in WSL may be significantly faster -3. **Workspace:** Use a single repository instead of monorepo with multiple sub-projects - -**Related Issue:** [#77](https://github.com/cexll/myclaude/issues/77) - ---- - -### Q4: Codex permission denied with new Go version - -**Problem:** -After upgrading to the new Go-based Codex implementation, execution fails with permission denied errors. - -**Solution:** -Add the following configuration to `~/.codex/config.yaml` (Windows: `c:\user\.codex\config.toml`): -```yaml -model = "gpt-5.1-codex-max" -model_reasoning_effort = "high" -model_reasoning_summary = "detailed" -approval_policy = "never" -sandbox_mode = "workspace-write" -disable_response_storage = true -network_access = true -``` - -**Key settings:** -- `approval_policy = "never"` - Remove approval restrictions -- `sandbox_mode = "workspace-write"` - Allow workspace write access -- `network_access = true` - Enable network access - -**Related Issue:** [#31](https://github.com/cexll/myclaude/issues/31) - ---- - -### Q5: How to disable default bypass/skip-permissions mode - -**Background:** -By default, codeagent-wrapper enables bypass mode for both Codex and Claude backends: -- `CODEX_BYPASS_SANDBOX=true` - Bypasses Codex sandbox restrictions -- `CODEAGENT_SKIP_PERMISSIONS=true` - Skips Claude permission prompts - -**To disable (if you need sandbox/permission protection):** -```bash -export CODEX_BYPASS_SANDBOX=false -export CODEAGENT_SKIP_PERMISSIONS=false -``` - -Or add to your shell profile (`~/.zshrc` or `~/.bashrc`): -```bash -echo 'export CODEX_BYPASS_SANDBOX=false' >> ~/.zshrc -echo 'export CODEAGENT_SKIP_PERMISSIONS=false' >> ~/.zshrc -``` - -**Note:** Disabling bypass mode will require manual approval for certain operations. - ---- - -**Still having issues?** Visit [GitHub Issues](https://github.com/cexll/myclaude/issues) to search or report new issues. - ---- - -## Documentation -- **[Codeagent-Wrapper Guide](docs/CODEAGENT-WRAPPER.md)** - Multi-backend execution wrapper -- **[Hooks Documentation](docs/HOOKS.md)** - Custom hooks and automation - -### Additional Resources -- **[Installation Log](install.log)** - Installation history and troubleshooting - ---- +See [GitHub Issues](https://github.com/cexll/myclaude/issues) for more. ## License -AGPL-3.0 License - see [LICENSE](LICENSE) +AGPL-3.0 - see [LICENSE](LICENSE) ## Support -- **Issues**: [GitHub Issues](https://github.com/cexll/myclaude/issues) -- **Documentation**: [docs/](docs/) - ---- - -**Claude Code + Codex = Better Development** - Orchestration meets execution. +- [GitHub Issues](https://github.com/cexll/myclaude/issues) +- [Documentation](docs/) diff --git a/README_CN.md b/README_CN.md index 0a08cd6..3ede8a7 100644 --- a/README_CN.md +++ b/README_CN.md @@ -2,25 +2,11 @@ [![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0) [![Claude Code](https://img.shields.io/badge/Claude-Code-blue)](https://claude.ai/code) -[![Version](https://img.shields.io/badge/Version-5.6-green)](https://github.com/cexll/myclaude) +[![Version](https://img.shields.io/badge/Version-6.x-green)](https://github.com/cexll/myclaude) -> AI 驱动的开发自动化 - 多后端执行架构 (Codex/Claude/Gemini) +> AI 驱动的开发自动化 - 多后端执行架构 (Codex/Claude/Gemini/OpenCode) -## 核心概念:多后端架构 - -本系统采用**双智能体架构**与可插拔 AI 后端: - -| 角色 | 智能体 | 职责 | -|------|-------|------| -| **编排者** | Claude Code | 规划、上下文收集、验证、用户交互 | -| **执行者** | codeagent-wrapper | 代码编辑、测试执行(Codex/Claude/Gemini 后端)| - -**为什么分离?** -- Claude Code 擅长理解上下文和编排复杂工作流 -- 专业后端(Codex 擅长代码、Claude 擅长推理、Gemini 擅长原型)专注执行 -- 通过 `--backend codex|claude|gemini` 匹配模型与任务 - -## 快速开始(windows上请在Powershell中执行) +## 快速开始 ```bash git clone https://github.com/cexll/myclaude.git @@ -28,72 +14,125 @@ cd myclaude python3 install.py --install-dir ~/.claude ``` -## 工作流概览 +## 模块概览 -### 0. OmO 多智能体编排器(复杂任务推荐) +| 模块 | 描述 | 文档 | +|------|------|------| +| [do](skills/do/README.md) | **推荐** - 7 阶段功能开发 + codeagent 编排 | `/do` 命令 | +| [dev](dev-workflow/README.md) | 轻量级开发工作流 + Codex 集成 | `/dev` 命令 | +| [omo](skills/omo/README.md) | 多智能体编排 + 智能路由 | `/omo` 命令 | +| [bmad](bmad-agile-workflow/README.md) | BMAD 敏捷工作流 + 6 个专业智能体 | `/bmad-pilot` 命令 | +| [requirements](requirements-driven-workflow/README.md) | 轻量级需求到代码流水线 | `/requirements-pilot` 命令 | +| [essentials](development-essentials/README.md) | 核心开发命令和工具 | `/code`, `/debug` 等 | +| [sparv](skills/sparv/README.md) | SPARV 工作流 (Specify→Plan→Act→Review→Vault) | `/sparv` 命令 | +| course | 课程开发(组合 dev + product-requirements + test-cases) | 组合模块 | -**基于风险信号智能路由任务到专业智能体的多智能体编排系统。** +## 核心架构 + +| 角色 | 智能体 | 职责 | +|------|-------|------| +| **编排者** | Claude Code | 规划、上下文收集、验证 | +| **执行者** | codeagent-wrapper | 代码编辑、测试执行(Codex/Claude/Gemini/OpenCode 后端)| + +## 工作流详解 + +### do 工作流(推荐) + +7 阶段功能开发,通过 codeagent-wrapper 编排多个智能体。**大多数功能开发任务的首选工作流。** ```bash -/omo "分析并修复这个认证 bug" +/do "添加用户登录功能" ``` -**智能体层级:** -| 智能体 | 角色 | 后端 | 模型 | -|-------|------|------|------| -| `oracle` | 技术顾问 | Claude | claude-opus-4-5 | -| `librarian` | 外部研究 | Claude | claude-sonnet-4-5 | -| `explore` | 代码库搜索 | OpenCode | grok-code | -| `develop` | 代码实现 | Codex | gpt-5.2 | -| `frontend-ui-ux-engineer` | UI/UX 专家 | Gemini | gemini-3-pro | -| `document-writer` | 文档撰写 | Gemini | gemini-3-flash | +**7 阶段:** +| 阶段 | 名称 | 目标 | +|------|------|------| +| 1 | Discovery | 理解需求 | +| 2 | Exploration | 映射代码库模式 | +| 3 | Clarification | 解决歧义(**强制**)| +| 4 | Architecture | 设计实现方案 | +| 5 | Implementation | 构建功能(**需审批**)| +| 6 | Review | 捕获缺陷 | +| 7 | Summary | 记录结果 | -**路由信号(非固定流水线):** -- 代码位置不明确 → `explore` -- 外部库/API → `librarian` -- 高风险/多文件变更 → `oracle` -- 需要实现 → `develop` / `frontend-ui-ux-engineer` - -**常用配方:** -- 解释代码:`explore` -- 位置已知的小修复:直接 `develop` -- Bug 修复,位置未知:`explore → develop` -- 跨模块重构:`explore → oracle → develop` -- 外部 API 集成:`explore + librarian → oracle → develop` - -**适用场景:** 复杂 bug 调查、多文件重构、架构决策 +**智能体:** +- `code-explorer` - 代码追踪、架构映射 +- `code-architect` - 设计方案、文件规划 +- `code-reviewer` - 代码审查、简化建议 +- `develop` - 实现代码、运行测试 --- -### 1. Dev 工作流(推荐) +### Dev 工作流 -**大多数开发任务的首选工作流。** +轻量级开发工作流,适合简单功能开发。 ```bash /dev "实现 JWT 用户认证" ``` **6 步流程:** -1. **需求澄清** - 交互式问答明确范围 -2. **Codex 深度分析** - 代码库探索和架构决策 -3. **开发计划生成** - 结构化任务分解和测试要求 -4. **并行执行** - Codex 并发执行任务 -5. **覆盖率验证** - 强制 ≥90% 测试覆盖率 -6. **完成总结** - 文件变更和覆盖率报告 - -**核心特性:** -- Claude Code 编排,Codex 执行所有代码变更 -- 自动任务并行化提升速度 -- 强制 90% 测试覆盖率门禁 -- 失败自动回滚 - -**适用场景:** 功能开发、重构、带测试的 bug 修复 +1. 需求澄清 - 交互式问答 +2. Codex 深度分析 - 代码库探索 +3. 开发计划生成 - 结构化任务分解 +4. 并行执行 - Codex 并发执行 +5. 覆盖率验证 - 强制 ≥90% +6. 完成总结 - 报告生成 --- -### 2. BMAD 敏捷工作流 +### OmO 多智能体编排器 -**包含 6 个专业智能体的完整企业敏捷方法论。** +基于风险信号智能路由任务到专业智能体。 + +```bash +/omo "分析并修复这个认证 bug" +``` + +**智能体层级:** +| 智能体 | 角色 | 后端 | +|-------|------|------| +| `oracle` | 技术顾问 | Claude | +| `librarian` | 外部研究 | Claude | +| `explore` | 代码库搜索 | OpenCode | +| `develop` | 代码实现 | Codex | +| `frontend-ui-ux-engineer` | UI/UX 专家 | Gemini | +| `document-writer` | 文档撰写 | Gemini | + +**常用配方:** +- 解释代码:`explore` +- 位置已知的小修复:直接 `develop` +- Bug 修复(位置未知):`explore → develop` +- 跨模块重构:`explore → oracle → develop` + +--- + +### SPARV 工作流 + +极简 5 阶段工作流:Specify → Plan → Act → Review → Vault。 + +```bash +/sparv "实现订单导出功能" +``` + +**核心规则:** +- **10 分规格门**:得分 0-10,必须 >=9 才能进入 Plan +- **2 动作保存**:每 2 次工具调用写入 journal.md +- **3 失败协议**:连续 3 次失败后停止并上报 +- **EHRB**:高风险操作需明确确认 + +**评分维度(各 0-2 分):** +1. Value - 为什么做,可验证的收益 +2. Scope - MVP + 不在范围内的内容 +3. Acceptance - 可测试的验收标准 +4. Boundaries - 错误/性能/兼容/安全边界 +5. Risk - EHRB/依赖/未知 + 处理方式 + +--- + +### BMAD 敏捷工作流 + +完整企业敏捷方法论 + 6 个专业智能体。 ```bash /bmad-pilot "构建电商结账系统" @@ -104,43 +143,36 @@ python3 install.py --install-dir ~/.claude |-------|------| | Product Owner | 需求与用户故事 | | Architect | 系统设计与技术决策 | -| Tech Lead | Sprint 规划与任务分解 | +| Scrum Master | Sprint 规划与任务分解 | | Developer | 实现 | | Code Reviewer | 质量保证 | | QA Engineer | 测试与验证 | -**流程:** -``` -需求 → 架构 → Sprint计划 → 开发 → 审查 → QA - ↓ ↓ ↓ ↓ ↓ ↓ -PRD.md DESIGN.md SPRINT.md Code REVIEW.md TEST.md -``` - -**适用场景:** 大型功能、团队协作、企业项目 +**审批门:** +- PRD 完成后(90+ 分)需用户审批 +- 架构完成后(90+ 分)需用户审批 --- -### 3. 需求驱动工作流 +### 需求驱动工作流 -**轻量级需求到代码流水线。** +轻量级需求到代码流水线。 ```bash /requirements-pilot "实现 API 限流" ``` -**流程:** -1. 带质量评分的需求生成 -2. 实现规划 -3. 代码生成 -4. 审查和测试 - -**适用场景:** 快速原型、明确定义的功能 +**100 分质量评分:** +- 功能清晰度:30 分 +- 技术具体性:25 分 +- 实现完整性:25 分 +- 业务上下文:20 分 --- -### 4. 开发基础命令 +### 开发基础命令 -**日常编码任务的直接命令。** +日常编码任务的直接命令。 | 命令 | 用途 | |------|------| @@ -152,16 +184,12 @@ PRD.md DESIGN.md SPRINT.md Code REVIEW.md TEST.md | `/refactor` | 代码重构 | | `/docs` | 编写文档 | -**适用场景:** 快速任务,无需工作流开销 - --- ## 安装 -### 模块化安装(推荐) - ```bash -# 安装所有启用的模块(默认:dev + essentials) +# 安装所有启用的模块 python3 install.py --install-dir ~/.claude # 安装特定模块 @@ -170,314 +198,77 @@ python3 install.py --module dev # 列出可用模块 python3 install.py --list-modules -# 强制覆盖现有文件 +# 强制覆盖 python3 install.py --force ``` -### 可用模块 +### 模块配置 -| 模块 | 默认 | 描述 | -|------|------|------| -| `dev` | ✓ 启用 | Dev 工作流 + Codex 集成 | -| `essentials` | ✓ 启用 | 核心开发命令 | -| `bmad` | 禁用 | 完整 BMAD 敏捷工作流 | -| `requirements` | 禁用 | 需求驱动工作流 | - -### 安装内容 - -``` -~/.claude/ -├── bin/ -│ └── codeagent-wrapper # 主可执行文件 -├── CLAUDE.md # 核心指令和角色定义 -├── commands/ # 斜杠命令 (/dev, /code 等) -├── agents/ # 智能体定义 -├── skills/ -│ └── codex/ -│ └── SKILL.md # Codex 集成技能 -├── config.json # 配置文件 -└── installed_modules.json # 安装状态 -``` - -### 自定义安装目录 - -默认情况下,myclaude 安装到 `~/.claude`。您可以使用 `INSTALL_DIR` 环境变量自定义安装目录: - -```bash -# 安装到自定义目录 -INSTALL_DIR=/opt/myclaude bash install.sh - -# 相应更新您的 PATH -export PATH="/opt/myclaude/bin:$PATH" -``` - -**目录结构:** -- `$INSTALL_DIR/bin/` - codeagent-wrapper 可执行文件 -- `$INSTALL_DIR/skills/` - 技能定义 -- `$INSTALL_DIR/config.json` - 配置文件 -- `$INSTALL_DIR/commands/` - 斜杠命令定义 -- `$INSTALL_DIR/agents/` - 智能体定义 - -**注意:** 使用自定义安装目录时,请确保将 `$INSTALL_DIR/bin` 添加到您的 `PATH` 环境变量中。 - -### 配置 - -编辑 `config.json` 自定义: +编辑 `config.json` 启用/禁用模块: ```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"} - ] - } + "dev": { "enabled": true }, + "bmad": { "enabled": false }, + "requirements": { "enabled": false }, + "essentials": { "enabled": false }, + "omo": { "enabled": false }, + "sparv": { "enabled": false }, + "do": { "enabled": false }, + "course": { "enabled": false } } } ``` -**操作类型:** -| 类型 | 描述 | -|------|------| -| `merge_dir` | 合并子目录 (commands/, agents/) 到安装目录 | -| `copy_dir` | 复制整个目录 | -| `copy_file` | 复制单个文件到目标路径 | -| `run_command` | 执行 shell 命令 | - ---- - -## Codex 集成 - -`codex` 技能使 Claude Code 能够将代码执行委托给 Codex CLI。 - -### 工作流中的使用 - -```bash -# 通过技能调用 Codex -codeagent-wrapper - <<'EOF' -在 @src/auth.ts 中实现 JWT 验证 -EOF -``` - -### 并行执行 - -```bash -codeagent-wrapper --parallel <<'EOF' ----TASK--- -id: backend_api -workdir: /project/backend ----CONTENT--- -实现 /api/users 的 REST 端点 - ----TASK--- -id: frontend_ui -workdir: /project/frontend -dependencies: backend_api ----CONTENT--- -创建消费 API 的 React 组件 -EOF -``` - -### 安装 Codex Wrapper - -```bash -# 自动(通过 dev 模块) -python3 install.py --module dev - -# 手动 -bash install.sh -``` - -#### Windows 系统 - -Windows 系统会将 `codeagent-wrapper.exe` 安装到 `%USERPROFILE%\bin`。 - -```powershell -# PowerShell(推荐) -powershell -ExecutionPolicy Bypass -File install.ps1 - -# 批处理(cmd) -install.bat -``` - -**添加到 PATH**(如果安装程序未自动检测): - -```powershell -# PowerShell - 永久添加(当前用户) -[Environment]::SetEnvironmentVariable('PATH', "$HOME\bin;" + [Environment]::GetEnvironmentVariable('PATH','User'), 'User') - -# PowerShell - 仅当前会话 -$Env:PATH = "$HOME\bin;$Env:PATH" -``` - -```batch -REM cmd.exe - 永久添加(当前用户)(建议使用上面的 PowerShell 方法) -REM 警告:此命令会展开 %PATH% 包含系统 PATH,导致重复 -REM 注意:使用 reg add 而非 setx 以避免 1024 字符截断限制 -reg add "HKCU\Environment" /v Path /t REG_EXPAND_SZ /d "%USERPROFILE%\bin;%PATH%" /f -``` - ---- - ## 工作流选择指南 -| 场景 | 推荐工作流 | -|------|----------| -| 带测试的新功能 | `/dev` | -| 快速 bug 修复 | `/debug` 或 `/code` | -| 大型多 Sprint 功能 | `/bmad-pilot` | -| 原型或 POC | `/requirements-pilot` | -| 代码审查 | `/review` | -| 性能问题 | `/optimize` | +| 场景 | 推荐 | +|------|------| +| 功能开发(默认) | `/do` | +| 轻量级功能 | `/dev` | +| Bug 调查 + 修复 | `/omo` | +| 大型企业项目 | `/bmad-pilot` | +| 快速原型 | `/requirements-pilot` | +| 简单任务 | `/code`, `/debug` | ---- +## 后端 CLI 要求 + +| 后端 | 必需功能 | +|------|----------| +| Codex | `codex e`, `--json`, `-C`, `resume` | +| Claude | `--output-format stream-json`, `-r` | +| Gemini | `-o stream-json`, `-y`, `-r` | ## 故障排查 -### 常见问题 - **Codex wrapper 未找到:** ```bash -# 安装程序会自动添加 PATH,检查是否已添加 -if [[ ":$PATH:" != *":$HOME/.claude/bin:"* ]]; then - echo "PATH not configured. Reinstalling..." - bash install.sh -fi - -# 或手动添加(幂等性命令) -[[ ":$PATH:" != *":$HOME/.claude/bin:"* ]] && echo 'export PATH="$HOME/.claude/bin:$PATH"' >> ~/.zshrc -``` - -**权限被拒绝:** -```bash -python3 install.py --install-dir ~/.claude --force +bash install.sh ``` **模块未加载:** ```bash -# 检查安装状态 cat ~/.claude/installed_modules.json - -# 重新安装特定模块 -python3 install.py --module dev --force +python3 install.py --module --force ``` ---- +## FAQ -## 常见问题 (FAQ) +| 问题 | 解决方案 | +|------|----------| +| "Unknown event format" | 日志显示问题,可忽略 | +| Gemini 无法读取 .gitignore 文件 | 从 .gitignore 移除或使用其他后端 | +| `/dev` 执行慢 | 检查日志,尝试更快模型,使用单一仓库 | +| Codex 权限拒绝 | 在 ~/.codex/config.yaml 设置 `approval_policy = "never"` | -### Q1: `codeagent-wrapper` 执行时报错 "Unknown event format" - -**问题描述:** -执行 `codeagent-wrapper` 时出现错误: -``` -Unknown event format: {"type":"turn.started"} -Unknown event format: {"type":"assistant", ...} -``` - -**解决方案:** -这是日志事件流的显示问题,不影响实际功能执行。预计在下个版本中修复。如需排查其他问题,可忽略此日志输出。 - -**相关 Issue:** [#96](https://github.com/cexll/myclaude/issues/96) - ---- - -### Q2: Gemini 无法读取 `.gitignore` 忽略的文件 - -**问题描述:** -使用 `codeagent-wrapper --backend gemini` 时,无法读取 `.claude/` 等被 `.gitignore` 忽略的目录中的文件。 - -**解决方案:** -- **方案一:** 在项目根目录的 `.gitignore` 中取消对 `.claude/` 的忽略 -- **方案二:** 确保需要读取的文件不在 `.gitignore` 忽略列表中 - -**相关 Issue:** [#75](https://github.com/cexll/myclaude/issues/75) - ---- - -### Q3: `/dev` 命令并行执行特别慢 - -**问题描述:** -使用 `/dev` 命令开发简单功能耗时过长(超过30分钟),无法了解任务执行状态。 - -**解决方案:** -1. **检查日志:** 查看 `C:\Users\User\AppData\Local\Temp\codeagent-wrapper-*.log` 分析瓶颈 -2. **调整后端:** - - 尝试使用 `gpt-5.1-codex-max` 等更快的模型 - - 在 WSL 环境下运行速度可能更快 -3. **工作区选择:** 使用独立的代码仓库而非包含多个子项目的 monorepo - -**相关 Issue:** [#77](https://github.com/cexll/myclaude/issues/77) - ---- - -### Q4: 新版 Go 实现的 Codex 权限不足 - -**问题描述:** -升级到新版 Go 实现的 Codex 后,出现权限不足的错误。 - -**解决方案:** -在 `~/.codex/config.yaml` 中添加以下配置(Windows: `c:\user\.codex\config.toml`): -```yaml -model = "gpt-5.1-codex-max" -model_reasoning_effort = "high" -model_reasoning_summary = "detailed" -approval_policy = "never" -sandbox_mode = "workspace-write" -disable_response_storage = true -network_access = true -``` - -**关键配置说明:** -- `approval_policy = "never"` - 移除审批限制 -- `sandbox_mode = "workspace-write"` - 允许工作区写入权限 -- `network_access = true` - 启用网络访问 - -**相关 Issue:** [#31](https://github.com/cexll/myclaude/issues/31) - ---- - -### Q5: 执行时遇到权限拒绝或沙箱限制 - -**问题描述:** -运行 codeagent-wrapper 时出现权限错误或沙箱限制。 - -**解决方案:** -设置以下环境变量: -```bash -export CODEX_BYPASS_SANDBOX=true -export CODEAGENT_SKIP_PERMISSIONS=true -``` - -或添加到 shell 配置文件(`~/.zshrc` 或 `~/.bashrc`): -```bash -echo 'export CODEX_BYPASS_SANDBOX=true' >> ~/.zshrc -echo 'export CODEAGENT_SKIP_PERMISSIONS=true' >> ~/.zshrc -``` - -**注意:** 这些设置会绕过安全限制,请仅在可信环境中使用。 - ---- - -**仍有疑问?** 请访问 [GitHub Issues](https://github.com/cexll/myclaude/issues) 搜索或提交新问题。 - ---- +更多问题请访问 [GitHub Issues](https://github.com/cexll/myclaude/issues)。 ## 许可证 -AGPL-3.0 License - 查看 [LICENSE](LICENSE) +AGPL-3.0 - 查看 [LICENSE](LICENSE) ## 支持 -- **问题反馈**: [GitHub Issues](https://github.com/cexll/myclaude/issues) -- **文档**: [docs/](docs/) - ---- - -**Claude Code + Codex = 更好的开发** - 编排遇见执行。 +- [GitHub Issues](https://github.com/cexll/myclaude/issues) +- [文档](docs/)