From f3c1061d1ec18c2acfb7c8b090a9344459d052b2 Mon Sep 17 00:00:00 2001 From: catlog22 Date: Wed, 1 Oct 2025 22:27:39 +0800 Subject: [PATCH] docs: Add comprehensive installation documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add detailed installation section with both remote and local options - Document all four installation scripts (ps1/sh for remote/local) - Add installation scripts overview table - Clarify platform-specific requirements - Add verification steps - Highlight native support without cross-platform dependencies 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude --- README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++--- README_CN.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++--- 2 files changed, 92 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0df47327..dad4ccda 100644 --- a/README.md +++ b/README.md @@ -15,23 +15,66 @@ ## ⚙️ Installation -### 🚀 **Quick Installation via Shell** +### 🚀 **Quick One-Line Installation** -**For PowerShell (Windows):** +CCW provides native installation scripts for all platforms - no cross-platform dependencies required! + +**Windows (PowerShell):** ```powershell Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1" -UseBasicParsing).Content ``` -**For Bash/Zsh (Linux/macOS):** +**Linux/macOS (Bash/Zsh):** ```bash bash <(curl -fsSL https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.sh) ``` +### 📦 **Local Installation from Cloned Repository** + +If you prefer to review the code before installation: + +**1. Clone the repository:** +```bash +git clone https://github.com/catlog22/Claude-Code-Workflow.git +cd Claude-Code-Workflow +``` + +**2. Run the local installer:** + +**Windows:** +```powershell +.\Install-Claude.ps1 +``` + +**Linux/macOS:** +```bash +chmod +x Install-Claude.sh +./Install-Claude.sh +``` + ### ✅ **Verify Installation** + +After installation, verify CCW is working: ```bash /workflow:session:list ``` +### 📋 **Installation Scripts Overview** + +| Script | Platform | Purpose | +|--------|----------|---------| +| `install-remote.ps1` | Windows | One-line remote installation via PowerShell | +| `install-remote.sh` | Linux/macOS | One-line remote installation via Bash | +| `Install-Claude.ps1` | Windows | Local interactive installer with GUI menu | +| `Install-Claude.sh` | Linux/macOS | Local interactive installer with colored menu | + +**All installers support:** +- ✅ Interactive mode with arrow-key navigation (Windows) or numbered menu (Linux/macOS) +- ✅ Automatic backup of existing files (enabled by default) +- ✅ Global installation to `~/.claude/` or custom path +- ✅ Non-interactive mode for automation +- ✅ Force mode to skip confirmations + --- ## 📋 Overview diff --git a/README_CN.md b/README_CN.md index e2b56833..0223f29c 100644 --- a/README_CN.md +++ b/README_CN.md @@ -15,23 +15,66 @@ ## ⚙️ 安装 -### 🚀 **通过 Shell 快速安装** +### 🚀 **一键快速安装** -**PowerShell (Windows):** +CCW 为所有平台提供原生安装脚本 - 无需跨平台依赖! + +**Windows (PowerShell):** ```powershell Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1" -UseBasicParsing).Content ``` -**Bash/Zsh (Linux/macOS):** +**Linux/macOS (Bash/Zsh):** ```bash bash <(curl -fsSL https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.sh) ``` +### 📦 **从克隆仓库本地安装** + +如果您希望在安装前审查代码: + +**1. 克隆仓库:** +```bash +git clone https://github.com/catlog22/Claude-Code-Workflow.git +cd Claude-Code-Workflow +``` + +**2. 运行本地安装器:** + +**Windows:** +```powershell +.\Install-Claude.ps1 +``` + +**Linux/macOS:** +```bash +chmod +x Install-Claude.sh +./Install-Claude.sh +``` + ### ✅ **验证安装** + +安装完成后,验证 CCW 是否正常工作: ```bash /workflow:session:list ``` +### 📋 **安装脚本概览** + +| 脚本 | 平台 | 用途 | +|------|------|------| +| `install-remote.ps1` | Windows | 通过 PowerShell 一键远程安装 | +| `install-remote.sh` | Linux/macOS | 通过 Bash 一键远程安装 | +| `Install-Claude.ps1` | Windows | 带 GUI 菜单的本地交互式安装器 | +| `Install-Claude.sh` | Linux/macOS | 带彩色菜单的本地交互式安装器 | + +**所有安装器都支持:** +- ✅ 交互模式:箭头键导航 (Windows) 或数字菜单 (Linux/macOS) +- ✅ 自动备份现有文件(默认启用) +- ✅ 全局安装到 `~/.claude/` 或自定义路径 +- ✅ 非交互模式用于自动化 +- ✅ 强制模式跳过确认提示 + --- ## 📋 概述