如需完整的文件索引,請參閱 llms.txt。在文件頁面的網址末尾加上 .md ,即可取得該頁面的 Markdown 版本。
主要導覽
主題

Codex CLI

在終端中檢視、編輯及執行程式碼

直接在終端中檢視及修改程式碼、執行指令,並將重複性工作自動化。

$ codex
╭──────────────────────────────────────────────────╮
│ >_ OpenAI Codex                                  │
│                                                  │
│ model:     gpt-6.1-sol medium/model to change │
│ directory: ~/code                                │
╰──────────────────────────────────────────────────╯

  To get started, describe a task or try one of these commands:

  /init - create an AGENTS.md file with instructions for Codex
  /status - show current session configuration
  /permissions - choose what Codex is allowed to do
  /model - choose what model and reasoning effort to use
  /review - review any changes and find issues
      

› Refactor the Dashboard component to React Hooks
      
  100% context left · ? for shortcuts
      
01

在本機程式碼庫中工作

讓 Codex 檢視及編輯檔案,並執行電腦上已安裝的工具。

02

自行掌控執行方式

選擇適合任務的模型、推理程度、權限與指令。

03

整合指令碼與 CI

以互動方式使用 Codex,或在可重複執行的工作流程與管線中呼叫 codex exec。

快速入門

開始使用 Codex CLI

安裝 Codex 並登入,然後在專案目錄中執行第一個任務。

  1. 安裝 Codex

    在 macOS 和 Linux 上,使用獨立安裝程式安裝 Codex CLI。

    安裝 Codex

    curl -fsSL https://chatgpt.com/codex/install.sh | sh

    更新 Codex

    curl -fsSL https://chatgpt.com/codex/install.sh | sh
  2. 執行 Codex 並登入

    Open a project directory and run codex. The first time you run Codex, choose 使用 ChatGPT 登入 or another available sign-in method.

    查看身分驗證選項
  3. 開始第一個任務

    描述你想完成的事。例如,你可以請 Codex 說明專案內容、針對特定需求進行修改,或協助你偵錯。

    Tell me about this project

    在任務開始前和完成後各建立一個 Git 檢查點,以便還原變更。請參閱 最佳實務.

探索 Codex CLI 的功能

在同一個終端中與 Codex 互動、自動執行工作、審查變更並委派任務。

01

在終端中完成程式開發流程

在程式碼庫中啟動 Codex,探索不熟悉的程式碼、規劃變更、編輯檔案,並執行本機開發工具。您可以在回合進行中隨時給予指示,即時查看指令與程式碼差異,並在同一個工作階段中處理後續工作。

瞭解更多
02

使用技能與外掛程式

將可重複使用的指示封裝成技能,再加入外掛程式,即可直接在 CLI 中讓 Codex 連接團隊的工具與資料。

瞭解更多
03

在發布前審查變更

您可以單獨審查尚未提交的變更、某次提交,或相對於基準分支的差異。Codex 會依優先順序列出發現的問題,過程中不會修改工作樹。您可以在提交變更或建立 pull request 前處理這些風險。

瞭解更多

了解如何運用 CLI 功能接續先前的工作階段、加入圖像與網頁資訊作為參考、拆解複雜工作,以及將 Codex 連接到你的開發工具。

01 codex resume

回到已儲存的對話

你可以重新開啟目前程式碼庫中的近期對話,也可以搜尋本機上的所有對話,繼續處理較早的工作。

02 codex --image

在提示詞中加入圖像作為參考

你可以在第一則提示詞中附上錯誤截圖、架構圖或設計參考資料,也可以將圖片貼入互動式撰寫工具。

03 subagents

拆解規模較大的調查工作

請 Codex 將調查拆成範圍明確的任務,分派給具備相應專長的智慧體,再將各項調查結果彙整到主要的終端工作階段中。

04 codex --search

搜尋最新背景資訊

如果任務需要參考最新版本、查閱最新文件或確認外部系統目前的行為,可以在執行過程中切換為即時網頁搜尋。搜尋過程會保留在對話記錄中,方便隨時查看。

05 codex cloud

將工作移至 Codex 雲端

你可以在終端瀏覽進行中和已完成的對話,將工作交給已設定的環境執行,並將結果套用至本機程式碼庫。

06 codex mcp

透過 MCP 連接外部工具

新增本機或遠端 MCP 伺服器,並視需要完成身分驗證。在 Codex 使用工具前,你可以先查看目前工作階段有哪些工具可用。

07 /permissions

設定每次執行的權限範圍

設定 Codex 在哪些情況下可以直接編輯檔案或執行指令,無須先要求核准。繼續操作前,請先查看目前使用的沙盒與可寫入的根目錄。

08 codex completion

依照終端使用習慣調整 Codex

為你的 shell 產生指令自動補完設定、選擇語法配色主題,並使用 VISUAL 或 EDITOR 指定的編輯器開啟較長的提示詞。

哪些情況適合使用 Codex CLI?

習慣在終端中工作

在同一個工作流程中探索、編輯並執行程式碼庫中的程式。

需要使用指令碼或 CI

在可重複執行的工作流程中執行非互動式指令。

想在本機審查程式碼

在提交變更或建立 pull request 前,先檢視修改內容。

想將工作交給雲端處理

啟動雲端對話,稍後再回到終端。