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-03-01 15:03:57 +08:00 · 2026-02-28 16:14:09 +08:00
parent ab65caec45
commit c3ddf7e322
136 changed files with 34486 additions and 0 deletions
--- a/docs/guide/installation.md
+++ b/docs/guide/installation.md
@@ -0,0 +1,146 @@
+# 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)
+
+```bash
+npm install -g @ccw/cli
+```
+
+### Project-Specific Installation
+
+```bash
+# In your project directory
+npm install --save-dev @ccw/cli
+
+# Run with npx
+npx ccw [command]
+```
+
+### Using Yarn
+
+```bash
+# Global
+yarn global add @ccw/cli
+
+# Project-specific
+yarn add -D @ccw/cli
+```
+
+## Verify Installation
+
+```bash
+ccw --version
+# Output: CCW v1.0.0
+
+ccw --help
+# Shows all available commands
+```
+
+## Configuration
+
+### CLI Tools Configuration
+
+Create or edit `~/.claude/cli-tools.json`:
+
+```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:
+
+```markdown
+# 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
+
+```bash
+# Update to the latest version
+npm update -g @ccw/cli
+
+# Or install a specific version
+npm install -g @ccw/cli@latest
+```
+
+## Uninstallation
+
+```bash
+npm uninstall -g @ccw/cli
+
+# Remove configuration (optional)
+rm -rf ~/.claude
+```
+
+## Troubleshooting
+
+### Permission Issues
+
+If you encounter permission errors:
+
+```bash
+# 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:
+
+```bash
+# 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](./first-workflow.md) guide.
+:::