選擇產品
選擇操作系統
🔑
第一步:獲取你的 API 密鑰

在開始配置之前,你需要先獲取 API 密鑰(sk-xxx):

1. 打開 new.your-agent.cc 並註冊賬號

2. 登錄後進入「控制檯」→「令牌」→「新建令牌」

3. 選擇分組(如 claude-antigravity),點擊提交

4. 複製生成的令牌(sk-xxxxxxxx),這就是你的密鑰

5. 告訴管理員你的賬戶名稱

API 地址: https://new.your-agent.cc
查看用量和日誌:登錄後臺 → 控制檯
!
推薦使用 WSL 或 Git Bash

Claude Code 在 Windows 上推薦使用 WSL(Windows Subsystem for Linux)安裝和運行,兼容性最好。如果不想裝 WSL,至少使用 Git Bash 來運行 Claude Code。

PowerShell 兼容性較差,可能遇到文件鎖定、寫入失敗(error write file)等問題。遇到問題多問 AI!

!
推薦使用 Windows Terminal

Windows Terminal 是微軟官方的現代化終端工具,支持多標籤頁、更好的字符渲染、emoji 和中文顯示。強烈建議用它替代自帶的 cmd 和 PowerShell 窗口。

Microsoft Store 下載 GitHub 下載
Windows Terminal
0
前置要求:安裝 Git

Claude Code 依賴 Git 運行。如果啓動時看到以下錯誤,說明需要先安裝 Git:

