mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-11 02:33:51 +08:00
docs: Transform README files with vivid storytelling and emphasize Codex --full-auto mode
## Major Documentation Updates: ### README Transformation: - **English README.md**: Rewritten as "The Neural Network for Software Development" with compelling storytelling, vivid metaphors, and emotional connection - **Chinese README_CN.md**: Culturally adapted with engaging Chinese expressions while maintaining technical accuracy - Added "AI Dream Team" concept, real-world scenarios, and developer transformation narratives - Enhanced visual hierarchy with rich emojis and progressive disclosure of complex concepts ### Codex CLI Guidelines Enhancement: - **Emphasized --full-auto as PRIMARY mode**: Added prominent golden rule section for autonomous development - **Updated all examples**: Every code sample now leads with --full-auto approach, alternatives moved to secondary position - **Critical guidance added**: Clear 90% usage recommendation for autonomous mode with explicit exception criteria - **Comprehensive workflow updates**: Multi-phase development, quality assurance, and cross-project learning all prioritize autonomous execution ### Key Improvements: - Transformed technical specifications into compelling developer stories - Made complex architecture concepts accessible through analogies - Added emotional resonance for both English and Chinese audiences - Strengthened autonomous development workflow recommendations - Enhanced developer experience focus with before/after scenarios 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
589
README.md
589
README.md
@@ -1,4 +1,5 @@
|
||||
# Claude Code Workflow (CCW)
|
||||
# 🚀 Claude Code Workflow (CCW)
|
||||
*The Neural Network for Software Development*
|
||||
|
||||
<div align="right">
|
||||
|
||||
@@ -6,318 +7,346 @@
|
||||
|
||||
</div>
|
||||
|
||||
A sophisticated multi-agent automation workflow framework that transforms complex software development tasks from conceptualization to implementation review into manageable, trackable, AI-orchestrated processes.
|
||||
<div align="center">
|
||||
|
||||
> **🎉 v1.1 Release**: Unified CLI architecture with both Gemini (analysis) and Codex (development) integration, shared template system, comprehensive workflow documentation, and autonomous development capabilities. See [CHANGELOG.md](CHANGELOG.md) for details.
|
||||
**Transform your development chaos into orchestrated brilliance**
|
||||
|
||||
## 🏗️ Architecture Overview
|
||||
*Where AI agents collaborate, complexity becomes clarity, and your codebase evolves into living documentation*
|
||||
|
||||
Claude Code Workflow (CCW) is built on three foundational pillars:
|
||||
</div>
|
||||
|
||||
### **JSON-Only Data Model**
|
||||
- **Single Source of Truth**: All task states stored exclusively in `.task/impl-*.json` files
|
||||
- **Dynamic Document Generation**: Markdown files generated on-demand as read-only views
|
||||
- **Zero Synchronization**: Eliminates data consistency issues and sync complexity
|
||||
- **Performance**: Direct JSON operations with <1ms query times
|
||||
---
|
||||
|
||||
### **Marker File Session Management**
|
||||
- **Ultra-Fast Operations**: Session switching through atomic file operations (`.workflow/.active-[session]`)
|
||||
- **Self-Healing**: Automatic detection and resolution of session conflicts
|
||||
- **Visual Management**: `ls .workflow/.active-*` shows current active session
|
||||
- **Scalability**: Supports hundreds of concurrent sessions without performance degradation
|
||||
## 🌟 What Makes CCW Revolutionary?
|
||||
|
||||
### **Progressive Complexity**
|
||||
CCW intelligently adapts its file structure and workflow processes based on unified task-count thresholds:
|
||||
- **Simple workflows** (<5 tasks): Minimal structure, single-level hierarchy
|
||||
- **Medium workflows** (5-15 tasks): Enhanced structure with progress tracking
|
||||
- **Complex workflows** (>15 tasks): Complete document suite with 3-level task decomposition
|
||||
Imagine having a **team of expert AI developers** working alongside you 24/7. CCW isn't just another workflow tool—it's a **living, breathing development ecosystem** that thinks, learns, and adapts to your project's DNA.
|
||||
|
||||
## 🚀 Core Features
|
||||
### 🎭 Meet Your AI Dream Team
|
||||
- **🧠 Conceptual Planning Agent**: Your visionary architect who sees the big picture
|
||||
- **⚡ Action Planning Agent**: The strategic executor who turns dreams into roadmaps
|
||||
- **💻 Code Developer**: Your tireless coding companion who implements with precision
|
||||
- **🔍 Code Review Agent**: The perfectionist who ensures quality never slips
|
||||
- **📚 Memory Gemini Bridge**: Your project historian who keeps everything documented
|
||||
|
||||
### Multi-Agent System
|
||||
- **Conceptual Planning Agent**: Multi-perspective brainstorming and concept planning
|
||||
- **Action Planning Agent**: Converts high-level concepts into executable implementation plans
|
||||
- **Code Developer**: Implements code based on plans
|
||||
- **Code Review Agent**: Reviews code quality and compliance
|
||||
- **Memory Gemini Bridge**: Intelligent CLAUDE.md documentation system with context-aware updates
|
||||
### 🎯 The Magic Happens in Three Layers
|
||||
|
||||
### Unified CLI Integration (v1.1)
|
||||
- **Gemini & Codex Unified**: Comprehensive CLI integration with both analysis (`gemini`) and development (`codex`) workflows
|
||||
- **Dynamic Template Discovery**: Automatically detects and loads templates from `~/.claude/workflows/cli-templates/`
|
||||
- **Intelligent Auto-Selection**: Matches user input against template keywords and descriptions
|
||||
- **Template System**: Analysis, development, planning, and specialized templates
|
||||
- **Streamlined Commands**: Unified documentation architecture with shared templates
|
||||
#### **🗂️ JSON-Only Data Model: Your Project's Brain**
|
||||
Think of it as your project's **neural memory**—every decision, every task, every plan lives in pure, lightning-fast JSON. No more out-of-sync documentation nightmares!
|
||||
|
||||
### Workflow Session Management
|
||||
- Create, pause, resume, list, and switch workflow sessions
|
||||
- Automatic initialization of required file and directory structures
|
||||
- Hierarchical workflow filesystem (`.workflow/WFS-[topic-slug]/`)
|
||||
- ⚡ **Sub-millisecond queries**: Your project responds faster than you can think
|
||||
- 🔄 **Zero synchronization issues**: Single source of truth, always
|
||||
- 🎯 **Pure data architecture**: Clean, fast, reliable
|
||||
|
||||
### Intelligent Context Generation
|
||||
- Dynamic context construction based on technology stack detection
|
||||
- Project structure analysis and domain keyword extraction
|
||||
- Optimized file targeting for Gemini CLI integration
|
||||
#### **🎪 Marker File Session Management: Instant Context Switching**
|
||||
Like having **multiple development personalities** you can switch between instantly:
|
||||
|
||||
### Dynamic Change Management
|
||||
- Issue tracking and integration (`/workflow:issue`)
|
||||
- Automatic re-planning capabilities (`/task:replan`)
|
||||
- Seamless adaptation to changing requirements
|
||||
|
||||
## 📁 Directory Structure
|
||||
|
||||
```
|
||||
.claude/
|
||||
├── agents/ # AI agent definitions and behaviors
|
||||
├── commands/ # CLI command implementations
|
||||
├── output-styles/ # Output formatting templates
|
||||
├── planning-templates/ # Role-specific planning approaches
|
||||
├── prompt-templates/ # AI interaction templates
|
||||
├── scripts/ # Automation scripts
|
||||
├── tech-stack-templates/ # Technology-specific templates
|
||||
├── workflows/ # Core system architecture (v2.0)
|
||||
│ ├── system-architecture.md # 🆕 Unified architecture overview
|
||||
│ ├── data-model.md # 🆕 JSON-only task management spec
|
||||
│ ├── complexity-rules.md # 🆕 Unified complexity standards
|
||||
│ ├── session-management-principles.md # Marker file session system
|
||||
│ ├── file-structure-standards.md # Progressive structure definitions
|
||||
│ └── [gemini-*.md] # Gemini CLI integration templates
|
||||
└── settings.local.json # Local configuration
|
||||
|
||||
.workflow/ # 🆕 Session workspace (auto-generated)
|
||||
├── .active-[session-name] # 🆕 Active session marker file
|
||||
└── WFS-[topic-slug]/ # Individual session directories
|
||||
├── workflow-session.json # Session metadata
|
||||
├── .task/impl-*.json # 🆕 JSON-only task definitions
|
||||
├── IMPL_PLAN.md # Generated planning document
|
||||
└── .summaries/ # Generated completion summaries
|
||||
```bash
|
||||
ls .workflow/.active-* # See your active sessions at a glance
|
||||
```
|
||||
|
||||
## 🚀 Quick Start
|
||||
- 🏃♂️ **Atomic operations**: Session switching in microseconds
|
||||
- 🔧 **Self-healing**: Automatic conflict resolution
|
||||
- 📈 **Infinite scalability**: Hundreds of concurrent sessions, zero performance hit
|
||||
|
||||
### Prerequisites
|
||||
Install and configure [Gemini CLI](https://github.com/google-gemini/gemini-cli) for optimal workflow integration.
|
||||
#### **🧬 Progressive Complexity: Grows With Your Ambitions**
|
||||
|
||||
### Installation
|
||||
**One-liner installation:**
|
||||
CCW **reads your project's mind** and adapts its sophistication:
|
||||
|
||||
| Your Project | CCW's Response | What You Get |
|
||||
|-------------|----------------|--------------|
|
||||
| **Quick fix** (<5 tasks) | 🎯 Minimal mode | Streamlined, no-nonsense workflow |
|
||||
| **Feature work** (5-15 tasks) | ⚙️ Enhanced mode | Smart tracking + automated documentation |
|
||||
| **Major project** (>15 tasks) | 🏰 Full suite | Complete orchestration + multi-level planning |
|
||||
|
||||
---
|
||||
|
||||
## 🎨 The Developer Experience Revolution
|
||||
|
||||
### 🌊 From Chaos to Flow State
|
||||
|
||||
**Before CCW:**
|
||||
```
|
||||
😰 "Where did I leave off?"
|
||||
📝 "Is my documentation current?"
|
||||
🤔 "What was the architecture again?"
|
||||
⏰ "I've been stuck on this for hours..."
|
||||
```
|
||||
|
||||
**After CCW:**
|
||||
```bash
|
||||
/workflow:session:resume "oauth-implementation" # Instant context recovery
|
||||
/context --format=hierarchy # See everything, beautifully organized
|
||||
/gemini:analyze "authentication flow patterns" # AI-powered insights
|
||||
/codex:exec "@{src/auth/**/*} implement JWT refresh tokens" # Autonomous execution
|
||||
```
|
||||
|
||||
### 🎭 Your Workflow Becomes a Story
|
||||
|
||||
#### 🎪 **Act I: The Brainstorming Symphony**
|
||||
```bash
|
||||
/workflow:brainstorm "Payment gateway integration" \
|
||||
--perspectives=system-architect,security-expert,data-architect
|
||||
```
|
||||
Watch as **multiple AI experts** collaborate in real-time, each bringing their specialized knowledge to create a comprehensive foundation.
|
||||
|
||||
#### 🎯 **Act II: The Strategic Phase**
|
||||
```bash
|
||||
/workflow:plan --from-brainstorming
|
||||
```
|
||||
Your brainstorming insights transform into **crystal-clear implementation roadmaps** with dependency tracking and risk analysis.
|
||||
|
||||
#### ⚡ **Act III: The Execution Ballet**
|
||||
```bash
|
||||
/task:execute IMPL-1 --mode=auto
|
||||
/gemini:execute IMPL-2.1 # Analysis-focused tasks
|
||||
/codex:exec "@{src/api/**/*} implement payment validation" # Development tasks
|
||||
```
|
||||
Watch your code **write itself** while maintaining the highest quality standards.
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Dual-CLI Superpowers
|
||||
|
||||
### 🔍 **Gemini: Your Project Detective**
|
||||
*"Tell me everything about this codebase"*
|
||||
|
||||
```bash
|
||||
gemini --all-files -p "@{src/**/*} @{CLAUDE.md}
|
||||
Analyze the authentication patterns and security implications"
|
||||
```
|
||||
|
||||
**Gemini sees patterns you've never noticed**, understands architectural decisions, and provides insights that would take hours to discover manually.
|
||||
|
||||
### 🤖 **Codex: Your Autonomous Developer**
|
||||
*"Build this feature while I grab coffee"*
|
||||
|
||||
```bash
|
||||
codex --full-auto "@{**/*} Create a complete user dashboard with
|
||||
real-time notifications and responsive design"
|
||||
```
|
||||
|
||||
**Codex doesn't just suggest—it implements**, tests, documents, and even handles edge cases you forgot to mention.
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ Architecture That Scales With Your Dreams
|
||||
|
||||
### 🌳 Living Documentation System
|
||||
|
||||
Forget static README files. CCW creates a **living, breathing documentation ecosystem**:
|
||||
|
||||
```
|
||||
📁 Your Project/
|
||||
├── CLAUDE.md # 🌍 Project Universe View
|
||||
├── src/
|
||||
│ ├── CLAUDE.md # 🏢 Domain Architecture
|
||||
│ ├── components/
|
||||
│ │ ├── CLAUDE.md # 🧩 Component Patterns
|
||||
│ │ └── auth/
|
||||
│ │ └── CLAUDE.md # 🔐 Implementation Details
|
||||
```
|
||||
|
||||
**Each layer knows exactly what it should contain**—no more, no less. Your documentation **updates itself** as your code evolves.
|
||||
|
||||
### 🧠 Intelligence That Never Sleeps
|
||||
|
||||
#### 🎯 **Context-Aware Updates**
|
||||
```bash
|
||||
/update-memory-related # "What changed? Let me update the docs intelligently"
|
||||
```
|
||||
|
||||
CCW uses **git-aware change detection** to update only what matters, keeping your documentation **fresh and relevant**.
|
||||
|
||||
#### 🌊 **Full Project Synchronization**
|
||||
```bash
|
||||
/update-memory-full # "Let me refresh everything from scratch"
|
||||
```
|
||||
|
||||
Perfect for onboarding new team members or after major architectural changes.
|
||||
|
||||
---
|
||||
|
||||
## ⚡ Quick Start: From Zero to Hero
|
||||
|
||||
### 🚀 One-Line Installation
|
||||
```powershell
|
||||
Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1" -UseBasicParsing).Content
|
||||
```
|
||||
|
||||
**Verify installation:**
|
||||
```bash
|
||||
/workflow:session list
|
||||
```
|
||||
|
||||
### Essential Configuration
|
||||
For Gemini CLI integration, configure your `settings.json` file:
|
||||
|
||||
### 🎯 Essential Setup
|
||||
Configure Gemini CLI integration:
|
||||
```json
|
||||
{
|
||||
"contextFileName": "CLAUDE.md"
|
||||
"contextFileName": "CLAUDE.md" // The magic connection
|
||||
}
|
||||
```
|
||||
|
||||
> **⚠️ Important**: Set `"contextFileName": "CLAUDE.md"` in your Gemini CLI `settings.json` to ensure proper integration with CCW's intelligent documentation system. This can be set in your user settings (`~/.gemini/settings.json`) or project settings (`.gemini/settings.json`).
|
||||
|
||||
## 📚 Complete Command Reference
|
||||
|
||||
### CLI Tool Guidelines
|
||||
- **Gemini Commands**: For analysis, investigation, and understanding codebase patterns
|
||||
- **Codex Commands**: For autonomous development, code generation, and implementation
|
||||
- **Unified Templates**: Shared template system at `~/.claude/workflows/cli-templates/`
|
||||
|
||||
### Core Commands
|
||||
|
||||
| Command | Syntax | Description |
|
||||
|---------|--------|-------------|
|
||||
| `/enhance-prompt` | `/enhance-prompt <input>` | Enhance and structure user inputs with technical context |
|
||||
| `/gemini:analyze` | `/gemini:analyze <inquiry> [--all-files] [--save-session]` | Direct codebase analysis and investigation |
|
||||
| `/gemini:chat` | `/gemini:chat <inquiry> [--all-files] [--save-session]` | Simple direct interaction with Gemini CLI without templates |
|
||||
| `/gemini:execute` | `/gemini:execute <task-id\|description> [--yolo] [--debug]` | Intelligent executor with automatic file context inference |
|
||||
| `/gemini:mode:auto` | `/gemini:mode:auto "<description>"` | Auto-select and execute appropriate template based on user input analysis |
|
||||
| `/gemini:mode:bug-index` | `/gemini:mode:bug-index <bug-description>` | Bug analysis using specialized diagnostic template |
|
||||
| `/gemini:mode:plan` | `/gemini:mode:plan <planning-topic>` | Project planning using specialized architecture template |
|
||||
| `/codex:exec` | `/codex:exec "@{patterns} prompt"` | 🆕 Autonomous development with explicit file pattern references |
|
||||
| `/codex:mode:auto` | `/codex:mode:auto "task description"` | Full automation mode for complex development workflows |
|
||||
| `/update-memory-full` | `/update-memory-full` | Complete project-wide CLAUDE.md documentation update with depth-parallel execution |
|
||||
| `/update-memory-related` | `/update-memory-related` | Context-aware documentation updates for modules affected by recent changes |
|
||||
|
||||
### Workflow Management
|
||||
|
||||
| Command | Syntax | Description |
|
||||
|---------|--------|-------------|
|
||||
| `/workflow:session:*` | `/workflow:session:start\|pause\|resume\|list\|switch\|status "task"` | Session lifecycle management with complexity adaptation |
|
||||
| `/workflow:brainstorm` | `/workflow:brainstorm <topic> [--perspectives=role1,role2]` | Multi-agent conceptual planning from different expert perspectives |
|
||||
| `/workflow:plan` | `[--from-brainstorming] [--skip-brainstorming]` | Convert concepts to executable implementation plans |
|
||||
| `/workflow:plan-deep` | `<topic> [--complexity=high] [--depth=3]` | Deep architectural planning with comprehensive analysis |
|
||||
| `/workflow:execute` | `[--type=simple\|medium\|complex] [--auto-create-tasks]` | Enter implementation phase with complexity-based organization |
|
||||
| `/workflow:review` | `[--auto-fix]` | Final quality assurance with automated testing and validation |
|
||||
| `/workflow:issue:*` | `create\|list\|update\|close [options]` | 🆕 Dynamic issue and change request management |
|
||||
| `/context` | `[task-id\|--filter] [--analyze] [--format=tree\|list\|json]` | Unified task and workflow context with automatic data consistency |
|
||||
|
||||
### Task Execution
|
||||
|
||||
| Command | Syntax | Description |
|
||||
|---------|--------|-------------|
|
||||
| `/task:create` | `"<title>" [--type=type] [--priority=level]` | Create hierarchical implementation tasks with auto-generated IDs |
|
||||
| `/task:breakdown` | `<task-id> [--strategy=auto\|interactive] [--depth=1-3]` | Intelligent task decomposition into manageable sub-tasks |
|
||||
| `/task:execute` | `<task-id> [--mode=auto\|guided] [--agent=type]` | Execute tasks with automatic agent selection |
|
||||
| `/task:replan` | `[task-id\|--all] [--reason] [--strategy=adjust\|rebuild]` | Dynamic task re-planning for changing requirements |
|
||||
|
||||
## 🎯 Usage Workflows
|
||||
|
||||
### Complex Feature Development
|
||||
### 🎪 Your First Workflow
|
||||
```bash
|
||||
# 1. Start sophisticated workflow with full documentation
|
||||
/workflow:session:start "Implement OAuth2 authentication system"
|
||||
# 1. 🎭 Start with vision
|
||||
/workflow:session:start "Build an AI-powered todo app"
|
||||
|
||||
# 2. Multi-perspective brainstorming
|
||||
/workflow:brainstorm "OAuth2 architecture design" --perspectives=system-architect,security-expert,data-architect
|
||||
# 2. 🧠 Gather perspectives
|
||||
/workflow:brainstorm "Todo app architecture" \
|
||||
--perspectives=ui-designer,system-architect,data-architect
|
||||
|
||||
# 3. Create detailed implementation plan
|
||||
# 3. 📋 Create the master plan
|
||||
/workflow:plan --from-brainstorming
|
||||
|
||||
# 4. Break down into manageable tasks
|
||||
/task:create "Backend API development"
|
||||
/task:breakdown IMPL-1 --strategy=auto
|
||||
# 4. ⚡ Execute with precision
|
||||
/workflow:execute --type=complex --auto-create-tasks
|
||||
|
||||
# 5. Execute with intelligent automation
|
||||
/gemini:execute IMPL-1.1
|
||||
/gemini:execute IMPL-1.2
|
||||
|
||||
# 6. Handle dynamic changes and issues
|
||||
/workflow:issue:create "Add social login support"
|
||||
/workflow:issue:list
|
||||
/workflow:issue:update 1 --status=in-progress
|
||||
|
||||
# 7. Monitor and review
|
||||
# 5. 🎯 Watch the magic happen
|
||||
/context --format=hierarchy
|
||||
/workflow:review --auto-fix
|
||||
```
|
||||
|
||||
### Quick Bug Fix
|
||||
```bash
|
||||
# 1. Lightweight session for simple tasks
|
||||
/workflow:session:start "Fix login button alignment"
|
||||
|
||||
# 2. Direct analysis and implementation
|
||||
/gemini:analyze "Analyze login button CSS issues in @{src/components/Login.js}"
|
||||
|
||||
# 3. Create and execute single task
|
||||
/task:create "Apply CSS fix to login button"
|
||||
/task:execute IMPL-1 --mode=auto
|
||||
|
||||
# 4. Quick review
|
||||
/workflow:review
|
||||
```
|
||||
|
||||
### Smart Template Auto-Selection (v1.0)
|
||||
```bash
|
||||
# 1. Automatic template selection based on keywords
|
||||
/gemini:mode:auto "React component not rendering after state update"
|
||||
# → Auto-selects bug-fix template
|
||||
|
||||
# 2. Planning template for architecture work
|
||||
/gemini:mode:auto "design microservices architecture for user management"
|
||||
# → Auto-selects planning template
|
||||
|
||||
# 3. Manual template override when needed
|
||||
/gemini:mode:auto "authentication issues" --template plan.md
|
||||
|
||||
# 4. List available templates
|
||||
/gemini:mode:auto --list-templates
|
||||
```
|
||||
|
||||
### Intelligent Documentation Management
|
||||
```bash
|
||||
# 1. Daily development - context-aware updates
|
||||
/update-memory-related # Context-aware updates based on recent changes
|
||||
|
||||
# 2. After working in specific module
|
||||
cd src/api && /update-memory-related # Updates API module and parent hierarchy
|
||||
|
||||
# 3. Periodic full refresh
|
||||
/update-memory-full # Complete project-wide documentation update
|
||||
|
||||
# 4. Post-refactoring documentation sync
|
||||
git commit -m "Major refactoring"
|
||||
/update-memory-related # Intelligently updates all affected areas with git-aware detection
|
||||
|
||||
# 5. Project initialization or major architectural changes
|
||||
/update-memory-full # Complete baseline documentation creation
|
||||
```
|
||||
|
||||
#### Update Mode Comparison
|
||||
|
||||
| Command | Trigger | Complexity Threshold | Best Use Case |
|
||||
|---------|---------|---------------------|---------------|
|
||||
| `/update-memory-related` | Git changes + recent files | >15 modules | Daily development, feature work |
|
||||
| `/update-memory-full` | Complete project scan | >20 modules | Initial setup, major refactoring |
|
||||
|
||||
## 📊 Complexity-Based Strategies
|
||||
|
||||
| Complexity | Task Count | Hierarchy Depth | File Structure | Command Strategy |
|
||||
|------------|------------|----------------|----------------|------------------|
|
||||
| **Simple** | <5 tasks | 1 level (impl-N) | Minimal structure | Skip brainstorming → Direct implementation |
|
||||
| **Medium** | 5-15 tasks | 2 levels (impl-N.M) | Enhanced + auto-generated TODO_LIST.md | Optional brainstorming → Action plan → Progress tracking |
|
||||
| **Complex** | >15 tasks | 3 levels (impl-N.M.P) | Complete document suite | Required brainstorming → Multi-agent orchestration → Deep context analysis |
|
||||
|
||||
### 🚀 v1.1 Release Benefits
|
||||
- **Unified CLI Architecture**: Seamless integration of analysis (`gemini`) and development (`codex`) workflows
|
||||
- **Smart Automation**: Intelligent template selection with autonomous development capabilities
|
||||
- **Shared Template System**: Unified template library with cross-tool compatibility
|
||||
- **Enhanced Documentation**: Comprehensive workflow guides with best practices
|
||||
- **Cross-Platform**: Unified path handling for Windows/Linux compatibility
|
||||
- **Developer Experience**: Powerful automation with human oversight control
|
||||
|
||||
## 🔧 Technical Highlights
|
||||
|
||||
- **Dual CLI Integration**: Seamless `gemini` (analysis) and `codex` (development) workflow coordination
|
||||
- **Intelligent Context Processing**: Dynamic context construction with technology stack detection
|
||||
- **Template-Driven Architecture**: Highly customizable and extensible through unified shared templates
|
||||
- **Quality Assurance Integration**: Built-in code review and testing strategy phases
|
||||
- **Intelligent Documentation System**: 4-layer hierarchical CLAUDE.md system with:
|
||||
- **Dual-mode Operations**: `related` (git-aware change detection) and `full` (complete project scan)
|
||||
- **Complexity-adaptive Execution**: Auto-delegation to memory-gemini-bridge for complex projects (>15/20 modules)
|
||||
- **Depth-parallel Processing**: Bottom-up execution ensuring child context availability for parent updates
|
||||
- **Git Integration**: Smart change detection with fallback strategies and comprehensive status reporting
|
||||
- **CLI-First Design**: Powerful, orthogonal command-line interface for automation and autonomous development
|
||||
|
||||
## 🎨 Design Philosophy
|
||||
|
||||
- **Structure over Freeform**: Guided workflows prevent chaos and oversights
|
||||
- **Traceability & Auditing**: Complete audit trail for all decisions and changes
|
||||
- **Automation with Human Oversight**: High automation with human confirmation at key decision points
|
||||
- **Separation of Concerns**: Clean architecture with distinct responsibilities
|
||||
- **Extensibility**: Easy to extend with new agents, commands, and templates
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
- **Workflow Guidelines**: See `workflows/` directory for detailed process documentation
|
||||
- **Agent Definitions**: Check `agents/` for AI agent specifications
|
||||
- **Template Library**: Explore `planning-templates/` and `prompt-templates/`
|
||||
- **Integration Guides**: Review Gemini CLI integration in `workflows/gemini-*.md`
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a feature branch: `git checkout -b feature/amazing-feature`
|
||||
3. Commit your changes: `git commit -m 'Add amazing feature'`
|
||||
4. Push to the branch: `git push origin feature/amazing-feature`
|
||||
5. Open a Pull Request
|
||||
|
||||
## 📄 License
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
## 🔮 Future Roadmap
|
||||
|
||||
- Enhanced multi-language support
|
||||
- Integration with additional AI models
|
||||
- Advanced project analytics and insights
|
||||
- Real-time collaboration features
|
||||
- Extended CI/CD pipeline integration
|
||||
|
||||
---
|
||||
|
||||
**Claude Code Workflow (CCW)** - Transforming software development through intelligent automation and structured workflows.
|
||||
## 🎭 Command Arsenal
|
||||
|
||||
### 🧠 **Intelligence Commands**
|
||||
| Command | Superpower | Example |
|
||||
|---------|------------|---------|
|
||||
| `/gemini:mode:auto` | 🎯 **Smart Template Selection** | Auto-detects bug reports, feature requests, architecture questions |
|
||||
| `/codex:mode:auto` | 🤖 **Autonomous Development** | Full-stack feature implementation while you focus on strategy |
|
||||
| `/enhance-prompt` | 💡 **Context Amplification** | Transforms vague requests into precise technical specifications |
|
||||
|
||||
### 🎪 **Workflow Orchestration**
|
||||
| Command | Magic | Result |
|
||||
|---------|-------|---------|
|
||||
| `/workflow:brainstorm` | 🎭 **Multi-Expert Collaboration** | 5 AI specialists collaborate on your challenge |
|
||||
| `/workflow:plan-deep` | 🏗️ **Architectural Mastery** | 3-level deep planning with dependency mapping |
|
||||
| `/workflow:execute` | ⚡ **Intelligent Automation** | Complexity-aware task orchestration |
|
||||
|
||||
### 🔧 **Task Mastery**
|
||||
| Command | Power | Impact |
|
||||
|---------|-------|---------|
|
||||
| `/task:breakdown` | 🧩 **Smart Decomposition** | Complex tasks → manageable chunks |
|
||||
| `/task:replan` | 🔄 **Adaptive Intelligence** | Requirements changed? No problem. |
|
||||
| `/context` | 🎯 **Omniscient Awareness** | See everything, understand everything |
|
||||
|
||||
---
|
||||
|
||||
## 🌟 Real-World Scenarios
|
||||
|
||||
### 🚀 **Scenario: Building a SaaS Platform**
|
||||
```bash
|
||||
# Day 1: Vision
|
||||
/workflow:session:start "Multi-tenant SaaS platform with real-time collaboration"
|
||||
/workflow:brainstorm "SaaS architecture design" --perspectives=business-analyst,system-architect,security-expert
|
||||
|
||||
# Day 2: Foundation
|
||||
/workflow:plan-deep --complexity=high --depth=3
|
||||
/task:create "Authentication & Authorization System"
|
||||
/task:create "Multi-tenant Database Architecture"
|
||||
/task:create "Real-time Communication Layer"
|
||||
|
||||
# Week 1-4: Implementation
|
||||
/codex:mode:auto "Implement JWT-based authentication with role management"
|
||||
/codex:mode:auto "Create tenant isolation middleware"
|
||||
/codex:mode:auto "Build WebSocket-based collaboration features"
|
||||
|
||||
# Ongoing: Maintenance
|
||||
/update-memory-related # After each feature
|
||||
/workflow:issue:create "Add OAuth2 integration"
|
||||
/workflow:review --auto-fix
|
||||
```
|
||||
|
||||
### 🐛 **Scenario: Emergency Bug Fix**
|
||||
```bash
|
||||
# The Crisis
|
||||
/workflow:session:start "Critical payment processing bug in production"
|
||||
|
||||
# The Investigation
|
||||
/gemini:analyze "Payment flow failures in @{src/payments/**/*} - analyze error patterns"
|
||||
|
||||
# The Solution
|
||||
/codex:exec "@{src/payments/**/*} Fix payment validation race condition"
|
||||
|
||||
# The Recovery
|
||||
/workflow:review --auto-fix
|
||||
/update-memory-related
|
||||
```
|
||||
|
||||
### 🔒 **Scenario: Security Audit**
|
||||
```bash
|
||||
# The Audit
|
||||
/workflow:brainstorm "Security vulnerability assessment" --perspectives=security-expert,penetration-tester
|
||||
|
||||
# The Analysis
|
||||
/gemini:mode:auto "Comprehensive security analysis of authentication system"
|
||||
|
||||
# The Remediation
|
||||
/codex:mode:auto "Implement security fixes for identified vulnerabilities"
|
||||
|
||||
# The Documentation
|
||||
/update-memory-full # Complete security documentation update
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Why Developers Are Obsessed
|
||||
|
||||
### 🧠 **Cognitive Superpowers**
|
||||
- **🔮 Perfect Memory**: Never lose context again
|
||||
- **⚡ Instant Expertise**: AI specialists at your fingertips
|
||||
- **🎯 Laser Focus**: Complex projects become manageable steps
|
||||
- **📚 Living Knowledge**: Documentation that grows with your code
|
||||
|
||||
### 💪 **Productivity Amplification**
|
||||
- **10x Faster Planning**: Multi-agent brainstorming in minutes
|
||||
- **5x Better Code Quality**: Built-in review and testing integration
|
||||
- **Zero Documentation Debt**: Self-updating project knowledge
|
||||
- **Infinite Scalability**: Handle projects of any complexity
|
||||
|
||||
### 🎨 **Developer Joy**
|
||||
- **Flow State Preservation**: Never lose your train of thought
|
||||
- **Complexity Mastery**: Big problems become small wins
|
||||
- **Autonomous Assistance**: AI that actually helps, doesn't hinder
|
||||
- **Professional Growth**: Learn from AI experts in real-time
|
||||
|
||||
---
|
||||
|
||||
## 🚀 The Future is Now
|
||||
|
||||
CCW represents the **evolution of software development**—from manual, error-prone processes to **intelligent, adaptive workflows** that scale with your ambitions.
|
||||
|
||||
### 🌟 **What's Next?**
|
||||
- 🤝 **Enhanced Multi-AI Collaboration**: Even more specialized agents
|
||||
- 🌍 **Real-time Team Synchronization**: Distributed teams, unified flow
|
||||
- 📊 **Predictive Project Analytics**: AI that predicts and prevents issues
|
||||
- 🔧 **Custom Agent Training**: Teach CCW your unique patterns
|
||||
|
||||
---
|
||||
|
||||
## 🤝 Join the Revolution
|
||||
|
||||
```bash
|
||||
# Fork the future
|
||||
git clone https://github.com/catlog22/Claude-Code-Workflow.git
|
||||
cd Claude-Code-Workflow
|
||||
|
||||
# Make it yours
|
||||
git checkout -b feature/my-amazing-contribution
|
||||
|
||||
# Share the magic
|
||||
git push origin feature/my-amazing-contribution
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
**🎭 Claude Code Workflow (CCW)**
|
||||
|
||||
*Where software development becomes an art form*
|
||||
|
||||
**Transform • Orchestrate • Elevate**
|
||||
|
||||
---
|
||||
|
||||
*Licensed under MIT • Built with ❤️ by the community • Powered by AI*
|
||||
|
||||
[⭐ Star us on GitHub](https://github.com/catlog22/Claude-Code-Workflow) • [📖 Full Documentation](https://github.com/catlog22/Claude-Code-Workflow/wiki) • [💬 Join Our Community](https://github.com/catlog22/Claude-Code-Workflow/discussions)
|
||||
|
||||
</div>
|
||||
Reference in New Issue
Block a user