yycode × Codex 快速開始指南

前置條件：安裝 Node.js 環境

Codex 依賴 Node.js 執行環境，請先參考 Node.js 環境安裝指南完成安裝並驗證。

更省事的方式：自動設定

如果你不想手動安裝和逐項寫設定，推薦直接使用自動設定工具。

1. 安裝 Codex

# Windows
npm install -g @openai/codex@latest

# macOS / Linux
sudo npm install -g @openai/codex@latest

驗證安裝：

codex --version

輸出版本號即表示安裝成功。

2. 建立 API Key

登入 yycode 控制台，進入 權杖管理 頁面，點選 新增權杖。

填寫金鑰名稱，選擇Codex分組（模型和倍率），按需設定 IP 限制、額度限制、模型限制和有效期。新手建議直接使用預設設定。

安全提示：API Key 等同於帳號憑證，請妥善保管，切勿提交到程式碼儲存庫或公開分享。

3. 導入金鑰到 Codex

建立設定目錄

# Windows (PowerShell)
if (Test-Path "$env:USERPROFILE\.codex") { Remove-Item -Recurse -Force "$env:USERPROFILE\.codex" }
mkdir "$env:USERPROFILE\.codex"

# macOS / Linux
rm -rf ~/.codex && mkdir -p ~/.codex

建立 `config.toml`

在 ~/.codex/（Windows 為 %USERPROFILE%\.codex\）目錄下建立 config.toml：

model = "gpt-5.5"
model_provider = "yycode"

[model_providers.yycode]
name = "yycode New API"
base_url = "https://yycode.net/v1"
wire_api = "responses"
requires_openai_auth = true

建立 `auth.json`

點選金鑰旁的複製按鈕取得 API Key：

在同一目錄下建立 auth.json，將 YOUR_API_KEY 替換為你在控制台建立的金鑰：

{
  "auth_mode": "apikey",
  "OPENAI_API_KEY": "這裡填你在平台建立的 API Key"
}

4. 開始使用

進入任意專案目錄，執行：

codex

Codex 會自動分析目前目錄的程式碼並提供智慧編程輔助。更多用法請參考 OpenAI 官方文件。

常見問題（FAQ）

Q：執行 npm install -g 提示權限不足？
A：macOS / Linux 在指令前加 sudo；Windows 使用管理員權限執行 PowerShell。

Q：codex --version 提示指令不存在？
A：確認 npm 全域目錄已加入系統 PATH，可執行 npm bin -g 檢視路徑並手動新增。

Q：連接失敗或回傳 401 錯誤？
A：檢查 config.toml 中 base_url 是否為 https://yycode.net，以及 auth.json 中的 API Key 是否正確且未過期。

Q：如何切換不同模型或倍率？
A：在 yycode 控制台建立不同分組的金鑰，更新 auth.json 中的 Key，或通過 CC Switch 在多個設定間快速切換。