Skip to content

v3.4.2 - CLI Documentation Refactoring

Latest
Latest
Compare
Choose a tag to compare
@catlog22 catlog22 released this 05 Oct 02:44
· 1 commit to main since this release
v3.4.2
12034c8

📚 CLI Documentation Refactoring

This release focuses on eliminating redundant documentation by establishing a single source of truth (SSOT) pattern for CLI command references.

Highlights

  • ✨ Refactored 7 CLI command files - Removed 681 total lines of duplicate content
  • 🎯 Single Source of Truth - Established implicit reference pattern to intelligent-tools-strategy.md
  • 🔍 Documentation Consistency - All CLI commands now reference centralized strategy guide
  • 💡 Maintenance Optimization - Reduced maintenance overhead while preserving unique features
  • 📖 Better Organization - File patterns, templates, and MODE definitions centralized

Files Refactored

File Reduction Details
analyze.md 48% 117→61 lines
chat.md 47% 118→62 lines
execute.md 44% 180→100 lines
codex-execute.md 2% 481→473 lines (preserved unique workflow)
mode/bug-index.md 48% 144→75 lines
mode/code-analysis.md 60% 188→76 lines
mode/plan.md 24% 100→76 lines

Removed Duplicate Sections

All CLI commands previously contained these duplicate sections, now centralized in intelligent-tools-strategy.md:

  • Universal Command Template
  • File Pattern Reference
  • Complex Pattern Discovery
  • MODE Field Definition
  • Enhancement Integration details
  • Session Persistence details

Preserved Unique Content

Each command retains its unique capabilities:

  • Command-specific purpose and parameters
  • Unique execution flows and capabilities
  • Specialized features (YOLO permissions, task decomposition, resume patterns)
  • Command-specific examples and workflows
  • File pattern auto-detection logic for analyze command
  • Group-based execution workflow for codex-execute command

Technical Details

Single Source of Truth Pattern:

All CLI commands now reference intelligent-tools-strategy.md for:

  • Universal command template structure
  • File pattern syntax and examples
  • Complex pattern discovery workflows
  • MODE field definitions and permissions
  • Tool-specific features and capabilities

Reference Pattern:

## Notes
- Command templates and file patterns: see intelligent-tools-strategy.md (loaded in memory)

This approach ensures documentation consistency across all CLI commands while reducing maintenance burden.

Installation

Windows (PowerShell):

Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1" -UseBasicParsing).Content

Linux/macOS (Bash/Zsh):

bash <(curl -fsSL https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.sh)

Full Changelog

See CHANGELOG.md for complete details.

Previous Release: v3.4.1 - Multi-Tool Support for Documentation Updates

Assets 2
Loading