mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-05 01:50:27 +08:00
docs: Update README files for v3.2.2 release
Update both English and Chinese README files to reflect v3.2.2 changes: Version Updates: - Bump version badge from v3.2.1 to v3.2.2 - Update "What's New" section with v3.2.2 features Key Documentation Changes: - Independent test session architecture (WFS-test-[source]) - Automatic cross-session context gathering via metadata - Integrated concept-enhanced analysis (Gemini + Codex parallel) - Reuses IMPL-*.json format with meta.type="test-fix" - 4-phase workflow: session → context → analysis → task generation Command Reference Updates: - Updated /workflow:test-gen description to reflect independent workflow creation - Updated Phase 4 examples to show new usage: /workflow:test-gen WFS-auth Changes in Both Files: - README.md: English version updated - README_CN.md: Chinese version updated with matching content 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
63
README.md
63
README.md
@@ -2,7 +2,7 @@
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](https://github.com/catlog22/Claude-Code-Workflow/releases)
|
||||
[](https://github.com/catlog22/Claude-Code-Workflow/releases)
|
||||
[](LICENSE)
|
||||
[]()
|
||||
[](https://github.com/modelcontextprotocol)
|
||||
@@ -15,13 +15,14 @@
|
||||
|
||||
**Claude Code Workflow (CCW)** is a next-generation multi-agent automation framework that orchestrates complex software development tasks through intelligent workflow management and autonomous execution.
|
||||
|
||||
> **🎉 Latest: v3.2.0** - Simplified agent architecture with "Tests Are the Review" philosophy. See [CHANGELOG.md](CHANGELOG.md) for details.
|
||||
> **🎉 Latest: v3.2.2** - Independent test-gen workflow with cross-session context. See [CHANGELOG.md](CHANGELOG.md) for details.
|
||||
>
|
||||
> **What's New in v3.2.0**:
|
||||
> - 🔄 Simplified from 3 agents to 2 core agents (`@code-developer`, `@test-fix-agent`)
|
||||
> - ✅ "Tests Are the Review" - Passing tests = approved code
|
||||
> - 🧪 Enhanced test-fix workflow with automatic execution and fixing
|
||||
> - 📦 Interactive installation with version selection menu
|
||||
> **What's New in v3.2.2**:
|
||||
> - 🔄 Independent test session architecture (WFS-test-[source])
|
||||
> - 🤖 Automatic cross-session context gathering via metadata
|
||||
> - 🧪 Integrated concept-enhanced analysis (Gemini + Codex parallel execution)
|
||||
> - 📦 Reuses IMPL-*.json format with meta.type="test-fix" (zero breaking changes)
|
||||
> - ⚡ 4-phase workflow: session → context → analysis → task generation
|
||||
|
||||
---
|
||||
|
||||
@@ -94,17 +95,51 @@ Select version to install (1-3, default: 1):
|
||||
|
||||
> 💡 **Pro Tip**: The installer automatically detects and displays the latest version numbers and release dates from GitHub. Just press Enter to select the recommended stable release.
|
||||
|
||||
### **📦 Local Installation (Install-Claude.ps1)**
|
||||
|
||||
For local installation without network access, use the bundled PowerShell installer:
|
||||
|
||||
**Installation Modes:**
|
||||
```powershell
|
||||
# Interactive mode with prompts (recommended)
|
||||
.\Install-Claude.ps1
|
||||
|
||||
# Quick install with automatic backup
|
||||
.\Install-Claude.ps1 -Force -BackupAll
|
||||
|
||||
# Non-interactive install
|
||||
.\Install-Claude.ps1 -NonInteractive -Force
|
||||
```
|
||||
|
||||
**Installation Options:**
|
||||
|
||||
| Mode | Description | Installs To |
|
||||
|------|-------------|-------------|
|
||||
| **Global** | System-wide installation (default) | `~/.claude/`, `~/.codex/`, `~/.gemini/` |
|
||||
| **Path** | Custom directory + global hybrid | Local: `agents/`, `commands/`<br>Global: `workflows/`, `scripts/` |
|
||||
|
||||
**Backup Behavior:**
|
||||
- **Default**: Automatic backup enabled (`-BackupAll`)
|
||||
- **Disable**: Use `-NoBackup` flag (⚠️ overwrites without backup)
|
||||
- **Backup location**: `claude-backup-{timestamp}/` in installation directory
|
||||
|
||||
**⚠️ Important Warnings:**
|
||||
- `-Force -BackupAll`: Silent file overwrite (with backup)
|
||||
- `-NoBackup -Force`: Permanent file overwrite (no recovery)
|
||||
- Global mode modifies user profile directories
|
||||
|
||||
### **✅ Verify Installation**
|
||||
After installation, run the following command to ensure CCW is working:
|
||||
```bash
|
||||
/workflow:session:list
|
||||
```
|
||||
|
||||
> **📝 Important Notes:**
|
||||
> **📝 Installation Notes:**
|
||||
> - The installer will automatically install/update `.codex/` and `.gemini/` directories
|
||||
> - **Global mode**: Installs to `~/.codex` and `~/.gemini`
|
||||
> - **Path mode**: Installs to your specified directory (e.g., `project/.codex`, `project/.gemini`)
|
||||
> - Existing files will be backed up automatically before installation
|
||||
> - **Backup**: Existing files are backed up by default to `claude-backup-{timestamp}/`
|
||||
> - **Safety**: Use interactive mode for first-time installation to review changes
|
||||
|
||||
---
|
||||
|
||||
@@ -142,9 +177,9 @@ After installation, run the following command to ensure CCW is working:
|
||||
|
||||
**Phase 4: Testing & Quality Assurance**
|
||||
```bash
|
||||
# Generate comprehensive test suite (standard workflow)
|
||||
/workflow:test-gen
|
||||
/workflow:execute
|
||||
# Generate independent test-fix workflow (v3.2.2+)
|
||||
/workflow:test-gen WFS-auth # Creates WFS-test-auth session
|
||||
/workflow:execute # Runs test validation
|
||||
|
||||
# OR verify TDD compliance (TDD workflow)
|
||||
/workflow:tdd-verify
|
||||
@@ -217,7 +252,7 @@ After installation, run the following command to ensure CCW is working:
|
||||
| `/workflow:tdd-plan` | Create a Test-Driven Development workflow with Red-Green-Refactor cycles. |
|
||||
| `/workflow:execute` | Execute the current workflow plan autonomously. |
|
||||
| `/workflow:status` | Display the current status of the workflow. |
|
||||
| `/workflow:test-gen` | Automatically generate a test plan from the implementation. |
|
||||
| `/workflow:test-gen` | Create independent test-fix workflow for validating completed implementation. |
|
||||
| `/workflow:tdd-verify` | Verify TDD compliance and generate quality report. |
|
||||
| `/workflow:review` | **Optional** manual review (only use when explicitly needed - passing tests = approved code). |
|
||||
|
||||
@@ -275,7 +310,7 @@ Configure Gemini CLI for optimal integration:
|
||||
```json
|
||||
// ~/.gemini/settings.json
|
||||
{
|
||||
"contextFileName": "CLAUDE.md"
|
||||
"contextFileName": ["CLAUDE.md", "GEMINI.md"]
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
66
README_CN.md
66
README_CN.md
@@ -2,7 +2,7 @@
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](https://github.com/catlog22/Claude-Code-Workflow/releases)
|
||||
[](https://github.com/catlog22/Claude-Code-Workflow/releases)
|
||||
[](LICENSE)
|
||||
[]()
|
||||
[](https://github.com/modelcontextprotocol)
|
||||
@@ -15,13 +15,14 @@
|
||||
|
||||
**Claude Code Workflow (CCW)** 是一个新一代的多智能体自动化开发框架,通过智能工作流管理和自主执行来协调复杂的软件开发任务。
|
||||
|
||||
> **🎉 最新版本: v3.2.0** - 采用"测试即审查"理念简化智能体架构。详见 [CHANGELOG.md](CHANGELOG.md)。
|
||||
> **🎉 最新版本: v3.2.2** - 独立测试生成工作流,支持跨会话上下文。详见 [CHANGELOG.md](CHANGELOG.md)。
|
||||
>
|
||||
> **v3.2.0 版本新特性**:
|
||||
> - 🔄 从 3 个智能体简化为 2 个核心智能体(`@code-developer`、`@test-fix-agent`)
|
||||
> - ✅ "测试即审查" - 测试通过 = 代码批准
|
||||
> - 🧪 增强的测试修复工作流,支持自动执行和修复
|
||||
> - 📦 交互式安装,包含版本选择菜单
|
||||
> **v3.2.2 版本新特性**:
|
||||
> - 🔄 独立测试会话架构(WFS-test-[source])
|
||||
> - 🤖 通过元数据自动跨会话上下文收集
|
||||
> - 🧪 集成 concept-enhanced 分析(Gemini + Codex 并行执行)
|
||||
> - 📦 复用 IMPL-*.json 格式,meta.type="test-fix"(零破坏性更改)
|
||||
> - ⚡ 4 阶段工作流:会话 → 上下文 → 分析 → 任务生成
|
||||
|
||||
---
|
||||
|
||||
@@ -94,17 +95,51 @@ bash <(curl -fsSL https://raw.githubusercontent.com/catlog22/Claude-Code-Workflo
|
||||
|
||||
> 💡 **提示**:安装程序会自动从 GitHub 检测并显示最新的版本号和发布日期。只需按 Enter 键即可选择推荐的稳定版本。
|
||||
|
||||
### **📦 本地安装 (Install-Claude.ps1)**
|
||||
|
||||
无需网络访问时,使用内置的 PowerShell 安装脚本:
|
||||
|
||||
**安装模式:**
|
||||
```powershell
|
||||
# 交互式安装(推荐)
|
||||
.\Install-Claude.ps1
|
||||
|
||||
# 快速安装(自动备份)
|
||||
.\Install-Claude.ps1 -Force -BackupAll
|
||||
|
||||
# 非交互式安装
|
||||
.\Install-Claude.ps1 -NonInteractive -Force
|
||||
```
|
||||
|
||||
**安装选项:**
|
||||
|
||||
| 模式 | 描述 | 安装位置 |
|
||||
|------|------|----------|
|
||||
| **Global** | 系统级安装(默认) | `~/.claude/`、`~/.codex/`、`~/.gemini/` |
|
||||
| **Path** | 自定义目录 + 全局混合 | 本地:`agents/`、`commands/`<br>全局:`workflows/`、`scripts/` |
|
||||
|
||||
**备份行为:**
|
||||
- **默认**:自动备份启用(`-BackupAll`)
|
||||
- **禁用**:使用 `-NoBackup` 标志(⚠️ 无备份覆盖)
|
||||
- **备份位置**:安装目录中的 `claude-backup-{timestamp}/`
|
||||
|
||||
**⚠️ 重要警告:**
|
||||
- `-Force -BackupAll`:静默文件覆盖(带备份)
|
||||
- `-NoBackup -Force`:永久文件覆盖(无法恢复)
|
||||
- Global 模式会修改用户配置目录
|
||||
|
||||
### **✅ 验证安装**
|
||||
安装后,运行以下命令以确保 CCW 正常工作:
|
||||
```bash
|
||||
/workflow:session:list
|
||||
```
|
||||
|
||||
> **📝 重要说明:**
|
||||
> **📝 安装说明:**
|
||||
> - 安装程序将自动安装/更新 `.codex/` 和 `.gemini/` 目录
|
||||
> - **全局模式**:安装到 `~/.codex` 和 `~/.gemini`
|
||||
> - **路径模式**:安装到指定目录(例如 `project/.codex`、`project/.gemini`)
|
||||
> - 安装前会自动备份现有文件
|
||||
> - **备份**:默认自动备份现有文件到 `claude-backup-{timestamp}/`
|
||||
> - **安全**:首次安装建议使用交互式模式以审查更改
|
||||
|
||||
---
|
||||
|
||||
@@ -142,15 +177,12 @@ bash <(curl -fsSL https://raw.githubusercontent.com/catlog22/Claude-Code-Workflo
|
||||
|
||||
**阶段 4:测试与质量保证**
|
||||
```bash
|
||||
# 生成全面测试套件(标准工作流)
|
||||
/workflow:test-gen
|
||||
/workflow:execute
|
||||
# 生成独立测试修复工作流(v3.2.2+)
|
||||
/workflow:test-gen WFS-auth # 创建 WFS-test-auth 会话
|
||||
/workflow:execute # 运行测试验证
|
||||
|
||||
# 或验证 TDD 合规性(TDD 工作流)
|
||||
/workflow:tdd-verify
|
||||
|
||||
# 可选:手动审查(仅在明确需要时使用)
|
||||
# /workflow:review # 测试通过 = 代码已批准
|
||||
```
|
||||
|
||||
### 简单任务快速入门
|
||||
@@ -220,7 +252,7 @@ bash <(curl -fsSL https://raw.githubusercontent.com/catlog22/Claude-Code-Workflo
|
||||
| `/workflow:tdd-plan` | 创建测试驱动开发工作流,包含 Red-Green-Refactor 循环。 |
|
||||
| `/workflow:execute` | 自主执行当前的工作流计划。 |
|
||||
| `/workflow:status` | 显示工作流的当前状态。 |
|
||||
| `/workflow:test-gen` | 从实现中自动生成测试计划。 |
|
||||
| `/workflow:test-gen` | 创建独立测试修复工作流,用于验证已完成的实现。 |
|
||||
| `/workflow:tdd-verify` | 验证 TDD 合规性并生成质量报告。 |
|
||||
| `/workflow:review` | **可选** 手动审查(仅在明确需要时使用,测试通过即代表代码已批准)。 |
|
||||
|
||||
@@ -278,7 +310,7 @@ npm install -g @google/gemini-cli @openai/codex @qwen-code/qwen-code
|
||||
```json
|
||||
// ~/.gemini/settings.json
|
||||
{
|
||||
"contextFileName": "CLAUDE.md"
|
||||
"contextFileName": ["CLAUDE.md", "GEMINI.md"]
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user