使用指南API 參考AI 應用

Codex CLI

Codex CLI 是 OpenAI 官方推出的終端智慧程式設計助手(CLI Agent)。它能夠在本地計算機上自主分析程式碼倉庫、執行終端命令、通過原子補丁(apply_patch)安全編輯檔案,為開發者提供高效的命令列自主程式設計工作流。

✨ AI 一鍵配置

複製下方提示詞傳送給您的 AI 助手,即可自動完成環境探測與安裝配置:

AI 配置提示词 (Prompt)
点击卡片任意位置复制
請參考 OpenRely 官方文件(https://openrely.ai/zh/docs/apps/codex-cli)幫我配置當前機器的 Codex CLI:
1. 獲取金鑰:若我尚未提供 API 金鑰,請先提醒我前往 OpenRely 控制台(https://api.openrely.ai/keys)建立並輸入
2. 安裝環境:檢查本機是否已安裝 Codex CLI,若未安裝則執行 npm install -g @openai/codex
3. 配置檔案:建立 ~/.codex 目錄,寫入配置檔案 ~/.codex/config.toml:
model_provider = "custom"
disable_response_storage = true
[model_providers.custom]
name = "custom"
base_url = "https://api.openrely.ai/v1"
wire_api = "responses"
在 ~/.codex/auth.json 中寫入 {"OPENAI_API_KEY": "<我的_API_KEY>"}(檔案許可權設定為 600)。
關於模型選擇:無需硬編碼特定模型版本,Codex 會話內可直接輸入 /model 動態選取最新模型(支援的模型列表可參考 OpenRely 模型廣場 https://api.openrely.ai/pricing)
4. 驗證就緒:執行 codex --version 檢查安裝狀態,並提示我直接輸入 codex 開啟程式設計會話

🔑 準備


🚀 步驟

全域性安裝 CLI

Codex CLI 是 OpenAI 推出的終端程式設計助手。通過 npm 全域性安裝官方 CLI 包,安裝後即可在終端直接呼叫 codex 命令:

npm install -g @openai/codex

配置端點與金鑰

Codex CLI 使用使用者主目錄下的 ~/.codex/config.toml 與 ~/.codex/auth.json 儲存服務端點與鑑權憑據:

在終端中執行以下命令,一鍵寫入配置目錄與憑據檔案:

# 1. 创建配置目录
mkdir -p ~/.codex

# 2. 写入自定义服务接入点(指向 OpenRely)
cat > ~/.codex/config.toml <<EOF
model_provider = "custom"
disable_response_storage = true

[model_providers.custom]
name = "custom"
base_url = "https://api.openrely.ai/v1"
wire_api = "responses"
EOF

# 3. 写入您的 OpenRely API Key
cat > ~/.codex/auth.json <<EOF
{
  "OPENAI_API_KEY": "sk-your-openrely-api-key"
}
EOF

chmod 600 ~/.codex/config.toml ~/.codex/auth.json

在 PowerShell 視窗中執行以下命令完成配置寫入:

# 1. 创建配置目录
New-Item -ItemType Directory -Force -Path "$HOME\.codex"

# 2. 写入自定义服务接入点(指向 OpenRely)
@"
model_provider = "custom"
disable_response_storage = true

[model_providers.custom]
name = "custom"
base_url = "https://api.openrely.ai/v1"
wire_api = "responses"
"@ | Out-File -Encoding utf8 "$HOME\.codex\config.toml"

# 3. 写入您的 OpenRely API Key
@"
{
  "OPENAI_API_KEY": "sk-your-openrely-api-key"
}
"@ | Out-File -Encoding utf8 "$HOME\.codex\auth.json"

啟動與驗證

進入您的程式碼專案根目錄,執行 codex 啟動互動式會話:

codex

首次進入互動介面後,您可以:

  1. 輸入 /model 挑選或核對當前使用的模型;
  2. 傳送一條測試指令驗證 API 連通性:
> 解释当前项目的整体架构设计

若能正常流式返回回覆,即表示已成功接入 OpenRely。


💡 常用

在 Codex CLI 互動會話中,常用的內建快捷指令:

指令說明
/model互動式檢視與即時切換模型(隨時選用最新模型)
/help檢視所有內建命令與配置選項
/clear清空當前對話上下文,開啟全新任務
/exit退出 Codex CLI 會話

❓ 常見問題

遇到其他呼叫報錯或計費疑問?請查閱完整的 常見問題與排障指南。

這篇文件對您有幫助嗎?

Codex CLI | OpenRely Docs