Claude Code on Windows requires git-bash (https://git-scm.com/downloads/win). If installed but not in PATH, set environment variable pointing to your bash.exe, similar to: CLAUDE_CODE_GIT_BASH_PATH=C:\Program Files\Git\bin\bash.exe
下載 Git for Windows 國內加速下載

安裝時保持默認選項即可。安裝完成後重啓終端,驗證安裝:

git --version
Git 已安裝但提示找不到?點擊一鍵自動檢測

如果 Git 已安裝但啓動時提示需要設置 CLAUDE_CODE_GIT_BASH_PATH,在 PowerShell(管理員)中執行以下命令自動檢測並設置:

按 Win+X → 選擇「終端管理員」或「PowerShell(管理員)」

$p=@("$env:ProgramFiles\Git\bin\bash.exe","${env:ProgramFiles(x86)}\Git\bin\bash.exe","$env:LOCALAPPDATA\Programs\Git\bin\bash.exe","C:\Git\bin\bash.exe");$f=$p|?{Test-Path $_}|Select -First 1;if($f){[Environment]::SetEnvironmentVariable("CLAUDE_CODE_GIT_BASH_PATH",$f,"Machine");"已設置: $f"}else{"未找到 Git"}
🖥️ 必須用 PowerShell 或 Windows Terminal!cmd 是上古遺物,用它必出問題!

手動查找 Git 安裝位置:

where.exe git

Git 版本要求:Git 2.24.0 及更早版本的 cygpath.exe 無法正確處理中文路徑,會導致 Claude Code 在中文目錄下報錯。建議升級到 Git 2.40+

winget upgrade Git.Git
1
安裝 Claude Code(原生安裝 - 推薦)

官方推薦的原生安裝方式,無需 Node.js,自動後臺更新,始終保持最新版本。

優點:

  • 無需安裝 Node.js 18+
  • 自動後臺更新,始終保持最新版本
  • 避免 npm 權限問題

PowerShell 安裝:

irm https://claude.ai/install.ps1 | iex
中國大陸用戶網絡問題?

如遇網絡問題,可設置代理後安裝:

# 設置代理 $env:https_proxy = "http://your-proxy:port" irm https://claude.ai/install.ps1 | iex

或使用 npm 鏡像安裝(需先安裝 Node.js):

npm install -g @anthropic-ai/claude-code --registry=https://registry.npmmirror.com
WinGet 安裝(Windows)
winget install Anthropic.ClaudeCode

WinGet 安裝不會自動更新,需定期運行 winget upgrade Anthropic.ClaudeCode

npm 安裝(備選) 已被官方標記爲棄用

需要 Node.js 18+,適合網絡受限用戶使用國內鏡像

安裝 Node.js

方法一:官網下載(推薦)

打開 https://nodejs.org/,下載 LTS 版本,雙擊安裝。

方法二:nvm-windows(多版本管理)

下載 nvm-setup.exe 從 GitHub Releases

國內加速下載:https://static.yoouu.cn/nvm-setup.exe

nvm install lts nvm use lts

方法三:包管理器

# Chocolatey choco install nodejs # Scoop scoop install nodejs # WinGet winget install OpenJS.NodeJS.LTS

驗證安裝:

node --version npm --version

全局安裝:

npm install -g @anthropic-ai/claude-code # 國內鏡像(下載慢可用) npm install -g @anthropic-ai/claude-code --registry=https://registry.npmmirror.com
安裝特定版本

安裝穩定版(約延遲一週,跳過重大問題):

& ([scriptblock]::Create((irm https://claude.ai/install.ps1))) stable

安裝指定版本號:

& ([scriptblock]::Create((irm https://claude.ai/install.ps1))) 1.0.58
從 npm 遷移到原生安裝

如果你之前使用 npm 安裝,可以運行遷移命令:

claude install

系統會自動處理遷移,然後驗證安裝:

claude --version

驗證安裝:

claude --version
提示 .local\bin 不在 PATH 中?

原生安裝後如果提示路徑不在 PATH 中,在 PowerShell(管理員)中執行:

$p="$env:USERPROFILE\.local\bin"; if([Environment]::GetEnvironmentVariable("Path","Machine") -notlike "*$p*"){[Environment]::SetEnvironmentVariable("Path",[Environment]::GetEnvironmentVariable("Path","Machine")+";$p","Machine"); "已添加 - 請重啓終端生效"}else{"已存在,無需操作"}
2
配置環境變量

這是最關鍵的一步!需要配置 API 代理地址和密鑰。將 sk-xxx 替換爲你的密鑰

之前用過其他中轉服務?先清理舊配置

settings.json 中的 env 優先級高於系統環境變量,需先清理。

檢查配置文件:

type $env:USERPROFILE\.claude\settings.json

檢查環境變量:

Get-ChildItem Env:ANTHROPIC_*

清理用戶級環境變量:

[System.Environment]::SetEnvironmentVariable('ANTHROPIC_AUTH_TOKEN', $null, 'User') [System.Environment]::SetEnvironmentVariable('ANTHROPIC_BASE_URL', $null, 'User')

清理系統級環境變量(需管理員):

[System.Environment]::SetEnvironmentVariable('ANTHROPIC_AUTH_TOKEN', $null, 'Machine') [System.Environment]::SetEnvironmentVariable('ANTHROPIC_BASE_URL', $null, 'Machine')

如果 settings.json 中有 env 包含 ANTHROPIC_BASE_URL,需刪除或修改

永久設置(系統級別,需管理員權限):

按 Win+X → 選擇「終端管理員」或「PowerShell(管理員)」

[System.Environment]::SetEnvironmentVariable("ANTHROPIC_BASE_URL", "https://new.your-agent.cc", [System.EnvironmentVariableTarget]::Machine) [System.Environment]::SetEnvironmentVariable("ANTHROPIC_AUTH_TOKEN", "sk-xxx你的密鑰xxx", [System.EnvironmentVariableTarget]::Machine) [System.Environment]::SetEnvironmentVariable("API_TIMEOUT_MS", "3000000", [System.EnvironmentVariableTarget]::Machine) [System.Environment]::SetEnvironmentVariable("CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC", "1", [System.EnvironmentVariableTarget]::Machine)

設置後需重新打開終端生效

驗證環境變量:

Get-ChildItem Env:ANTHROPIC_*
不再使用?刪除環境變量

清理用戶級環境變量:

[System.Environment]::SetEnvironmentVariable("ANTHROPIC_BASE_URL", $null, [System.EnvironmentVariableTarget]::User) [System.Environment]::SetEnvironmentVariable("ANTHROPIC_AUTH_TOKEN", $null, [System.EnvironmentVariableTarget]::User) [System.Environment]::SetEnvironmentVariable("API_TIMEOUT_MS", $null, [System.EnvironmentVariableTarget]::User) [System.Environment]::SetEnvironmentVariable("CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC", $null, [System.EnvironmentVariableTarget]::User)

清理系統級環境變量(需管理員):

[System.Environment]::SetEnvironmentVariable("ANTHROPIC_BASE_URL", $null, [System.EnvironmentVariableTarget]::Machine) [System.Environment]::SetEnvironmentVariable("ANTHROPIC_AUTH_TOKEN", $null, [System.EnvironmentVariableTarget]::Machine) [System.Environment]::SetEnvironmentVariable("API_TIMEOUT_MS", $null, [System.EnvironmentVariableTarget]::Machine) [System.Environment]::SetEnvironmentVariable("CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC", $null, [System.EnvironmentVariableTarget]::Machine)

驗證是否刪除成功:

Get-ChildItem Env:ANTHROPIC_*
3
啓動 Claude Code

在項目目錄下運行:

# 進入項目目錄 cd C:\path\to\your\project # 啓動 claude

首次啓動會進行初始化,稍等片刻即可開始使用。

!
macOS 用戶須知

macOS 默認使用 zsh 作爲終端 shell。如果你使用的是較舊版本的 macOS,可能默認是 bash。可以通過 echo $SHELL 查看當前使用的 shell。

推薦使用 iTerm2 或系統自帶的「終端」應用來運行 Claude Code,體驗更佳。

1
安裝 Claude Code(原生安裝 - 推薦)

官方推薦的原生安裝方式,無需 Node.js,自動後臺更新,始終保持最新版本。

優點:

  • 無需安裝 Node.js 18+
  • 自動後臺更新,始終保持最新版本
  • 避免 npm 權限問題

終端安裝:

curl -fsSL https://claude.ai/install.sh | sh
中國大陸用戶網絡問題?

如遇網絡問題,可設置代理後安裝:

# 設置代理 export https_proxy=http://your-proxy:port curl -fsSL https://claude.ai/install.sh | sh

或使用 npm 鏡像安裝(需先安裝 Node.js):

npm install -g @anthropic-ai/claude-code --registry=https://registry.npmmirror.com
Homebrew 安裝
brew install claude-code

Homebrew 安裝可能不會自動更新,建議定期運行 brew upgrade claude-code

npm 安裝(備選) 已被官方標記爲棄用

需要 Node.js 18+,適合網絡受限用戶使用國內鏡像

安裝 Node.js

方法一:官網下載(推薦)

打開 https://nodejs.org/,下載 LTS 版本,雙擊安裝。

方法二:Homebrew 安裝

brew install node

方法三:nvm(多版本管理)

# 安裝 nvm curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash # 重新加載配置 source ~/.zshrc # 安裝 Node.js LTS 版本 nvm install --lts

驗證安裝:

node --version npm --version

全局安裝:

npm install -g @anthropic-ai/claude-code # 國內鏡像(下載慢可用) npm install -g @anthropic-ai/claude-code --registry=https://registry.npmmirror.com
安裝特定版本

安裝穩定版(約延遲一週,跳過重大問題):

curl -fsSL https://claude.ai/install.sh | sh -s -- stable

安裝指定版本號:

curl -fsSL https://claude.ai/install.sh | sh -s -- 1.0.58
從 npm 遷移到原生安裝

如果你之前使用 npm 安裝,可以運行遷移命令:

claude install

系統會自動處理遷移,然後驗證安裝:

claude --version

驗證安裝:

claude --version
提示 .local/bin 不在 PATH 中?

原生安裝後如果提示路徑不在 PATH 中,需要手動添加。編輯 ~/.zshrc(或 ~/.bash_profile):

nano ~/.zshrc

在文件末尾添加:

export PATH="$HOME/.local/bin:$PATH"

保存後運行 source ~/.zshrc 或重啓終端生效。

2
配置環境變量

這是最關鍵的一步!需要配置 API 代理地址和密鑰。將 sk-xxx 替換爲你的密鑰

之前用過其他中轉服務?先清理舊配置

settings.json 中的 env 優先級高於系統環境變量,需先清理。

檢查配置文件:

cat ~/.claude/settings.json

檢查環境變量:

env | grep ANTHROPIC

清理環境變量(編輯 ~/.zshrc 或 ~/.bash_profile 刪除相關行):

nano ~/.zshrc

如果 settings.json 中有 env 包含 ANTHROPIC_BASE_URL,需刪除或修改

方法一:臨時設置(當前終端有效)

# 設置 API 代理地址 export ANTHROPIC_BASE_URL="https://new.your-agent.cc" # 設置你的 API Key export ANTHROPIC_AUTH_TOKEN="sk-xxx你的密鑰xxx"

方法二:永久配置(推薦)

根據你使用的 shell,編輯對應配置文件(macOS 默認是 zsh):

# 查看當前使用的 shell echo $SHELL # 編輯 ~/.zshrc(zsh)或 ~/.bash_profile(bash) nano ~/.zshrc

添加以下內容:

export ANTHROPIC_BASE_URL="https://new.your-agent.cc" export ANTHROPIC_AUTH_TOKEN="sk-xxx你的密鑰xxx" export API_TIMEOUT_MS="3000000" export CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC="1"

保存後運行 source ~/.zshrc 或重啓終端生效。

💡 nano 編輯器:Ctrl+O 保存,Ctrl+X 退出。也可以使用 vim 或其他編輯器。

驗證環境變量:

echo $ANTHROPIC_BASE_URL echo $ANTHROPIC_AUTH_TOKEN
不再使用?刪除環境變量

編輯 ~/.zshrc(或 ~/.bash_profile),刪除相關的 export 行:

nano ~/.zshrc

刪除以下行:

# 刪除這些行 export ANTHROPIC_BASE_URL="..." export ANTHROPIC_AUTH_TOKEN="..." export API_TIMEOUT_MS="..." export CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC="..."

保存後運行 source ~/.zshrc 或重啓終端生效。

驗證是否刪除成功:

env | grep ANTHROPIC
3
啓動 Claude Code

在項目目錄下運行:

# 進入項目目錄 cd /path/to/your/project # 啓動 claude

首次啓動會進行初始化,稍等片刻即可開始使用。

!
WSL 用戶請看這裏

如果你在 Windows 上使用 WSL,本教程同樣適用。WSL 是 Windows 上運行 Claude Code 的最佳方式,兼容性最好。

安裝 WSL:在 PowerShell(管理員)中運行:

wsl --install
1
安裝 Claude Code(原生安裝 - 推薦)

官方推薦的原生安裝方式,無需 Node.js,自動後臺更新,始終保持最新版本。

優點:

  • 無需安裝 Node.js 18+
  • 自動後臺更新,始終保持最新版本
  • 避免 npm 權限問題
curl -fsSL https://claude.ai/install.sh | sh
中國大陸用戶網絡問題?

如遇網絡問題,可設置代理後安裝:

# 設置代理 export https_proxy=http://your-proxy:port curl -fsSL https://claude.ai/install.sh | sh

或使用 npm 鏡像安裝(需先安裝 Node.js):

npm install -g @anthropic-ai/claude-code --registry=https://registry.npmmirror.com
npm 安裝(備選) 已被官方標記爲棄用

需要 Node.js 18+,適合網絡受限用戶使用國內鏡像

安裝 Node.js

Ubuntu / Debian:

# 添加 NodeSource 倉庫 curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash - # 安裝 Node.js sudo apt-get install -y nodejs

Fedora / RHEL:

sudo dnf install nodejs

Arch Linux:

sudo pacman -S nodejs npm

驗證安裝:

node --version npm --version

全局安裝:

npm install -g @anthropic-ai/claude-code # 國內鏡像(下載慢可用) npm install -g @anthropic-ai/claude-code --registry=https://registry.npmmirror.com
安裝特定版本

安裝穩定版(約延遲一週,跳過重大問題):

curl -fsSL https://claude.ai/install.sh | sh -s -- stable

安裝指定版本號:

curl -fsSL https://claude.ai/install.sh | sh -s -- 1.0.58

驗證安裝:

claude --version
2
配置環境變量

這是最關鍵的一步!需要配置 API 代理地址和密鑰。將 sk-xxx 替換爲你的密鑰

方法一:臨時設置(當前終端有效)

# 設置 API 代理地址 export ANTHROPIC_BASE_URL="https://new.your-agent.cc" # 設置你的 API Key export ANTHROPIC_AUTH_TOKEN="sk-xxx你的密鑰xxx"

方法二:永久配置(推薦)

編輯 ~/.bashrc~/.zshrc

nano ~/.bashrc

添加以下內容:

export ANTHROPIC_BASE_URL="https://new.your-agent.cc" export ANTHROPIC_AUTH_TOKEN="sk-xxx你的密鑰xxx" export API_TIMEOUT_MS="3000000" export CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC="1"

保存後運行 source ~/.bashrc 或重啓終端生效。

驗證環境變量:

echo $ANTHROPIC_BASE_URL echo $ANTHROPIC_AUTH_TOKEN
3
啓動 Claude Code

在項目目錄下運行:

# 進入項目目錄 cd /path/to/your/project # 啓動 claude

首次啓動會進行初始化,稍等片刻即可開始使用。

!
Codex 簡介

OpenAI Codex CLI 是 OpenAI 官方推出的命令行 AI 編程助手,類似於 Claude Code,但使用 OpenAI 的模型(如 GPT-4o、o1、o3 等)。

官方定價參考:https://openai.com/api/pricing

!
推薦使用 WSL 或 Git Bash

Codex 在 Windows 上推薦使用 WSL(Windows Subsystem for Linux)安裝和運行,兼容性最好。如果不想裝 WSL,至少使用 Git Bash 來運行 Codex。

PowerShell 兼容性較差,可能遇到文件鎖定、寫入失敗(error write file)等問題。遇到問題多問 AI!

!
推薦使用 Windows Terminal

Windows Terminal 是微軟官方的現代化終端工具,支持多標籤頁、更好的字符渲染、emoji 和中文顯示。強烈建議用它替代自帶的 cmd 和 PowerShell 窗口。

Microsoft Store 下載 GitHub 下載
Windows Terminal
0
前置要求:安裝 Node.js 22+

Codex 需要 Node.js 22+ 環境(注意:不是 18+,必須是 22 或更高版本)。

已安裝?運行 node --version 驗證版本號是否 >= 22。

安裝 Node.js 22+

方法一:官網下載(推薦)

打開 https://nodejs.org/,下載 Current 版本(22.x 或更高),雙擊安裝。

注意:LTS 版本可能是 20.x,請確認下載的是 22+ 版本

方法二:WinGet 安裝

# 安裝最新版 Node.js winget install OpenJS.NodeJS

方法三:nvm-windows(多版本管理,推薦)

下載 nvm-setup.exe 從 GitHub Releases

國內加速下載:https://static.yoouu.cn/nvm-setup.exe

# 安裝 Node.js 22 nvm install 22 nvm use 22

驗證安裝:

node --version npm --version

確保 node 版本號顯示 v22.x.x 或更高

1
安裝 Codex

使用 npm 全局安裝:

npm install -g @openai/codex # 國內鏡像(下載慢可用) npm install -g @openai/codex --registry=https://registry.npmmirror.com

如遇權限問題,以管理員身份運行 PowerShell

安裝特定版本

安裝指定版本號:

npm install -g @openai/codex@1.0.0

查看所有可用版本:

npm view @openai/codex versions

驗證安裝:

codex --version

顯示版本號說明安裝成功!

2
配置 Codex

Codex 使用配置文件進行設置。將 sk-xxx 替換爲你的密鑰

之前用過其他中轉服務?先清理舊配置

如果之前配置過其他 Codex 中轉服務,需要先清理舊配置,避免衝突。

檢查現有配置文件:

type $env:USERPROFILE\.codex\config.toml

檢查環境變量:

Get-ChildItem Env:*OAI* Get-ChildItem Env:OPENAI*

清理舊環境變量(如有):

[System.Environment]::SetEnvironmentVariable("CRS_OAI_KEY", $null, [System.EnvironmentVariableTarget]::Machine) [System.Environment]::SetEnvironmentVariable("OPENAI_BASE_URL", $null, [System.EnvironmentVariableTarget]::Machine)

步驟一:設置 API Key 環境變量

按 Win+X → 選擇「終端管理員」或「PowerShell(管理員)」

[System.Environment]::SetEnvironmentVariable("CRS_OAI_KEY", "sk-xxx你的密鑰xxx", [System.EnvironmentVariableTarget]::Machine)

設置後需重新打開終端生效

步驟二:創建配置文件

配置文件位置:%USERPROFILE%\.codex\config.toml

一鍵寫入命令(覆蓋現有配置)
mkdir $env:USERPROFILE\.codex -Force; @' model_provider = "crs" model = "gpt-5.3-codex" model_reasoning_effort = "high" disable_response_storage = true preferred_auth_method = "apikey" trusted_projects = ["C:\\", "D:\\"] trust_level = "trusted" [model_providers.crs] name = "crs" base_url = "https://new.your-agent.cc/v1" wire_api = "responses" requires_openai_auth = true env_key = "CRS_OAI_KEY" [features] experimental_windows_sandbox = true elevated_windows_sandbox = true unified_exec = true shell_snapshot = true powershell_utf8 = true steer = true [projects.'C:\Users'] trust_level = "trusted" '@ | Out-File -FilePath "$env:USERPROFILE\.codex\config.toml" -Encoding UTF8
步驟三:創建 auth.json(重要!)

Codex 還需要 auth.json 文件,用於禁用默認的 OpenAI 認證。

配置文件位置:%USERPROFILE%\.codex\auth.json

一鍵寫入命令:

@' { "CRS_OAI_KEY": null } '@ | Out-File -FilePath "$env:USERPROFILE\.codex\auth.json" -Encoding UTF8

或手動創建:

notepad $env:USERPROFILE\.codex\auth.json

粘貼以下內容:

{ "CRS_OAI_KEY": null }

說明:設置爲 null 是爲了禁用默認的 OpenAI 認證,讓 Codex 使用 config.toml 中配置的 env_key(CRS_OAI_KEY 環境變量)來獲取 API 密鑰

手動創建配置文件(已一鍵配置可跳過)

如果已經使用上面的一鍵寫入命令配置成功,可以跳過此步驟。

# 創建配置目錄 mkdir $env:USERPROFILE\.codex -Force # 用記事本打開配置文件 notepad $env:USERPROFILE\.codex\config.toml

粘貼以下配置內容:

model_provider = "crs" model = "gpt-5.3-codex" model_reasoning_effort = "high" disable_response_storage = true preferred_auth_method = "apikey" trusted_projects = ["C:\\\\", "D:\\\\"] trust_level = "trusted" [model_providers.crs] name = "crs" base_url = "https://new.your-agent.cc/v1" wire_api = "responses" requires_openai_auth = true env_key = "CRS_OAI_KEY" [features] experimental_windows_sandbox = true elevated_windows_sandbox = true unified_exec = true shell_snapshot = true powershell_utf8 = true steer = true [projects.'C:\\Users'] trust_level = "trusted"
驗證配置

檢查環境變量:

$env:CRS_OAI_KEY

查看配置文件:

type $env:USERPROFILE\.codex\config.toml
不再使用?刪除配置

刪除環境變量:

[System.Environment]::SetEnvironmentVariable("CRS_OAI_KEY", $null, [System.EnvironmentVariableTarget]::Machine)

刪除配置文件:

Remove-Item $env:USERPROFILE\.codex -Recurse -Force
3
啓動 Codex

在項目目錄下運行:

# 進入項目目錄 cd C:\path\to\your\project # 啓動 codex

首次啓動會進行初始化,稍等片刻即可開始使用。

常用啓動參數

指定模型:

codex --model gpt-4o

全自動模式(自動批准所有操作):

codex --full-auto

查看幫助:

codex --help
4
運行模式詳解

Codex 提供三種運行模式,根據你的需求選擇:

suggest 模式(默認,最安全)

默認模式,Codex 只會建議修改,不會自動執行任何操作。

codex # 或明確指定 codex --approval-mode suggest

適合:初次使用、重要項目、需要仔細審查每個操作

auto-edit 模式(自動編輯文件)

自動應用文件編輯,但執行命令前仍需確認。

codex --approval-mode auto-edit

適合:信任 AI 的代碼修改,但想控制命令執行

full-auto 模式(完全自動)

自動執行所有操作,包括文件編輯和命令執行。

codex --full-auto # 或 codex --approval-mode full-auto

注意:此模式下 Codex 會自動執行所有操作,請確保在安全環境中使用!

適合:測試項目、快速原型開發、有版本控制保護的項目

5
沙箱模式詳解

Codex 使用沙箱來限制命令執行的權限,保護你的系統安全:

read-only(只讀模式,默認)

只允許讀取文件,不能寫入或執行危險命令。

codex --sandbox read-only

最安全的模式,適合代碼審查和分析

workspace-write(工作區寫入)

允許在當前工作目錄內寫入文件,但不能訪問外部目錄。

codex --sandbox workspace-write

適合:日常開發,限制在項目目錄內操作

danger-full-access(完全訪問)

允許完全訪問文件系統和執行任意命令。

codex --sandbox danger-full-access

警告:此模式有安全風險,僅在完全信任的環境中使用!

6
配置文件

Codex 支持通過配置文件自定義默認行爲:

配置文件位置

Windows:

%USERPROFILE%\.codex\config.toml

macOS/Linux:

~/.codex/config.toml
配置文件示例
# ~/.codex/config.toml model_provider = "crs" model = "gpt-5.3-codex" model_reasoning_effort = "high" disable_response_storage = true preferred_auth_method = "apikey" [model_providers.crs] name = "crs" base_url = "https://new.your-agent.cc/v1" wire_api = "responses" requires_openai_auth = true env_key = "CRS_OAI_KEY" [features] steer = true
項目級配置(codex.md)

在項目根目錄創建 codex.md 文件,可以爲 Codex 提供項目上下文:

# codex.md 示例 # 項目說明 這是一個 React + TypeScript 項目。 # 代碼規範 - 使用 ESLint + Prettier - 組件使用函數式寫法 - 狀態管理使用 Zustand # 常用命令 - npm run dev: 啓動開發服務器 - npm run build: 構建生產版本 - npm run test: 運行測試
7
支持的模型

Codex 支持多種 OpenAI 模型:

# GPT-4o(推薦,性能最佳) codex --model gpt-4o # GPT-4o-mini(更快更便宜) codex --model gpt-4o-mini # o1 系列(推理能力更強) codex --model o1 codex --model o1-mini codex --model o1-pro # o3 系列(最新) codex --model o3-mini

不同模型的價格和能力不同,請根據需求選擇。

!
常見問題排查
提示 Node.js 版本過低?

Codex 需要 Node.js 22+,如果提示版本過低,請升級 Node.js:

# 使用 nvm 升級 nvm install 22 nvm use 22

或重新下載安裝最新版 Node.js

連接超時或網絡錯誤?

1. 檢查配置文件是否正確設置

2. 確認 API Key 環境變量是否有效

3. 驗證配置:

$env:CRS_OAI_KEY type $env:USERPROFILE\.codex\config.toml
權限錯誤?

如果遇到權限相關錯誤,嘗試以管理員身份運行終端,或使用 WSL 環境。

API 返回 401 或 403 錯誤?

1. 檢查 API Key 是否正確

2. 確認 config.toml 中的 base_url 是否正確

3. 驗證環境變量和配置:

$env:CRS_OAI_KEY type $env:USERPROFILE\.codex\config.toml
命令執行被沙箱阻止?

如果需要執行被阻止的命令,可以調整沙箱模式:

# 允許工作區寫入 codex --sandbox workspace-write

注意:降低沙箱限制會增加安全風險

如何查看 Codex 版本?
codex --version
如何更新 Codex?
npm update -g @openai/codex
配置文件參數說明

主要配置項:

model_provider - 模型提供商名稱,對應 [model_providers.xxx] 中的 xxx

model - 默認使用的模型名稱

model_reasoning_effort - 推理強度:low/medium/high

disable_response_storage - 禁用響應存儲

preferred_auth_method - 認證方式:apikey

trusted_projects - 信任的項目目錄列表

trust_level - 信任級別:trusted/untrusted

[model_providers.xxx] 配置:

name - 提供商名稱

base_url - API 基礎地址

wire_api - API 類型:responses/chat

requires_openai_auth - 是否需要 OpenAI 認證

env_key - 存儲 API Key 的環境變量名

[features] 配置:

experimental_windows_sandbox - Windows 沙箱實驗功能

elevated_windows_sandbox - 提升權限的 Windows 沙箱

unified_exec - 統一執行

shell_snapshot - Shell 快照

powershell_utf8 - PowerShell UTF-8 支持

steer - 引導功能

如何切換不同的模型?

可以通過命令行參數或修改配置文件來切換模型:

命令行方式:

# 使用 GPT-4o codex --model gpt-4o # 使用 o1 codex --model o1 # 使用 o3-mini codex --model o3-mini

配置文件方式:

修改 config.toml 中的 model = "xxx"

Codex 與 Claude Code 的區別?

Codex (OpenAI):

• 使用 OpenAI 模型(GPT-4o、o1、o3 等)

• 需要 Node.js 22+

• 使用 config.toml 配置文件

• 支持沙箱模式和多種運行模式

Claude Code (Anthropic):

• 使用 Anthropic 模型(Claude Sonnet、Opus 等)

• 原生安裝無需 Node.js

• 使用環境變量配置

• 功能更豐富,生態更完善

!
Codex 簡介

OpenAI Codex CLI 是 OpenAI 官方推出的命令行 AI 編程助手,類似於 Claude Code,但使用 OpenAI 的模型(如 GPT-4o、o1、o3 等)。

官方定價參考:https://openai.com/api/pricing

!
macOS 用戶須知

macOS 默認使用 zsh 作爲終端 shell。可以通過 echo $SHELL 查看當前使用的 shell。

推薦使用 iTerm2 或系統自帶的「終端」應用來運行 Codex,體驗更佳。

0
前置要求:安裝 Node.js 22+

Codex 需要 Node.js 22+ 環境(注意:不是 18+,必須是 22 或更高版本)。

已安裝?運行 node --version 驗證版本號是否 >= 22。

安裝 Node.js 22+

方法一:官網下載(推薦)

打開 https://nodejs.org/,下載 Current 版本(22.x 或更高),雙擊安裝。

注意:LTS 版本可能是 20.x,請確認下載的是 22+ 版本

方法二:Homebrew 安裝(推薦)

# 安裝最新版 Node.js brew install node

方法三:nvm(多版本管理,推薦)

# 安裝 nvm curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash # 重新加載配置 source ~/.zshrc # 安裝 Node.js 22 nvm install 22

驗證安裝:

node --version npm --version

確保 node 版本號顯示 v22.x.x 或更高

1
安裝 Codex

使用 npm 全局安裝:

npm install -g @openai/codex # 國內鏡像(下載慢可用) npm install -g @openai/codex --registry=https://registry.npmmirror.com
Homebrew 安裝
brew install openai-codex

Homebrew 安裝可能不會自動更新,建議定期運行 brew upgrade openai-codex

安裝特定版本

安裝指定版本號:

npm install -g @openai/codex@1.0.0

查看所有可用版本:

npm view @openai/codex versions

驗證安裝:

codex --version

顯示版本號說明安裝成功!

2
配置 Codex

Codex 使用配置文件進行設置。將 sk-xxx 替換爲你的密鑰

之前用過其他中轉服務?先清理舊配置

如果之前配置過其他 Codex 中轉服務,需要先清理舊配置,避免衝突。

檢查現有配置文件:

cat ~/.codex/config.toml

檢查環境變量:

env | grep -i oai env | grep -i openai

清理舊環境變量(編輯 ~/.zshrc 刪除相關行):

nano ~/.zshrc

步驟一:設置 API Key 環境變量

根據你使用的 shell 選擇對應命令。將 sk-xxx 替換爲你的密鑰

# zsh(macOS 默認) echo 'export CRS_OAI_KEY="sk-xxx你的密鑰xxx"' >> ~/.zshrc && source ~/.zshrc # bash echo 'export CRS_OAI_KEY="sk-xxx你的密鑰xxx"' >> ~/.bash_profile && source ~/.bash_profile

提示:運行 echo $SHELL 可查看當前使用的 shell

步驟二:創建配置文件

配置文件位置:~/.codex/config.toml

一鍵寫入命令(覆蓋現有配置)
mkdir -p ~/.codex && cat > ~/.codex/config.toml << 'EOF' model_provider = "crs" model = "gpt-5.3-codex" model_reasoning_effort = "high" disable_response_storage = true preferred_auth_method = "apikey" [model_providers.crs] name = "crs" base_url = "https://new.your-agent.cc/v1" wire_api = "responses" requires_openai_auth = true env_key = "CRS_OAI_KEY" [features] steer = true EOF
手動創建配置文件(已一鍵配置可跳過)

如果已經使用上面的一鍵寫入命令配置成功,可以跳過此步驟。

# 創建配置目錄 mkdir -p ~/.codex # 編輯配置文件 nano ~/.codex/config.toml

粘貼以下配置內容:

model_provider = "crs" model = "gpt-5.3-codex" model_reasoning_effort = "high" disable_response_storage = true preferred_auth_method = "apikey" [model_providers.crs] name = "crs" base_url = "https://new.your-agent.cc/v1" wire_api = "responses" requires_openai_auth = true env_key = "CRS_OAI_KEY" [features] steer = true
💡 nano 編輯器:Ctrl+O 保存,Ctrl+X 退出。也可以使用 vim 或其他編輯器。
步驟三:創建 auth.json(重要!)

Codex 還需要 auth.json 文件,用於禁用默認的 OpenAI 認證。

配置文件位置:~/.codex/auth.json

一鍵寫入命令:

cat > ~/.codex/auth.json << 'EOF' { "CRS_OAI_KEY": null } EOF

或手動創建:

nano ~/.codex/auth.json

粘貼以下內容:

{ "CRS_OAI_KEY": null }

說明:設置爲 null 是爲了禁用默認的 OpenAI 認證,讓 Codex 使用 config.toml 中配置的 env_key(CRS_OAI_KEY 環境變量)來獲取 API 密鑰

驗證配置

檢查環境變量:

echo $CRS_OAI_KEY

查看配置文件:

cat ~/.codex/config.toml

查看 auth.json:

cat ~/.codex/auth.json
不再使用?刪除配置

編輯 ~/.zshrc,刪除 export CRS_OAI_KEY=...

刪除配置文件:

rm -rf ~/.codex
3
啓動 Codex

在項目目錄下運行:

# 進入項目目錄 cd /path/to/your/project # 啓動 codex

首次啓動會進行初始化,稍等片刻即可開始使用。

常用啓動參數

指定模型:

codex --model gpt-4o

全自動模式(自動批准所有操作):

codex --full-auto

查看幫助:

codex --help
4
運行模式與沙箱

Codex 提供多種運行模式和沙箱選項:

運行模式(--approval-mode)
# suggest(默認)- 所有操作需確認 codex --approval-mode suggest # auto-edit - 自動編輯文件,命令需確認 codex --approval-mode auto-edit # full-auto - 完全自動執行 codex --full-auto
沙箱模式(--sandbox)
# read-only(默認)- 只讀 codex --sandbox read-only # workspace-write - 允許工作區寫入 codex --sandbox workspace-write # danger-full-access - 完全訪問(謹慎使用) codex --sandbox danger-full-access
配置文件

配置文件位置:~/.codex/config.toml

# 示例配置 model_provider = "crs" model = "gpt-5.3-codex" [model_providers.crs] base_url = "https://new.your-agent.cc/v1" env_key = "CRS_OAI_KEY"
!
常見問題排查
提示 Node.js 版本過低?

Codex 需要 Node.js 22+,如果提示版本過低,請升級 Node.js:

# 使用 nvm 升級 nvm install 22 nvm use 22 # 或使用 Homebrew brew upgrade node
連接超時或網絡錯誤?

1. 檢查配置文件是否正確設置

2. 確認 API Key 環境變量是否有效

3. 驗證配置:

echo $CRS_OAI_KEY cat ~/.codex/config.toml
API 返回 401/403 錯誤?

1. 檢查 API Key 是否正確

2. 確認 config.toml 中的 base_url 是否正確

echo $CRS_OAI_KEY cat ~/.codex/config.toml
如何更新 Codex?
npm update -g @openai/codex # 或 Homebrew brew upgrade openai-codex
!
Codex 簡介

OpenAI Codex CLI 是 OpenAI 官方推出的命令行 AI 編程助手,類似於 Claude Code,但使用 OpenAI 的模型(如 GPT-4o、o1、o3 等)。

官方定價參考:https://openai.com/api/pricing

!
WSL 用戶請看這裏

如果你在 Windows 上使用 WSL,本教程同樣適用。WSL 是 Windows 上運行 Codex 的最佳方式,兼容性最好。

安裝 WSL:在 PowerShell(管理員)中運行:

wsl --install
0
前置要求:安裝 Node.js 22+

Codex 需要 Node.js 22+ 環境(注意:不是 18+,必須是 22 或更高版本)。

已安裝?運行 node --version 驗證版本號是否 >= 22。

安裝 Node.js 22+

方法一:nvm(推薦,多版本管理)

在終端中執行(按 Ctrl+Alt+T 打開終端)

# 安裝 nvm curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash # 重新加載配置 source ~/.bashrc # 安裝 Node.js LTS 版本 nvm install --lts

方法二:包管理器

在終端中執行(按 Ctrl+Alt+T 打開終端)

# Ubuntu/Debian sudo apt update && sudo apt install nodejs npm # Fedora sudo dnf install nodejs # Arch Linux sudo pacman -S nodejs npm

注意:包管理器安裝的版本可能較舊,如果版本低於 22,請使用方法一(nvm)安裝

方法三:NodeSource 倉庫(指定版本)

# Ubuntu/Debian - 添加 NodeSource 倉庫(Node.js 22) curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash - sudo apt-get install -y nodejs # Fedora/RHEL - 添加 NodeSource 倉庫 curl -fsSL https://rpm.nodesource.com/setup_22.x | sudo bash - sudo dnf install nodejs

驗證安裝:

node --version npm --version

確保 node 版本號顯示 v22.x.x 或更高

1
安裝 Codex

使用 npm 全局安裝:

npm install -g @openai/codex # 國內鏡像(下載慢可用) npm install -g @openai/codex --registry=https://registry.npmmirror.com
安裝特定版本

安裝指定版本號:

npm install -g @openai/codex@1.0.0

查看所有可用版本:

npm view @openai/codex versions
權限問題?

如果遇到權限錯誤,可以嘗試以下方法:

方法一:使用 sudo(不推薦)

sudo npm install -g @openai/codex

方法二:修改 npm 全局目錄(推薦)

mkdir ~/.npm-global npm config set prefix '~/.npm-global' # 添加到 PATH(編輯 ~/.bashrc 或 ~/.zshrc) echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc source ~/.bashrc # 然後重新安裝 npm install -g @openai/codex

驗證安裝:

codex --version

顯示版本號說明安裝成功!

2
配置 Codex

Codex 使用配置文件進行設置。將 sk-xxx 替換爲你的密鑰

之前用過其他中轉服務?先清理舊配置

如果之前配置過其他 Codex 中轉服務,需要先清理舊配置,避免衝突。

檢查現有配置文件:

cat ~/.codex/config.toml

檢查環境變量:

env | grep -i oai env | grep -i openai

清理舊環境變量(編輯 ~/.bashrc 或 ~/.zshrc 刪除相關行):

nano ~/.bashrc

步驟一:設置 API Key 環境變量

編輯 ~/.bashrc~/.zshrc

echo 'export CRS_OAI_KEY="sk-xxx你的密鑰xxx"' >> ~/.bashrc && source ~/.bashrc

步驟二:創建配置文件

配置文件位置:~/.codex/config.toml

一鍵寫入命令(覆蓋現有配置)
mkdir -p ~/.codex && cat > ~/.codex/config.toml << 'EOF' model_provider = "crs" model = "gpt-5.3-codex" model_reasoning_effort = "high" disable_response_storage = true preferred_auth_method = "apikey" [model_providers.crs] name = "crs" base_url = "https://new.your-agent.cc/v1" wire_api = "responses" requires_openai_auth = true env_key = "CRS_OAI_KEY" [features] steer = true EOF
手動創建配置文件(已一鍵配置可跳過)

如果已經使用上面的一鍵寫入命令配置成功,可以跳過此步驟。

# 創建配置目錄 mkdir -p ~/.codex # 編輯配置文件 nano ~/.codex/config.toml

粘貼以下配置內容:

model_provider = "crs" model = "gpt-5.3-codex" model_reasoning_effort = "high" disable_response_storage = true preferred_auth_method = "apikey" [model_providers.crs] name = "crs" base_url = "https://new.your-agent.cc/v1" wire_api = "responses" requires_openai_auth = true env_key = "CRS_OAI_KEY" [features] steer = true
💡 nano 編輯器:Ctrl+O 保存,Ctrl+X 退出。也可以使用 vim 或其他編輯器。
步驟三:創建 auth.json(重要!)

Codex 還需要 auth.json 文件,用於禁用默認的 OpenAI 認證。

配置文件位置:~/.codex/auth.json

一鍵寫入命令:

cat > ~/.codex/auth.json << 'EOF' { "CRS_OAI_KEY": null } EOF

或手動創建:

nano ~/.codex/auth.json

粘貼以下內容:

{ "CRS_OAI_KEY": null }

說明:設置爲 null 是爲了禁用默認的 OpenAI 認證,讓 Codex 使用 config.toml 中配置的 env_key(CRS_OAI_KEY 環境變量)來獲取 API 密鑰

驗證配置

檢查環境變量:

echo $CRS_OAI_KEY

查看配置文件:

cat ~/.codex/config.toml

查看 auth.json:

cat ~/.codex/auth.json
不再使用?刪除配置

編輯 ~/.bashrc,刪除 export CRS_OAI_KEY=...

刪除配置文件:

rm -rf ~/.codex
3
啓動 Codex

在項目目錄下運行:

# 進入項目目錄 cd /path/to/your/project # 啓動 codex

首次啓動會進行初始化,稍等片刻即可開始使用。

常用啓動參數

指定模型:

codex --model gpt-4o

全自動模式(自動批准所有操作):

codex --full-auto

查看幫助:

codex --help
4
運行模式與沙箱

Codex 提供多種運行模式和沙箱選項:

運行模式(--approval-mode)
# suggest(默認)- 所有操作需確認 codex --approval-mode suggest # auto-edit - 自動編輯文件,命令需確認 codex --approval-mode auto-edit # full-auto - 完全自動執行 codex --full-auto
沙箱模式(--sandbox)
# read-only(默認)- 只讀 codex --sandbox read-only # workspace-write - 允許工作區寫入 codex --sandbox workspace-write # danger-full-access - 完全訪問(謹慎使用) codex --sandbox danger-full-access
配置文件

配置文件位置:~/.codex/config.toml

# 示例配置 model_provider = "crs" model = "gpt-5.3-codex" [model_providers.crs] base_url = "https://new.your-agent.cc/v1" env_key = "CRS_OAI_KEY" [features] steer = true
項目級配置(codex.md)

在項目根目錄創建 codex.md 文件,爲 Codex 提供項目上下文:

# codex.md 示例 # 項目說明 這是一個 Python Flask 項目。 # 常用命令 - python app.py: 啓動服務 - pytest: 運行測試
5
支持的模型

Codex 支持多種 OpenAI 模型:

# GPT-4o(推薦) codex --model gpt-4o # GPT-4o-mini(更快更便宜) codex --model gpt-4o-mini # o1/o3 系列(推理能力更強) codex --model o1 codex --model o3-mini
!
常見問題排查
提示 Node.js 版本過低?

Codex 需要 Node.js 22+,如果提示版本過低,請升級 Node.js:

# 使用 nvm 升級 nvm install 22 nvm use 22
連接超時或網絡錯誤?

1. 檢查配置文件是否正確設置

2. 確認 API Key 環境變量是否有效

3. 驗證配置:

echo $CRS_OAI_KEY cat ~/.codex/config.toml
WSL 中無法訪問 Windows 文件?

Windows 文件系統掛載在 /mnt/ 目錄下:

# 訪問 C 盤 cd /mnt/c/Users/YourName/Projects

建議將項目放在 WSL 文件系統中(如 ~/projects)以獲得更好的性能。

API 返回 401/403 錯誤?

1. 檢查 API Key 是否正確

2. 確認 config.toml 中的 base_url 是否正確

echo $CRS_OAI_KEY cat ~/.codex/config.toml
命令被沙箱阻止?

調整沙箱模式:

codex --sandbox workspace-write
如何更新 Codex?
npm update -g @openai/codex
配置文件參數說明

主要配置項:

model_provider - 模型提供商名稱

model - 默認使用的模型名稱

model_reasoning_effort - 推理強度:low/medium/high

[model_providers.xxx] 配置:

base_url - API 基礎地址

env_key - 存儲 API Key 的環境變量名

wire_api - API 類型:responses/chat

Codex 與 Claude Code 的區別?

Codex (OpenAI):

• 使用 OpenAI 模型(GPT-4o、o1、o3 等)

• 需要 Node.js 22+

• 使用 config.toml 配置文件

Claude Code (Anthropic):

• 使用 Anthropic 模型(Claude Sonnet、Opus 等)

• 原生安裝無需 Node.js

• 使用環境變量配置

!
Gemini CLI 簡介

Gemini CLI 是 Google 官方推出的命令行 AI 編程助手,使用 Gemini 模型(如 gemini-3-pro-preview 等)。

官方定價參考:https://ai.google.dev/gemini-api/docs/pricing?hl=zh-cn

!
推薦使用 Windows Terminal

Windows Terminal 是微軟官方的現代化終端工具,支持多標籤頁、更好的字符渲染、emoji 和中文顯示。強烈建議用它替代自帶的 cmd 和 PowerShell 窗口。

Microsoft Store 下載 GitHub 下載
0
前置要求:安裝 Node.js

Gemini CLI 需要 Node.js 環境才能運行。

已安裝?運行 node --version 驗證,有版本號可跳過此步驟。

安裝 Node.js

方法一:官網下載(推薦)

打開 https://nodejs.org/,下載 LTS 版本,雙擊安裝。

方法二:nvm-windows(多版本管理)

下載 nvm-setup.exe 從 GitHub Releases

國內加速下載:https://static.yoouu.cn/nvm-setup.exe

🖥️ 必須用 PowerShell 或 Windows Terminal!cmd 是上古遺物,用它必出問題!
nvm install lts nvm use lts

方法三:包管理器

# Chocolatey choco install nodejs # Scoop scoop install nodejs

驗證安裝:

node --version npm --version

顯示版本號說明安裝成功!

1
安裝 Gemini CLI

使用 npm 全局安裝:

🖥️ 必須用 PowerShell 或 Windows Terminal!cmd 是上古遺物,用它必出問題!
npm install -g @google/gemini-cli

如遇權限問題,以管理員身份運行 PowerShell

驗證安裝:

gemini --version

顯示版本號說明安裝成功!

2
配置環境變量

配置連接到中轉服務。將 sk-xxx你的密鑰xxx 替換爲你的密鑰

永久設置(系統級別,需管理員權限):

按 Win+X → 選擇「終端管理員」或「PowerShell(管理員)」

🖥️ 必須用 PowerShell 或 Windows Terminal!cmd 是上古遺物,用它必出問題!
[System.Environment]::SetEnvironmentVariable("GOOGLE_GEMINI_BASE_URL", "https://your-agent.cc/gemini", [System.EnvironmentVariableTarget]::Machine) [System.Environment]::SetEnvironmentVariable("GEMINI_API_KEY", "cr_xxxxxxxxxx你的密鑰xxx", [System.EnvironmentVariableTarget]::Machine) [System.Environment]::SetEnvironmentVariable("GEMINI_MODEL", "gemini-3-pro-preview", [System.EnvironmentVariableTarget]::Machine)

設置後需重新打開終端生效

驗證環境變量:

Get-ChildItem Env:GEMINI_*,Env:GOOGLE_GEMINI_*
不再使用?刪除環境變量

清理系統級環境變量(需管理員):

[System.Environment]::SetEnvironmentVariable("GOOGLE_GEMINI_BASE_URL", $null, [System.EnvironmentVariableTarget]::Machine) [System.Environment]::SetEnvironmentVariable("GEMINI_API_KEY", $null, [System.EnvironmentVariableTarget]::Machine) [System.Environment]::SetEnvironmentVariable("GEMINI_MODEL", $null, [System.EnvironmentVariableTarget]::Machine)
3
啓動 Gemini CLI

在項目目錄下運行:

# 進入項目目錄 cd C:\path\to\your\project # 啓動 gemini

首次啓動會進行初始化,稍等片刻即可開始使用。

!
Gemini CLI 簡介

Gemini CLI 是 Google 官方推出的命令行 AI 編程助手,使用 Gemini 模型(如 gemini-3-pro-preview 等)。

官方定價參考:https://ai.google.dev/gemini-api/docs/pricing?hl=zh-cn

!
macOS 用戶須知

macOS 默認使用 zsh 作爲終端 shell。可以通過 echo $SHELL 查看當前使用的 shell。

推薦使用 iTerm2 或系統自帶的「終端」應用來運行 Gemini CLI,體驗更佳。

0
前置要求:安裝 Node.js

Gemini CLI 需要 Node.js 環境才能運行。

已安裝?運行 node --version 驗證,有版本號可跳過此步驟。

安裝 Node.js

方法一:官網下載(推薦)

打開 https://nodejs.org/,下載 LTS 版本,雙擊安裝。

方法二:Homebrew 安裝

brew install node

方法三:nvm(多版本管理)

# 安裝 nvm curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash # 重新加載配置 source ~/.zshrc # 安裝 Node.js LTS 版本 nvm install --lts

驗證安裝:

node --version npm --version

顯示版本號說明安裝成功!

1
安裝 Gemini CLI

使用 npm 全局安裝:

npm install -g @google/gemini-cli

驗證安裝:

gemini --version

顯示版本號說明安裝成功!

2
配置環境變量

配置連接到中轉服務。將 sk-xxx你的密鑰xxx 替換爲你的密鑰

方法一:臨時設置(當前終端有效)

export GOOGLE_GEMINI_BASE_URL="https://your-agent.cc/gemini" export GEMINI_API_KEY="cr_xxxxxxxxxx" export GEMINI_MODEL="gemini-3-pro-preview"

方法二:永久配置(推薦)

編輯 ~/.zshrc(或 ~/.bash_profile):

nano ~/.zshrc

添加以下內容:

export GOOGLE_GEMINI_BASE_URL="https://your-agent.cc/gemini" export GEMINI_API_KEY="cr_xxxxxxxxxx" export GEMINI_MODEL="gemini-3-pro-preview"

保存後運行 source ~/.zshrc 或重啓終端生效。

💡 nano 編輯器:Ctrl+O 保存,Ctrl+X 退出。也可以使用 vim 或其他編輯器。

驗證環境變量:

echo $GOOGLE_GEMINI_BASE_URL echo $GEMINI_API_KEY
不再使用?刪除環境變量

編輯 ~/.zshrc,刪除相關的 export 行,然後運行 source ~/.zshrc 或重啓終端生效。

3
啓動 Gemini CLI

在項目目錄下運行:

# 進入項目目錄 cd /path/to/your/project # 啓動 gemini

首次啓動會進行初始化,稍等片刻即可開始使用。

!
Gemini CLI 簡介

Gemini CLI 是 Google 官方推出的命令行 AI 編程助手,使用 Gemini 模型(如 gemini-3-pro-preview 等)。

官方定價參考:https://ai.google.dev/gemini-api/docs/pricing?hl=zh-cn

!
WSL 用戶請看這裏

如果你在 Windows 上使用 WSL,本教程同樣適用。WSL 是 Windows 上運行 Gemini CLI 的最佳方式,兼容性最好。

安裝 WSL:在 PowerShell(管理員)中運行:

wsl --install
0
前置要求:安裝 Node.js

Gemini CLI 需要 Node.js 環境才能運行。

已安裝?運行 node --version 驗證,有版本號可跳過此步驟。

安裝 Node.js

Ubuntu / Debian:

# 添加 NodeSource 倉庫 curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash - # 安裝 Node.js sudo apt-get install -y nodejs

Fedora / RHEL:

sudo dnf install nodejs

Arch Linux:

sudo pacman -S nodejs npm

驗證安裝:

node --version npm --version

顯示版本號說明安裝成功!

1
安裝 Gemini CLI

使用 npm 全局安裝:

npm install -g @google/gemini-cli

驗證安裝:

gemini --version

顯示版本號說明安裝成功!

2
配置環境變量

配置連接到中轉服務。將 sk-xxx你的密鑰xxx 替換爲你的密鑰

方法一:臨時設置(當前終端有效)

export GOOGLE_GEMINI_BASE_URL="https://your-agent.cc/gemini" export GEMINI_API_KEY="cr_xxxxxxxxxx" export GEMINI_MODEL="gemini-3-pro-preview"

方法二:永久配置(推薦)

編輯 ~/.bashrc~/.zshrc

nano ~/.bashrc

添加以下內容:

export GOOGLE_GEMINI_BASE_URL="https://your-agent.cc/gemini" export GEMINI_API_KEY="cr_xxxxxxxxxx" export GEMINI_MODEL="gemini-3-pro-preview"

保存後運行 source ~/.bashrc 或重啓終端生效。

驗證環境變量:

echo $GOOGLE_GEMINI_BASE_URL echo $GEMINI_API_KEY
3
啓動 Gemini CLI

在項目目錄下運行:

# 進入項目目錄 cd /path/to/your/project # 啓動 gemini

首次啓動會進行初始化,稍等片刻即可開始使用。

!
暫未銷售

該產品目前暫未銷售,以下教程僅供參考。如有需要請聯繫站主諮詢。

!
Droid CLI 簡介

Droid CLI 是 Factory.ai 推出的命令行 AI 編程助手,支持多種模型(Claude、GPT 等)。

官方網站:https://www.factory.ai/

1
配置 Droid CLI

Droid CLI 需要在配置文件中添加自定義模型。將 your_api_key 替換爲你的密鑰

配置文件位置:~/.factory/config.json

編輯配置文件,添加以下內容:

{ "custom_models": [ { "model_display_name": "Opus 4.6 [crs]", "model": "claude-opus-4-6", "base_url": "https://new.your-agent.cc", "api_key": "your_api_key", "provider": "anthropic", "max_tokens": 8192 }, { "model_display_name": "GPT5-Codex [crs]", "model": "gpt-5.3-codex", "base_url": "https://new.your-agent.cc/v1", "api_key": "your_api_key", "provider": "openai", "max_tokens": 16384 } ] }

配置完成後,在 Droid CLI 中選擇自定義模型即可使用。

!
VSCode & Cursor 插件說明

VSCode 和 Cursor 都支持通過插件使用 Claude Code。以下是配置方法。

1
配置環境變量

需要在 .claude 目錄下創建 settings.json 文件。將 sk-XXXX你的key 替換爲你的密鑰

配置文件位置:

Windows: %USERPROFILE%\.claude\settings.json

macOS/Linux: ~/.claude/settings.json

文件內容:

{ "env": { "ANTHROPIC_AUTH_TOKEN": "sk-XXXX你的key", "ANTHROPIC_BASE_URL": "https://new.your-agent.cc" }, "includeCoAuthoredBy": false, "model": "opus" }
2
安裝 Claude Code 官方插件

Anthropic 官方提供了 VSCode 插件,可以直接在編輯器中使用 Claude Code。

安裝方式:

1. 打開 VSCode / Cursor

2. 按 Ctrl+Shift+X 打開擴展面板

3. 搜索 "Claude Code" 或 "Anthropic"

4. 點擊安裝

安裝後,插件會自動讀取 settings.json 中的配置,即可使用。

VSCode 插件配置
!
WSL 性能優化

WSL 中運行 Claude Code 最常見的卡頓問題來自:Windows PATH 繼承、跨文件系統訪問慢、Claude 內部調用 PowerShell 的 bug。以下配置可以顯著提升流暢度。

1
WSL Ubuntu 端配置

禁用 Windows 路徑互操作:

在 WSL 終端中執行(按 Ctrl+Alt+T 打開終端)

config="/etc/wsl.conf";content="[interop]\nappendWindowsPath=false";echo "=== 配置前 ===";if [ -f "$config" ];then cat "$config";else echo "(文件不存在)";fi;echo "";if [ ! -f "$config" ];then echo -e "$content"|sudo tee "$config">/dev/null;echo "=== 配置後 ===";cat "$config";echo -e "\n已創建";elif ! grep -q "appendWindowsPath.*=.*false" "$config";then echo -e "\n$content"|sudo tee -a "$config">/dev/null;echo "=== 配置後 ===";cat "$config";echo -e "\n已添加";else echo "=== 配置後 ===";cat "$config";echo -e "\n無需修改";fi

緩存 USERPROFILE 避免 PowerShell 調用:

shell_rc="$HOME/.$(basename $SHELL)rc";winuser=$(cmd.exe /c "echo %USERNAME%" 2>/dev/null|tr -d '\r');content="export USERPROFILE=\"/mnt/c/Users/$winuser\"";echo "=== 當前 Shell: $SHELL ===";echo "=== 配置文件: $shell_rc ===";echo "";echo "=== 配置前 ===";grep -n "USERPROFILE" "$shell_rc" 2>/dev/null||echo "(未找到)";echo "";if grep -q "export USERPROFILE=" "$shell_rc" 2>/dev/null;then echo "=== 配置後 ===";grep -n "USERPROFILE" "$shell_rc";echo -e "\n已存在";else echo "$content">>"$shell_rc";echo "=== 配置後 ===";grep -n "USERPROFILE" "$shell_rc";echo -e "\n已添加: $content\n請執行: source $shell_rc";fi
2
Windows Terminal 滾動優化

Claude Code 輸出長內容時,Windows Terminal 默認的 9001 行歷史記錄容易溢出,導致滾動條跳回頂部。將 historySize 設爲最大值 32767 可顯著改善。

方法一:圖形界面設置

1. 打開 Windows Terminal → 下拉箭頭 → 設置

2. 左側選擇 配置文件 → 默認值

3. 找到 高級 → 歷史記錄大小,改爲 32767

4. 點擊 保存,重啓 Windows Terminal

方法二:一鍵配置(推薦)

在 PowerShell 中執行以下命令自動配置 settings.json:

🖥️ 必須用 PowerShell 或 Windows Terminal!cmd 是上古遺物,用它必出問題!
$settingsPath = "$env:LOCALAPPDATA\Packages\Microsoft.WindowsTerminal_8wekyb3d8bbwe\LocalState\settings.json"; if (!(Test-Path $settingsPath)) { $settingsPath = "$env:LOCALAPPDATA\Packages\Microsoft.WindowsTerminalPreview_8wekyb3d8bbwe\LocalState\settings.json" }; Write-Host "=== 配置文件: $settingsPath ===" -ForegroundColor Yellow; if (Test-Path $settingsPath) { $json = Get-Content $settingsPath -Raw | ConvertFrom-Json; $current = $json.profiles.defaults.historySize; Write-Host "=== 配置前: historySize = $current ==="; $json.profiles.defaults | Add-Member -NotePropertyName "historySize" -NotePropertyValue 32767 -Force; $json | ConvertTo-Json -Depth 100 | Set-Content $settingsPath -Encoding UTF8; Write-Host "=== 配置後: historySize = 32767 ===" -ForegroundColor Green; Write-Host "`n請重啓 Windows Terminal" } else { Write-Host "未找到 Windows Terminal 配置文件" -ForegroundColor Red }
!
重要提示

配置完成後需要執行 wsl --shutdown 重啓 WSL 使配置生效。

wsl --shutdown
!
CC-Switch 配置工具

CC-Switch 是一個圖形化配置管理工具,可以幫助你快速切換多個 Claude Code / Codex / Gemini 配置,無需手動修改環境變量。

提示:如果配置後環境變量仍不生效,請先卸載 CC-Switch,重新安裝後再次配置。若問題依舊,請聯繫站主協助處理。

1
下載地址

GitHub 倉庫:

GitHub 官方下載

國內加速下載:

Windows (.msi) macOS (.zip)
2
Windows 配置提示

下載安裝後,右鍵點擊 CC-Switch 圖標 → 屬性 → 兼容性 → 勾選「以管理員身份運行此程序」

Windows 配置
3
軟件界面

支持管理多個配置,一鍵切換不同的 API 供應商:

CC-Switch 首頁
4
添加配置

點擊右上角 + 號添加新配置,填入供應商名稱、API Key 和請求地址即可:

添加配置
添加配置
!
Claude Code 狀態欄插件

狀態欄插件可以在終端顯示模型信息、Git 分支、Token 使用量、會話成本等實時指標。以下是幾款流行的狀態欄插件,選擇適合你的使用。

!
選擇插件
1
CCometixLine(推薦)

CCometixLine 是用 Rust 編寫的高性能 Claude Code 狀態欄工具,相比 Node.js 實現更輕量、啓動更快。支持實時使用追蹤、Git 集成、交互式 TUI 配置界面。

  • Rust 編寫,性能更高、內存佔用更低
  • 實時 Token 使用追蹤和成本計算
  • Git 分支和狀態集成
  • 交互式 TUI 配置界面

安裝:

npm install -g @cometix/ccline # 或使用鏡像源 npm install -g @cometix/ccline --registry https://registry.npmmirror.com

配置:

ccline --config

配置文件位置:~/.claude/ccline/config.toml

添加到 Claude Code(Linux/macOS):

{ "statusLine": { "type": "command", "command": "~/.claude/ccline/ccline", "padding": 0 } }

添加到 Claude Code(Windows):

{ "statusLine": { "type": "command", "command": "%USERPROFILE%\\.claude\\ccline\\ccline.exe", "padding": 0 } }
2
ccstatusline(久未更新)

較早的狀態欄插件,功能基礎但穩定。使用 Node.js 編寫。

安裝:

npm install -g ccstatusline # 或使用鏡像源 npm install -g ccstatusline --registry https://registry.npmmirror.com

添加到 Claude Code:

{ "statusLine": { "type": "command", "command": "ccstatusline" } }
3
claude-powerline

類似 Powerline 風格的狀態欄插件,界面美觀。

安裝:

npm install -g claude-powerline # 或使用鏡像源 npm install -g claude-powerline --registry https://registry.npmmirror.com

添加到 Claude Code:

{ "statusLine": { "type": "command", "command": "claude-powerline" } }
4
cc-statusline

輕量級狀態欄插件,簡潔實用。

安裝:

npm install -g cc-statusline # 或使用鏡像源 npm install -g cc-statusline --registry https://registry.npmmirror.com

添加到 Claude Code:

{ "statusLine": { "type": "command", "command": "cc-statusline" } }
5
claude-code-statusline

社區維護的狀態欄插件,功能完善。

安裝:

npm install -g claude-code-statusline # 或使用鏡像源 npm install -g claude-code-statusline --registry https://registry.npmmirror.com

添加到 Claude Code:

{ "statusLine": { "type": "command", "command": "claude-code-statusline" } }
!
opencode 簡介

opencode 是一個開源的 AI 編程助手 CLI 工具,支持通過配置文件自定義 provider 連接中轉服務。

注意:目前文檔只是作爲一個示例,opencode 非常不好用,你自己根據示例折騰,文檔不一定正確。

官網 GitHub
1
配置文件位置

全局配置:~/.config/opencode/opencode.json

Windows: %USERPROFILE%\.config\opencode\opencode.json

項目配置:./opencode.json

項目配置優先級高於全局配置

2
安裝依賴

在配置目錄安裝對應的 SDK 包:

# 進入配置目錄 cd ~/.config/opencode # 安裝 SDK npm install @ai-sdk/anthropic
3
配置示例

選擇分組類型:

在配置文件中添加以下內容:將 your-claude_code-key 替換爲你的密鑰

{ "$schema": "https://opencode.ai/config.json", "provider": { "nexus-mixedcc": { "npm": "@ai-sdk/anthropic", "options": { "apiKey": "your-claude_code-key", "baseURL": "https://new.your-agent.cc" }, "models": { "claude-opus-4-6-20260205": { "name": "Claude Opus 4.6", "attachment": true } } } }, "model": "nexus-mixedcc/claude-opus-4-6-20260205" }

安裝依賴:npm install @ai-sdk/anthropic

在配置文件中添加以下內容:將 your-gemini-key 替換爲你的密鑰

{ "$schema": "https://opencode.ai/config.json", "provider": { "nexus-gemini": { "npm": "@ai-sdk/google", "options": { "apiKey": "your-gemini-key", "baseURL": "https://your-agent.cc/gemini/v1beta" }, "models": { "gemini-2.5-pro": { "name": "Gemini 2.5 Pro", "attachment": true } } } }, "model": "nexus-gemini/gemini-2.5-pro" }

安裝依賴:npm install @ai-sdk/google

在配置文件中添加以下內容:將 your-codex-key 替換爲你的密鑰

{ "$schema": "https://opencode.ai/config.json", "provider": { "nexus-codex": { "npm": "@ai-sdk/openai", "options": { "apiKey": "your-codex-key", "baseURL": "https://your-agent.cc/gemini/v1beta" }, "models": { "gpt-5.3-codex": { "name": "GPT 5.3 Codex", "attachment": true } } } }, "model": "nexus-codex/gpt-5.3-codex" }

安裝依賴:npm install @ai-sdk/openai

4
安裝並啓動

安裝 opencode 並啓動:

# 安裝 opencode npm i -g opencode-ai@latest # 啓動 opencode
!
everything-claude-code 簡介

everything-claude-code 是來自 Anthropic 黑客松獲獎者的配置集合,包含精心設計的 agents、skills、commands、rules、hooks 和 MCP 配置,可以顯著提升 Claude Code 的使用體驗。

GitHub
1
包含的組件
Agents planner、architect、code-reviewer 等 9 個專業代理
Skills 編碼標準、後端/前端模式、TDD 方法論等
Commands /tdd、/plan、/e2e、/code-review 等 10 個命令
Rules 安全、編碼風格、測試、git 工作流規則
Hooks PreToolUse、PostToolUse、Stop 事件觸發器
MCP Configs GitHub、Supabase、Vercel 等服務配置
2
安裝方法
方法一:插件安裝(推薦)

使用 Claude Code 內置的插件系統一鍵安裝:

/plugin marketplace add affaan-m/everything-claude-code /plugin install everything-claude-code@everything-claude-code
方法二:手動安裝(Windows PowerShell)

手動克隆倉庫並複製配置文件:

# 克隆倉庫 git clone https://github.com/affaan-m/everything-claude-code.git $env:USERPROFILE\.claude\everything-claude-code # 創建目錄 New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\.claude\agents", "$env:USERPROFILE\.claude\commands", "$env:USERPROFILE\.claude\skills" # 複製文件 Copy-Item "$env:USERPROFILE\.claude\everything-claude-code\agents\*.md" "$env:USERPROFILE\.claude\agents\" Copy-Item "$env:USERPROFILE\.claude\everything-claude-code\commands\*.md" "$env:USERPROFILE\.claude\commands\" Copy-Item "$env:USERPROFILE\.claude\everything-claude-code\skills\*" "$env:USERPROFILE\.claude\skills\" -Recurse
方法二:手動安裝(macOS/Linux)

手動克隆倉庫並複製配置文件:

# 克隆倉庫 git clone https://github.com/affaan-m/everything-claude-code.git ~/.claude/everything-claude-code # 創建目錄 mkdir -p ~/.claude/agents ~/.claude/commands ~/.claude/skills # 複製文件 cp ~/.claude/everything-claude-code/agents/*.md ~/.claude/agents/ cp ~/.claude/everything-claude-code/commands/*.md ~/.claude/commands/ cp -r ~/.claude/everything-claude-code/skills/* ~/.claude/skills/
3
推薦配置(全棧/JavaScript 開發者)

以下是針對全棧和 JavaScript 開發者的推薦配置組合:

Agents:

planner.md 功能規劃,拆解任務
architect.md 系統設計決策
code-reviewer.md 代碼質量審查
build-error-resolver.md 構建錯誤修復
e2e-runner.md E2E 測試

Commands:

/plan 實現規劃
/code-review 質量審查
/build-fix 修復構建錯誤
/e2e E2E 測試

Skills:

coding-standards 語言最佳實踐
backend-patterns API、數據庫模式
frontend-patterns React、Next.js 模式
5
更新方法

以後更新只需拉取最新代碼,然後重新複製需要的文件:

# Windows PowerShell cd $env:USERPROFILE\.claude\everything-claude-code; git pull # macOS/Linux cd ~/.claude/everything-claude-code && git pull

然後重新複製需要的文件

!
注意事項
  • 每個項目啓用的 MCP 不要超過 10 個,活躍工具不超過 80 個
  • 200k 上下文窗口可能因工具過多縮減至 70k
  • 配置中的 YOUR_*_HERE 佔位符需要替換爲實際 API 密鑰
!
MCP 服務器配置教程

MCP (Model Context Protocol) 是 Anthropic 推出的開放協議,讓 Claude Code 能夠連接外部工具和數據源,大幅擴展 AI 的能力邊界。

官方文檔 官方服務器
1
什麼是 MCP?

MCP 讓 Claude Code 能夠:

  • 訪問最新的庫和框架文檔(如 Context7)
  • 操作 GitHub、Notion、Figma 等外部服務
  • 執行瀏覽器自動化、數據庫查詢等任務
  • 連接 Zapier 等自動化平臺實現跨應用工作流
2
配置文件位置

MCP 配置存儲在 JSON 文件中,支持全局和項目級別配置:

全局 (macOS/Linux) ~/.claude/mcp.json
全局 (Windows) %USERPROFILE%\.claude\mcp.json
項目級別 .claude/mcp.json
3
安裝方式
方式一:命令行安裝(推薦)

使用 Claude Code 內置命令管理 MCP 服務器:

# 本地運行(npx) claude mcp add <name> -- npx -y <package> # 遠程連接(HTTP) claude mcp add --transport http <name> <url> # 查看已安裝 claude mcp list # 移除服務器 claude mcp remove <name>
方式二:手動配置

直接編輯 ~/.claude/mcp.json 文件:

{ "mcpServers": { "server-name": { "command": "npx", "args": ["-y", "@package/name"] } } }
4
熱門 MCP 服務器

以下是社區推薦的常用 MCP 服務器:

命令分兩種:claude mcp add 是 Claude Code 內置命令,會自動註冊到配置;npx @composio/mcp setup 是 Composio 的安裝嚮導,也會自動配置。

Context7 - 獲取最新的庫和框架文檔、API 信息、代碼示例 需要 API Key

claude mcp add --scope user context7 -- npx -y @upstash/context7-mcp --api-key YOUR_API_KEY

GitHub - 訪問 GitHub 倉庫、Issue、PR,支持代碼搜索和文件操作 需要 API Key

npx @composio/mcp@latest setup github --client claude

Playwright - 瀏覽器自動化和網頁抓取,支持截圖、表單填寫、數據提取

claude mcp add --scope user playwright -- npx -y @executeautomation/mcp-playwright

Puppeteer - 無頭瀏覽器控制、網頁抓取、PDF 生成、表單自動化

claude mcp add --scope user puppeteer -- npx -y @modelcontextprotocol/server-puppeteer

Docker - 容器生命週期管理、鏡像構建、Docker Compose 編排

claude mcp add --scope user docker -- npx -y @modelcontextprotocol/server-docker

Sequential Thinking - 鏈式思維推理、逐步問題解決、複雜任務分析

claude mcp add --scope user thinking -- npx -y @modelcontextprotocol/server-sequential-thinking

Notion - 訪問和管理 Notion 工作區、搜索頁面、創建筆記、更新數據庫 需要 API Key

npx @composio/mcp@latest setup notion --client claude

Slack - 讀取和發送消息、搜索頻道和用戶、文件共享、線程管理 需要 API Key

claude mcp add --scope user slack -- npx -y @modelcontextprotocol/server-slack

Linear - 創建和更新 Issue、項目查詢、Sprint 規劃、狀態跟蹤 需要 API Key

claude mcp add --scope user linear -- npx -y linear-mcp-server

Figma - 訪問設計文件、導出資源、分析設計系統、組件分析 需要 API Key

npx @composio/mcp@latest setup figma --client claude

Supabase - PostgreSQL 數據庫訪問、身份驗證、存儲和文件操作 需要 API Key

claude mcp add --scope user supabase -- npx -y @supabase/mcp-server-supabase

PostgreSQL - SQL 查詢執行、模式檢查、連接池、只讀模式

claude mcp add --scope user postgres -- npx -y @modelcontextprotocol/server-postgres

SQLite - 輕量級數據庫操作、本地數據存儲

claude mcp add --scope user sqlite -- npx -y @modelcontextprotocol/server-sqlite

Zapier - 連接 5000+ 應用、Zap 創建和管理、工作流自動化 需要 API Key

npx @composio/mcp@latest setup zapier --client claude

Filesystem - 本地文件讀寫、目錄操作

claude mcp add --scope user filesystem -- npx -y @modelcontextprotocol/server-filesystem /path/to/dir
5
Context7 詳細教程

Context7 是最受歡迎的 MCP 服務器之一,可以讓 Claude Code 訪問最新的庫和框架文檔,避免使用過時的 API。

官網 獲取 API Key GitHub

安裝方式一:遠程連接(推薦,全局可用)

claude mcp add --transport http --scope user context7 https://mcp.context7.com/mcp --header "CONTEXT7_API_KEY: YOUR_API_KEY"

安裝方式二:本地運行

claude mcp add --scope user context7 -- npx -y @upstash/context7-mcp --api-key YOUR_API_KEY

使用方法 - 在提示詞中加入 use context7 即可讓 Claude Code 查詢最新文檔:

# 示例 用 Vue 3 創建一個響應式表單組件 use context7
!
注意事項
  • 每個項目啓用的 MCP 不要超過 10 個,活躍工具不超過 80 個
  • 200k 上下文窗口可能因工具過多縮減至 70k
  • 需要 API Key 的服務器請替換 YOUR_API_KEY 爲實際密鑰
  • 部分 MCP 服務器需要額外安裝依賴,請參考各自的官方文檔
!
CLAUDE.md 配置教程

CLAUDE.md 是 Claude Code 的指導文件,可以定義工作流程、編碼規範、工具策略等,讓 Claude Code 按照你的習慣工作。

官方文檔
1
配置文件位置

CLAUDE.md 支持全局和項目級別配置,項目級配置優先級更高:

全局 (macOS/Linux) ~/.claude/CLAUDE.md
全局 (Windows) %USERPROFILE%\.claude\CLAUDE.md
項目級別 .claude/CLAUDE.md
2
完整示例

以下是一個完整的 CLAUDE.md 配置示例,包含版本標識、工作流程、編碼規範等:

# CLAUDE.md - 工作指導 # 版本: ssx(260127.0) ## 版本標識規範 ═══════════════ 每次回覆開頭稱呼: ssx(版本號) 1. ~/.claude/CLAUDE.md 版本標識: ssx(yymmdd.n) - 每次更新此文件時,如果 yymmdd 是當天則 n+1,否則重置爲 yymmdd.0 - 每次回覆開頭使用此稱呼,以便確認規則是否生效 2. ./CLAUDE.md 版本標識: <yymmdd.n> - 每次更新項目 CLAUDE.md 時,按同樣規則更新版本號 - 在對話結尾顯示此標識,以便確認項目規則版本 ## CRITICAL CONSTRAINTS - 違反=任務失敗 ═══════════════════════════════════════ - 必須使用中文回覆 - 必須先獲取上下文 - 禁止生成惡意代碼 - 必須存儲重要知識 - 必須執行檢查清單 - 必須遵循質量標準 ## MANDATORY WORKFLOWS ═════════════════════ 執行前檢查清單: [ ] 中文 [ ] 上下文 [ ] 工具 [ ] 安全 [ ] 質量 標準工作流: 1. 分析需求 → 2. 獲取上下文 → 3. 選擇工具 → 4. 執行任務 → 5. 驗證質量 → 6. 存儲知識 研究-計劃-實施模式: 研究階段: 讀取文件理解問題,禁止編碼 計劃階段: 創建詳細計劃 實施階段: 實施解決方案 驗證階段: 運行測試驗證 提交階段: 創建提交和文檔 ## MANDATORY TOOL STRATEGY ═════════════════════════ 任務開始前必須執行: 1. memory 查詢相關概念 2. code-search 查找代碼片段 3. sequential-thinking 分析問題 4. 選擇合適子代理 任務結束後必須執行: 1. memory 存儲重要概念 2. code-search 存儲代碼片段 3. 知識總結歸檔 優先級調用策略: - Microsoft技術 → microsoft.docs.mcp - GitHub文檔 → context7 → deepwiki - 網頁搜索 → 內置搜索 → fetch → duckduckgo-search 文件寫入規範: - 單次使用 Write 工具寫入不要超過 5k token - 大文件必須分批寫入,避免超出限制 ## CODING RESTRICTIONS ═══════════════════ 編碼前強制要求: - 無明確編寫命令禁止編碼 - 無明確授權禁止修改文件 - 必須先完成sequential-thinking分析 ## QUALITY STANDARDS ═══════════════════ 工程原則:SOLID、DRY、關注點分離 代碼質量:清晰命名、合理抽象、必要註釋 性能意識:算法複雜度、內存使用、IO優化 測試思維:可測試設計、邊界條件、錯誤處理 ## SUBAGENT SELECTION ════════════════════ 必須主動調用合適子代理: - Python項目 → python-pro - C#/.NET項目 → csharp-pro - JavaScript/TypeScript → javascript-pro/typescript-pro - Unity開發 → unity-developer - 前端開發 → frontend-developer - 後端架構 → backend-architect - 雲架構 → cloud-architect/hybrid-cloud-architect - 數據庫優化 → database-optimizer - 安全審計 → security-auditor - 代碼審查 → code-reviewer - 測試自動化 → test-automator - 性能優化 → performance-engineer - DevOps部署 → deployment-engineer - 文檔編寫 → docs-architect - 錯誤調試 → debugger/error-detective ## ENFORCEMENT ══════════════ 強制觸發器:會話開始→檢查約束,工具調用前→檢查流程,回覆前→驗證清單 自我改進:成功→存儲,失敗→更新規則,持續→優化策略 ## 項目特定配置 (PROJECT-SPECIFIC CONFIGS) ═══════════════════════════════════════ ## 通用項目原則 - 文件名都用小寫,用 _ 連接 - 文字最小 14px - http_api 調用有封裝不會 reject,檢查 api 調用不用 try-catch - 需要安裝卸載的依賴告訴我,我自己安裝運行測試 - 定義方法用 const 不要用 function - 代碼註釋都用單行註釋 - 保持代碼簡潔,函數能一行返回就一行返回 - 數據庫只用最簡單的數據類型,不要搞數據庫關係,都用程序關聯 - 第三方庫統一放在 lib 文件導出(如 dayjs、decimal.js) - 項目內導入:`import { xxx } from "@/libs"` - 庫導入放頂部,項目內導入放下面,中間空一行 ## Vue 項目通用 - 不要用 || 加默認值 - css 都用 tailwind css4 - 時間用 dayjs 格式化爲 YYYY-MM-DD HH:mm:ss - 項目用 pnpm 管理,需要安裝的依賴告訴我 - 注意現有代碼風格,新代碼儘量簡單粗暴 - 代碼不要加 emoji
!
使用說明

複製後粘貼到對應路徑的 CLAUDE.md 文件中,根據你的需求修改內容即可。

  • 版本標識規範可以幫助你確認規則是否生效
  • CRITICAL CONSTRAINTS 定義了必須遵守的約束
  • MANDATORY WORKFLOWS 定義了工作流程
  • SUBAGENT SELECTION 定義了子代理選擇策略
  • 項目特定配置可以根據你的項目需求自定義
!
OpenClaw 配置教程

OpenClaw(原 Clawdbot/Moltbot)是一個開源的個人 AI 助手系統,支持多種消息渠道(WhatsApp、Telegram、Discord 等)和多個 AI 模型提供商。通過配置自定義 provider 可以連接中轉服務。

官方文檔 GitHub
1
系統要求

Node.js >= 22,支持 Windows 原生或 WSL2

官方推薦使用 WSL2,但原生 Windows 也可以使用。

Node.js 安裝教程

已安裝 Node.js?運行 node --version 驗證,有版本號可跳過此步驟

方法一:官網下載(推薦)

打開 https://nodejs.org/,下載 LTS 版本,雙擊安裝。

方法二:nvm-windows(多版本管理)

下載 nvm-setup.exe 從 GitHub Releases

nvm install lts nvm use lts

方法三:包管理器

# WinGet winget install OpenJS.NodeJS.LTS # Chocolatey choco install nodejs

驗證安裝:

node --version npm --version
2
安裝 OpenClaw

使用 npm 全局安裝 OpenClaw:

# 全局安裝 npm install -g openclaw@latest # 國內鏡像加速安裝 npm install -g openclaw@latest --registry=https://registry.npmmirror.com # 驗證安裝 openclaw --version
4
配置中轉服務

編輯配置文件,添加自定義 provider 連接中轉服務:

配置文件位置:C:\Users\用戶名\.openclaw\openclaw.json

打開配置文件(PowerShell):

notepad $env:USERPROFILE\.openclaw\openclaw.json # 或使用 VS Code code $env:USERPROFILE\.openclaw\openclaw.json
1
系統要求

Node.js >= 22,支持 macOS

Node.js 安裝教程

已安裝 Node.js?運行 node --version 驗證,有版本號可跳過此步驟

方法一:Homebrew(推薦)

brew install node

方法二:nvm(多版本管理)

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash source ~/.zshrc nvm install --lts
國內下載慢?點擊查看加速安裝方式
# 大陸加速安裝 nvm export NVM_SOURCE=https://gitee.com/mirrors/nvm.git curl -o- https://gitee.com/mirrors/nvm/raw/master/install.sh | bash

驗證安裝:

node --version npm --version
2
安裝 OpenClaw

使用 npm 全局安裝 OpenClaw:

# 全局安裝 npm install -g openclaw@latest # 國內鏡像加速安裝 npm install -g openclaw@latest --registry=https://registry.npmmirror.com # 驗證安裝 openclaw --version
4
配置中轉服務

編輯配置文件,添加自定義 provider 連接中轉服務:

配置文件位置:~/.openclaw/openclaw.json

打開配置文件(終端):

nano ~/.openclaw/openclaw.json # 或使用 VS Code code ~/.openclaw/openclaw.json
1
系統要求

Node.js >= 22,支持 Linux / WSL

Node.js 安裝教程

已安裝 Node.js?運行 node --version 驗證,有版本號可跳過此步驟

方法一:nvm(推薦)

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash source ~/.bashrc nvm install --lts
國內下載慢?點擊查看加速安裝方式
# 大陸加速安裝 nvm export NVM_SOURCE=https://gitee.com/mirrors/nvm.git curl -o- https://gitee.com/mirrors/nvm/raw/master/install.sh | bash

方法二:包管理器

# Ubuntu/Debian curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash - sudo apt-get install -y nodejs

驗證安裝:

node --version npm --version
2
安裝 OpenClaw

使用 npm 全局安裝 OpenClaw:

# 全局安裝 npm install -g openclaw@latest # 國內鏡像加速安裝 npm install -g openclaw@latest --registry=https://registry.npmmirror.com # 驗證安裝 openclaw --version
4
配置中轉服務

編輯配置文件,添加自定義 provider 連接中轉服務:

配置文件位置:~/.openclaw/openclaw.json

打開配置文件(終端):

nano ~/.openclaw/openclaw.json # 或使用 VS Code code ~/.openclaw/openclaw.json
3
運行初始化嚮導

運行初始化嚮導完成基本配置:

openclaw onboard --install-daemon

嚮導選項說明:

Security 安全確認 Yes
Onboarding mode Manual (手動配置)
What do you want to set up? Local gateway (this machine)
Model/auth provider Skip for now 或 Back
Gateway port 18789 (默認)
Gateway bind LAN (0.0.0.0)
Gateway auth Token
Tailscale exposure Off (除非需要遠程訪問)
Configure chat channels now? No (先跳過)
Set GOOGLE_PLACES_API_KEY? No
Configure skills now? No 或 Skip for now

嚮導完成後會自動安裝 Gateway 後臺服務。如果提示 "Model check: No auth configured",這是正常的,後面會手動配置中轉服務。

4
配置文件位置
macOS / Linux ~/.openclaw/openclaw.json
Windows C:\Users\用戶名\.openclaw\openclaw.json
⚠️ 重要:不同分組的 URL 不同!請先到「餘額查詢」頁面查看你的分組接入地址,使用你自己的 URL 替換配置中的 baseUrl。
5
完整配置示例(Claude 分組)
{ "agents": { "defaults": { "workspace": "~/clawd", "model": { "primary": "nexus/claude-opus-4-6" }, "compaction": { "mode": "safeguard" }, "maxConcurrent": 4, "subagents": { "maxConcurrent": 8 } } }, "models": { "mode": "merge", "providers": { "nexus": { "baseUrl": "https://new.your-agent.cc", "apiKey": "sk-xxx你的密鑰xxx", "api": "anthropic-messages", "models": [ { "id": "claude-sonnet-4-5-20250929", "name": "Claude Sonnet 4.5", "contextWindow": 180000, "maxTokens": 8192 }, { "id": "claude-opus-4-5-20251101", "name": "Claude Opus 4.5", "contextWindow": 180000, "maxTokens": 8192 }, { "id": "claude-opus-4-6", "name": "Claude Opus 4.6", "contextWindow": 180000, "maxTokens": 8192 } ] } } }, "messages": { "ackReactionScope": "group-mentions" }, "commands": { "native": "auto", "nativeSkills": "auto" }, "gateway": { "port": 18789, "mode": "local", "bind": "lan", "auth": { "mode": "token", "token": "undefined" }, "tailscale": { "mode": "off", "resetOnExit": false } }, "skills": { "install": { "nodeManager": "npm" } } }

將 sk-xxx你的密鑰xxx 替換爲你的密鑰

6
驗證配置

配置完成後,運行以下命令驗證:

# 檢查配置問題 openclaw doctor # 查看已配置的模型 openclaw models list

如果 models list 顯示你配置的模型且 Auth 爲 yes,說明配置成功!

7
啓動使用

啓動 Gateway 服務並開始使用:

# 啓動 Gateway 服務(後臺運行) openclaw gateway install openclaw gateway start # 或前臺運行(可以看到日誌,調試用) openclaw gateway --verbose # 啓動 TUI 交互界面 openclaw tui # 命令行對話 openclaw agent --agent main --message "Hello"
!
常用命令
openclaw gateway 前臺啓動 Gateway 服務
openclaw gateway --verbose 前臺啓動並顯示詳細日誌
openclaw gateway install 安裝 Gateway 後臺服務
openclaw gateway start 啓動後臺服務
openclaw gateway stop 停止後臺服務
openclaw tui 啓動 TUI 交互界面
openclaw models list 查看已配置的模型
openclaw doctor 檢查配置問題
openclaw doctor --fix 自動修復配置問題
openclaw plugins enable telegram 啓用 Telegram 插件
!
常見配置問題

baseUrl 格式錯誤(最常見)

  • 正確 "baseUrl": "https://xxx.xxx.xxx"
  • 錯誤 "baseUrl": "https://xxx.xxx.xxx/" (末尾多了斜槓)
  • 錯誤 "baseUrl": "https://xxx.xxx.xxx/api" (多了 /api)
  • 錯誤 "baseUrl": "https://xxx.xxx.xxx/v1" (路徑錯誤)

gateway.mode 未設置

必須設置 gateway.mode,否則會報錯 "Gateway start blocked"

模型格式錯誤

  • 正確 "primary": "nexus/claude-opus-4-6"
  • 錯誤 "primary": "claude-opus-4-6"
!
故障排查
# 檢查配置問題 openclaw doctor # 自動修復 openclaw doctor --fix # 查看模型狀態 openclaw models status # 查看日誌 openclaw logs --follow
No API key found 檢查 apiKey 配置是否正確
Gateway start blocked 添加 "mode": "local" 到 gateway 配置
Connection refused 檢查 baseUrl 和網絡連接
401 Unauthorized 檢查 apiKey 是否正確
404 Not Found 檢查 baseUrl 路徑是否正確
配置 Telegram

OpenClaw 需要配置一個對話界面來使用,目前暫不支持微信。以下以 Telegram 爲例:

1. 獲取 Telegram Bot Token

  • 在 Telegram 中搜索 @BotFather
  • 發送 /newbot
  • 按提示設置 bot 名稱
  • 獲得 Bot Token(格式:123456789:ABCdefGHIjklMNOpqrsTUVwxyz)

2. 啓用 Telegram 插件

openclaw plugins enable telegram

3. 配置 Bot Token

openclaw config set channels.telegram.botToken "YOUR_BOT_TOKEN"

4. 啓動 Gateway

openclaw gateway # 如果報錯,先停止再啓動 openclaw gateway stop openclaw gateway

5. 配對驗證

  • 在 Telegram 中找到你的 bot,發送任意消息
  • Bot 會返回一個驗證碼
  • 在終端執行:
openclaw pairing approve telegram YOUR_CODE

完成配對後即可在 Telegram 中與 AI 對話!

!
更多信息

更多配置選項請參考 OpenClaw 官方文檔。如遇問題可運行 openclaw doctor --fix 自動修復。

官方文檔 GitHub
!
常見問題

安裝和使用過程中常見問題的解決方案。

安裝時提示 "permission denied"

以管理員身份運行 PowerShell,或配置 npm 使用用戶目錄:

npm config set prefix %APPDATA%\npm
PowerShell 執行策略錯誤

運行以下命令解除限制:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
環境變量設置後不生效

重新打開 PowerShell 或註銷重新登錄。

Git 版本過舊導致中文路徑報錯

Git 2.24.0 及更早版本(2019年)的 cygpath.exe 無法正確處理 UTF-8/Unicode 字符,會導致 Claude Code 在中文目錄下報錯。建議升級到 Git 2.40+ 版本。

方案一:升級 Git(推薦)

winget upgrade Git.Git

方案二:使用 Windows 短路徑繞過中文

在 PowerShell 中獲取短路徑,然後用短路徑進入目錄啓動 Claude Code:

cmd /c 'for %A in ("F:\項目\my-app") do @echo %~sA'

方案三:創建英文符號鏈接

以管理員身份運行終端,創建英文路徑指向中文路徑:

cmd /c mklink /D "F:\projects\my-app" "F:\項目\my-app"