Skip to content

npm i -g @openai/codex
brew install --cask codex

Codex CLI 是來自OpenAI的本地編程智能體,可在您的計算機上運行。 如果您想在代碼編輯器中使用 Codex(VS Code、Cursor、Windsurf),請在您的IDE中安裝 如果您在尋找來自OpenAI的雲端智能體——Codex Web,請訪問 chatgpt.com/codex

Codex CLI splash


快速開始

安裝和運行 Codex CLI

使用您喜歡的包管理器進行全局安裝。如果您使用 npm:

shell
npm install -g @openai/codex

或者,如果您使用 Homebrew:

shell
brew install --cask codex

然後簡單地運行 codex 開始使用:

shell
codex

如果您遇到 Homebrew 升級問題,請查看 FAQ 中關於 brew upgrade codex 的條目

您也可以訪問 最新的 GitHub 發佈頁面並為您的平台下載相應的二進制文件。

每個 GitHub 發佈版本都包含許多可執行文件,但實際上您可能需要以下之一:

  • macOS
    • Apple Silicon/arm64: codex-aarch64-apple-darwin.tar.gz
    • x86_64(較舊的 Mac 硬件): codex-x86_64-apple-darwin.tar.gz
  • Linux
    • x86_64: codex-x86_64-unknown-linux-musl.tar.gz
    • arm64: codex-aarch64-unknown-linux-musl.tar.gz

每個歸檔文件都包含一個單一條目,其平台名稱已嵌入其中(例如,codex-x86_64-unknown-linux-musl),因此在提取後您可能需要將其重命名為 codex

使用您的 ChatGPT 計劃使用 Codex

Codex CLI login

運行 codex 並選擇使用 ChatGPT 登入。我們建議您登入您的 ChatGPT 賬戶以將 Codex 用作您的 Plus、Pro、Team、Edu 或 Enterprise 計劃的一部分。詳細了解 ChatGPT 計劃中包含的內容

您也可以使用 Codex 與 API 密鑰一起,但這需要額外的設置。如果您之前使用 API 密鑰進行基於使用情況的計費,請查看遷移步驟。如果您在登入時遇到問題,請在此問題中評論。

模型上下文協議(MCP)

Codex 可以訪問 MCP 服務器。要配置它們,請參考配置文檔

配置

Codex CLI 支持一套豐富的配置選項,偏好設置存儲在 ~/.codex/config.toml 中。有關完整的配置選項,請參見配置

執行策略

請參見執行策略快速入門來設置管理 Codex 可以執行哪些命令的規則。

文檔與常見問題


許可證

此倉庫根據 Apache-2.0 License 獲得許可。