mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-06 01:54:11 +08:00
b906ce8715
- Add prerequisites section referencing official Gemini CLI repository - Add essential configuration section showing proper settings.json setup - Emphasize importance of "contextFileName": "CLAUDE.md" setting - Update both English and Chinese README files - Fix filename references from "Claude.md" to "CLAUDE.md" in install docs - Improve user onboarding with proper configuration guidance 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
233 lines
7.2 KiB
Markdown
233 lines
7.2 KiB
Markdown
# Claude Code Workflow (CCW) - Installation Guide
|
|
|
|
**English** | [中文](INSTALL_CN.md)
|
|
|
|
Interactive installation guide for Claude Code with Agent workflow coordination and distributed memory system.
|
|
|
|
## ⚡ One-Line Remote Installation (Recommended)
|
|
|
|
### All Platforms - Remote PowerShell Installation
|
|
```powershell
|
|
# Interactive remote installation from feature branch (latest)
|
|
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Dmsflow/main/install-remote.ps1)
|
|
|
|
# Global installation with unified file output system
|
|
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Dmsflow/main/install-remote.ps1) -Global
|
|
|
|
# Force overwrite (non-interactive) - includes all new workflow file generation features
|
|
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Dmsflow/main/install-remote.ps1) -Force -NonInteractive
|
|
|
|
# One-click backup all existing files (no confirmations needed)
|
|
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Dmsflow/main/install-remote.ps1) -BackupAll
|
|
```
|
|
|
|
**What the remote installer does:**
|
|
- ✅ Checks system requirements (PowerShell version, network connectivity)
|
|
- ✅ Downloads latest version from GitHub (main branch)
|
|
- ✅ Includes all new unified file output system features
|
|
- ✅ Automatically extracts and runs local installer
|
|
- ✅ Security confirmation and user prompts
|
|
- ✅ Automatic cleanup of temporary files
|
|
- ✅ Sets up .workflow/ directory structure for session management
|
|
|
|
**Note**: Interface is in English for cross-platform compatibility
|
|
|
|
## 📂 Local Installation
|
|
|
|
### All Platforms (PowerShell)
|
|
```powershell
|
|
# Clone the repository with latest features
|
|
git clone -b main https://github.com/catlog22/Claude-CCW.git
|
|
cd Dmsflow
|
|
|
|
# Windows PowerShell 5.1+ or PowerShell Core (Global installation only)
|
|
.\Install-Claude.ps1
|
|
|
|
# Linux/macOS PowerShell Core (Global installation only)
|
|
pwsh ./Install-Claude.ps1
|
|
```
|
|
|
|
**Note**: The feature branch contains all the latest unified file output system enhancements and should be used for new installations.
|
|
|
|
## Installation Options
|
|
|
|
### Remote Installation Parameters
|
|
|
|
All parameters can be passed to the remote installer:
|
|
|
|
```powershell
|
|
# Global installation
|
|
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Dmsflow/main/install-remote.ps1) -Global
|
|
|
|
# Install to specific directory
|
|
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Dmsflow/main/install-remote.ps1) -Directory "C:\MyProject"
|
|
|
|
# Force overwrite without prompts
|
|
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Dmsflow/main/install-remote.ps1) -Force -NonInteractive
|
|
|
|
# Install from specific branch
|
|
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Dmsflow/main/install-remote.ps1) -Branch "dev"
|
|
|
|
# Skip backups (overwrite without backup - not recommended)
|
|
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Dmsflow/main/install-remote.ps1) -NoBackup
|
|
|
|
# Explicit automatic backup all existing files (default behavior since v1.1.0)
|
|
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Dmsflow/main/install-remote.ps1) -BackupAll
|
|
```
|
|
|
|
### Local Installation Options
|
|
|
|
### Global Installation (Default and Only Mode)
|
|
Install to user home directory (`~/.claude`):
|
|
```powershell
|
|
# All platforms - Global installation (default)
|
|
.\Install-Claude.ps1
|
|
|
|
# With automatic backup (default since v1.1.0)
|
|
.\Install-Claude.ps1 -BackupAll
|
|
|
|
# Disable automatic backup (not recommended)
|
|
.\Install-Claude.ps1 -NoBackup
|
|
|
|
# Non-interactive mode for automation
|
|
.\Install-Claude.ps1 -Force -NonInteractive
|
|
```
|
|
|
|
**Global installation structure:**
|
|
```
|
|
~/.claude/
|
|
├── agents/
|
|
├── commands/
|
|
├── output-styles/
|
|
├── settings.local.json
|
|
└── CLAUDE.md
|
|
```
|
|
|
|
**Note**: Starting from v1.2.0, only global installation is supported. Local directory and custom path installations have been removed to simplify the installation process and ensure consistent behavior across all platforms.
|
|
|
|
## Advanced Options
|
|
|
|
### 🛡️ Enhanced Backup Features (v1.1.0+)
|
|
|
|
The installer now includes **automatic backup as the default behavior** to protect your existing files:
|
|
|
|
**Backup Modes:**
|
|
- **Automatic Backup** (default since v1.1.0): Automatically backs up all existing files without prompts
|
|
- **Explicit Backup** (`-BackupAll`): Same as default behavior, explicitly specified for compatibility
|
|
- **No Backup** (`-NoBackup`): Disable backup functionality (not recommended)
|
|
|
|
**Backup Organization:**
|
|
- Creates timestamped backup folders (e.g., `claude-backup-20240117-143022`)
|
|
- Preserves directory structure within backup folders
|
|
- Maintains file relationships and paths
|
|
|
|
### Force Installation
|
|
Overwrite existing files:
|
|
```powershell
|
|
.\Install-Claude.ps1 -Force
|
|
```
|
|
|
|
### One-Click Backup
|
|
Automatically backup all existing files without confirmations:
|
|
```powershell
|
|
.\Install-Claude.ps1 -BackupAll
|
|
```
|
|
|
|
### Skip Backups
|
|
Don't create backup files:
|
|
```powershell
|
|
.\Install-Claude.ps1 -NoBackup
|
|
```
|
|
|
|
### Uninstall
|
|
Remove installation:
|
|
```powershell
|
|
.\Install-Claude.ps1 -Uninstall -Force
|
|
```
|
|
|
|
## Platform Requirements
|
|
|
|
### PowerShell (Recommended)
|
|
- **Windows**: PowerShell 5.1+ or PowerShell Core 6+
|
|
- **Linux**: PowerShell Core 6+
|
|
- **macOS**: PowerShell Core 6+
|
|
|
|
Install PowerShell Core:
|
|
- **Ubuntu/Debian**: `sudo apt install powershell`
|
|
- **CentOS/RHEL**: `sudo dnf install powershell`
|
|
- **macOS**: `brew install powershell`
|
|
- **Or download**: https://github.com/PowerShell/PowerShell
|
|
|
|
|
|
## Complete Installation Examples
|
|
|
|
### ⚡ Super Quick (One-Liner)
|
|
```powershell
|
|
# Complete installation in one command
|
|
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Dmsflow/main/install-remote.ps1) -Global
|
|
|
|
# Done! 🎉
|
|
# Start using Claude Code with Agent workflows!
|
|
```
|
|
|
|
### 📂 Manual Installation Method
|
|
```powershell
|
|
# Manual installation steps:
|
|
# 1. Install PowerShell Core (if needed)
|
|
# Windows: Download from GitHub
|
|
# Linux: sudo apt install powershell
|
|
# macOS: brew install powershell
|
|
|
|
# 2. Download Claude Code Workflow System
|
|
git clone https://github.com/catlog22/Claude-CCW.git
|
|
cd Dmsflow
|
|
|
|
# 3. Install globally (interactive)
|
|
.\Install-Claude.ps1 -Global
|
|
|
|
# 4. Start using Claude Code with Agent workflows!
|
|
# Use /workflow commands and DMS system for development
|
|
```
|
|
|
|
## Verification
|
|
|
|
After installation, verify:
|
|
|
|
1. **Check installation:**
|
|
```bash
|
|
# Global
|
|
ls ~/.claude
|
|
|
|
# Local
|
|
ls ./.claude
|
|
```
|
|
|
|
2. **Test Claude Code:**
|
|
- Open Claude Code in your project
|
|
- Check that global `.claude` directory is recognized
|
|
- Verify workflow commands and DMS commands are available
|
|
- Test `/workflow` commands for agent coordination
|
|
- Test `/dmsflow version` to check version information
|
|
|
|
## Troubleshooting
|
|
|
|
### PowerShell Execution Policy
|
|
If you get execution policy errors:
|
|
```powershell
|
|
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
|
|
```
|
|
|
|
### Workflow Commands Not Working
|
|
- Ensure `.claude` directory exists in your project
|
|
- Verify workflow.md and agent files are properly installed
|
|
- Check that Claude Code recognizes the configuration
|
|
|
|
### Permission Errors
|
|
- **Windows**: Run as Administrator
|
|
- **Linux/macOS**: Use `sudo` if needed for global PowerShell installation
|
|
|
|
## Support
|
|
|
|
- **Issues**: [GitHub Issues](https://github.com/catlog22/Claude-CCW/issues)
|
|
- **Documentation**: [Main README](README.md)
|
|
- **Workflow Documentation**: [.claude/commands/workflow.md](.claude/commands/workflow.md) |