mirror of https://github.com/catlog22/Claude-Code-Workflow.git synced 2026-03-01 15:03:57 +08:00

Files

catlog22 c3ddf7e322 docs: add VitePress documentation site

- Add docs directory with VitePress configuration
- Add GitHub Actions workflow for docs build and deploy
- Support bilingual (English/Chinese) documentation
- Include search, custom theme, and responsive design

2026-02-28 16:14:09 +08:00

2.3 KiB

Raw Blame History

Installation

Learn how to install and configure CCW on your system.

Prerequisites

Before installing CCW, make sure you have:

Node.js >= 18.0.0
npm >= 9.0.0 or yarn >= 1.22.0
Git for version control features

Install CCW

Global Installation (Recommended)

npm install -g @ccw/cli

Project-Specific Installation

# In your project directory
npm install --save-dev @ccw/cli

# Run with npx
npx ccw [command]

Using Yarn

# Global
yarn global add @ccw/cli

# Project-specific
yarn add -D @ccw/cli

Verify Installation

ccw --version
# Output: CCW v1.0.0

ccw --help
# Shows all available commands

Configuration

CLI Tools Configuration

Create or edit ~/.claude/cli-tools.json:

{
  "version": "3.3.0",
  "tools": {
    "gemini": {
      "enabled": true,
      "primaryModel": "gemini-2.5-flash",
      "secondaryModel": "gemini-2.5-flash",
      "tags": ["analysis", "debug"],
      "type": "builtin"
    },
    "codex": {
      "enabled": true,
      "primaryModel": "gpt-5.2",
      "secondaryModel": "gpt-5.2",
      "tags": [],
      "type": "builtin"
    }
  }
}

CLAUDE.md Instructions

Create CLAUDE.md in your project root:

# Project Instructions

## Coding Standards
- Use TypeScript for type safety
- Follow ESLint configuration
- Write tests for all new features

## Architecture
- Frontend: Vue 3 + Vite
- Backend: Node.js + Express
- Database: PostgreSQL

Updating CCW

# Update to the latest version
npm update -g @ccw/cli

# Or install a specific version
npm install -g @ccw/cli@latest

Uninstallation

npm uninstall -g @ccw/cli

# Remove configuration (optional)
rm -rf ~/.claude

Troubleshooting

Permission Issues

If you encounter permission errors:

# Use sudo (not recommended)
sudo npm install -g @ccw/cli

# Or fix npm permissions (recommended)
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
export PATH=~/.npm-global/bin:$PATH

PATH Issues

Add npm global bin to your PATH:

# For bash/zsh
echo 'export PATH=$(npm config get prefix)/bin:$PATH' >> ~/.bashrc

# For fish
echo 'set -gx PATH (npm config get prefix)/bin $PATH' >> ~/.config/fish/config.fish

::: info Next Steps After installation, check out the First Workflow guide. :::

2.3 KiB Raw Blame History