入門指南
在尋找特定的東西?跳到前面:
- 技巧和快捷方式 – 熱鍵、恢復流、提示
- 非交互式運行 – 使用
codex exec自動化 - 準備好更深層的自定義?請參閱
advanced.md
CLI 用法
| 命令 | 目的 | 示例 |
|---|---|---|
codex | 交互式 TUI | codex |
codex "..." | 交互式 TUI 的初始提示 | codex "fix lint errors" |
codex exec "..." | 非交互式"自動化模式" | codex exec "explain utils.ts" |
關鍵標誌:--model/-m、--ask-for-approval/-a。
恢復交互式會話
- 運行
codex resume以顯示會話選擇器 UI - 恢復最近的:
codex resume --last - 按 ID 恢復:
codex resume <SESSION_ID>(您可以從 /status 或~/.codex/sessions/獲取會話 ID) - 選擇器在可用時顯示會話的記錄 Git 分支。
- 要顯示會話的原始工作目錄 (CWD),請運行
codex resume --all(這也禁用 cwd 過濾並添加CWD列)。
示例:
# 打開最近會話的選擇器
codex resume
# 恢復最近的會話
codex resume --last
# 按 ID 恢復特定會話
codex resume 7f9f9a2e-1b3c-4c7a-9b0e-123456789abc使用提示作為輸入運行
您也可以使用提示作為輸入運行 Codex CLI:
codex "explain this codebase to me"示例提示
以下是一些可複製粘貼的簡短示例。用您自己的任務替換引號中的文本。
| ✨ | 您輸入的內容 | 發生的事情 |
|---|---|---|
| 1 | codex "Refactor the Dashboard component to React Hooks" | Codex 重寫類組件,運行 npm test,並顯示 diff。 |
| 2 | codex "Generate SQL migrations for adding a users table" | 推斷您的 ORM,創建遷移文件,並在沙箱數據庫中運行它們。 |
| 3 | codex "Write unit tests for utils/date.ts" | 生成測試,執行它們,並迭代直到它們通過。 |
| 4 | codex "Bulk-rename *.jpeg -> *.jpg with git mv" | 安全地重命名文件並更新導入/使用。 |
| 5 | codex "Explain what this regex does: ^(?=.*[A-Z]).{8,}$" | 輸出分步的人工解釋。 |
| 6 | codex "Carefully review this repo, and propose 3 high impact well-scoped PRs" | 提議當前代碼庫中有影響力的 PR。 |
| 7 | codex "Look for vulnerabilities and create a security review report" | 查找並說明安全錯誤。 |
想要重複使用您自己的說明?使用自定義提示創建斜杠命令。
使用 AGENTS.md 進行內存
您可以使用 AGENTS.md 文件向 Codex 提供額外的說明和指導。Codex 在以下位置查找它們,並從上到下合併:
~/.codex/AGENTS.md- 個人全局指導- 從存儲庫根到您的當前工作目錄的每個目錄(包含)。在每個目錄中,Codex 首先查找
AGENTS.override.md,如果存在則使用它;否則回退到AGENTS.md。當您想要替換該目錄的繼承說明時,使用覆蓋形式。
有關如何使用 AGENTS.md 的更多信息,請參閱官方 AGENTS.md 文檔。
技巧和快捷方式
使用 @ 進行文件搜索
輸入 @ 會觸發在工作區根上的模糊文件名搜索。使用上/下在結果中選擇並按 Tab 或 Enter 將 @ 替換為所選路徑。您可以使用 Esc 取消搜索。
Esc–Esc 編輯上一條消息
當聊天編輯器為空時,按 Esc 鍵啟動"回溯"模式。再次按 Esc 打開突出顯示最後一條用戶消息的成績單預覽;重複按 Esc 以前進到較舊的用戶消息。按 Enter 確認,Codex 將從該點分叉對話,相應地修整可見的成績單,並使用所選的用戶消息預填編輯器,以便您可以編輯並重新提交。
在成績單預覽中,編輯活躍時頁腳顯示 Esc edit prev 提示。
--cd/-C 標誌
有時,在運行 Codex 之前,不方便 cd 到您希望 Codex 用作"工作根"的目錄。幸運的是,codex 支持 --cd 選項,以便您可以指定任何想要的文件夾。您可以通過雙擊檢查 TUI 在新會話開始時報告的工作目錄來確認 Codex 正在遵守 --cd。
--add-dir 標誌
需要在一次運行中跨多個項目工作?多次傳遞 --add-dir 以將額外的目錄公開為當前會話的可寫根,同時保持主工作目錄不變。例如:
codex --cd apps/frontend --add-dir ../backend --add-dir ../shared然後 Codex 可以檢查和編輯每個列出的目錄中的文件,而不會離開主工作區。
Shell 完成
通過以下方式生成 shell 完成腳本:
codex completion bash
codex completion zsh
codex completion fish圖像輸入
直接將圖像粘貼到編輯器中(Ctrl+V / Cmd+V)以將其附加到您的提示。您也可以使用 CLI 通過 -i/--image(逗號分隔)附加文件:
codex -i screenshot.png "Explain this error"
codex --image img1.png,img2.jpg "Summarize these diagrams"環境變量和可執行文件
在啟動 Codex 之前確保您的環境已經設置,以便它不會花費標記來探測要激活什麼。例如,源您的 Python virtualenv(或其他語言運行時)、啟動任何所需的守護程序,並提前導出您期望使用的環境變量。