Files
CC-Switch/docs/user-manual/en/1-getting-started/1.2-installation.md
T
Jason 44b6eacf87 feat(ci): add macOS code signing and Apple notarization to release workflow
- Import Developer ID Application certificate into temporary keychain
- Inject APPLE_SIGNING_IDENTITY/APPLE_ID/APPLE_PASSWORD/APPLE_TEAM_ID
  into Tauri build step for automatic signing and notarization
- Staple notarization tickets to both .app and .dmg (hard-fail)
- Add verification step: codesign --verify + spctl -a + stapler validate
  for both .app and .dmg, gating the release on success
- Collect .dmg alongside .tar.gz and .zip in release assets
- Clean up temporary keychain with original default restored
- Update release notes to recommend .dmg and note Apple notarization
- Remove all xattr workarounds and "unidentified developer" warnings
  from README, README_ZH, installation guides, and FAQ (EN/ZH/JA)
2026-03-23 22:43:41 +08:00

218 lines
3.6 KiB
Markdown

# 1.2 Installation Guide
## Prerequisites
### Install Node.js
The CLI tools managed by CC Switch (Claude Code, Codex, Gemini CLI) require a Node.js environment.
**Recommended version**: Node.js 18 LTS or higher
#### Windows
1. Visit the [Node.js official website](https://nodejs.org/)
2. Download the LTS version installer
3. Run the installer and follow the prompts
4. Verify installation:
```bash
node --version
npm --version
```
#### macOS
```bash
# Install with Homebrew
brew install node
# Or use nvm (recommended)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
nvm install --lts
```
#### Linux
```bash
# Ubuntu/Debian
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt-get install -y nodejs
# Or use nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
nvm install --lts
```
### Install CLI Tools
#### Claude Code
**Option 1: Homebrew (recommended for macOS)**
```bash
brew install claude-code
```
**Option 2: npm**
```bash
npm install -g @anthropic-ai/claude-code
```
#### Codex
**Option 1: Homebrew (recommended for macOS)**
```bash
brew install codex
```
**Option 2: npm**
```bash
npm install -g @openai/codex
```
#### Gemini CLI
**Option 1: Homebrew (recommended for macOS)**
```bash
brew install gemini-cli
```
**Option 2: npm**
```bash
npm install -g @google/gemini-cli
```
---
## Windows
### Installer
1. Visit the [Releases page](https://github.com/farion1231/cc-switch/releases)
2. Download `CC-Switch-v{version}-Windows.msi`
3. Double-click to run the installer
4. Follow the prompts to complete installation
### Portable Version (No Installation Required)
1. Download `CC-Switch-v{version}-Windows-Portable.zip`
2. Extract to any directory
3. Run `CC-Switch.exe`
## macOS
### Option 1: Homebrew (Recommended)
```bash
# Add tap
brew tap farion1231/ccswitch
# Install
brew install --cask cc-switch
```
Update to the latest version:
```bash
brew upgrade --cask cc-switch
```
### Option 2: Manual Download
1. Download `CC-Switch-v{version}-macOS.zip`
2. Extract to get `CC Switch.app`
3. Drag it to the Applications folder
### Signed and Notarized
CC Switch for macOS is signed and notarized by Apple. You can install and open it directly — no extra steps needed.
## Linux
### ArchLinux
Install using an AUR helper:
```bash
# Using paru
paru -S cc-switch-bin
# Or using yay
yay -S cc-switch-bin
```
### Debian / Ubuntu
1. Download `CC-Switch-v{version}-Linux.deb`
2. Install:
```bash
sudo dpkg -i CC-Switch-v{version}-Linux.deb
# If there are dependency issues
sudo apt-get install -f
```
### AppImage (Universal)
1. Download `CC-Switch-v{version}-Linux.AppImage`
2. Add execute permission:
```bash
chmod +x CC-Switch-v{version}-Linux.AppImage
```
3. Run:
```bash
./CC-Switch-v{version}-Linux.AppImage
```
## Verify Installation
After installation, launch CC Switch:
1. The app window displays correctly
2. A CC Switch icon appears in the system tray
3. You can switch between Claude / Codex / Gemini apps
## Auto Update
CC Switch includes built-in auto-update functionality:
- Automatically checks for updates on startup
- Displays an update prompt in the UI when a new version is available
- Click to download and install
You can also manually check for updates in "Settings > About".
## Uninstall
### Windows
- Uninstall via "Settings > Apps"
- Or run the uninstaller in the installation directory
### macOS
- Move `CC Switch.app` to Trash
- Optional: Delete the configuration directory `~/.cc-switch/`
### Linux
```bash
# Debian/Ubuntu
sudo apt remove cc-switch
# ArchLinux
paru -R cc-switch-bin
```