Skip to content

入门指南

在寻找特定的东西?跳到前面:

CLI 用法

命令目的示例
codex交互式 TUIcodex
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 列)。

示例:

shell
# 打开最近会话的选择器
codex resume

# 恢复最近的会话
codex resume --last

# 按 ID 恢复特定会话
codex resume 7f9f9a2e-1b3c-4c7a-9b0e-123456789abc

使用提示作为输入运行

您也可以使用提示作为输入运行 Codex CLI:

shell
codex "explain this codebase to me"

示例提示

以下是一些可复制粘贴的简短示例。用您自己的任务替换引号中的文本。

您输入的内容发生的事情
1codex "Refactor the Dashboard component to React Hooks"Codex 重写类组件,运行 npm test,并显示 diff。
2codex "Generate SQL migrations for adding a users table"推断您的 ORM,创建迁移文件,并在沙箱数据库中运行它们。
3codex "Write unit tests for utils/date.ts"生成测试,执行它们,并迭代直到它们通过。
4codex "Bulk-rename *.jpeg -> *.jpg with git mv"安全地重命名文件并更新导入/使用。
5codex "Explain what this regex does: ^(?=.*[A-Z]).{8,}$"输出分步的人工解释。
6codex "Carefully review this repo, and propose 3 high impact well-scoped PRs"提议当前代码库中有影响力的 PR。
7codex "Look for vulnerabilities and create a security review report"查找并说明安全错误。

想要重复使用您自己的说明?使用自定义提示创建斜杠命令。

使用 AGENTS.md 进行内存

您可以使用 AGENTS.md 文件向 Codex 提供额外的说明和指导。Codex 在以下位置查找它们,并从上到下合并:

  1. ~/.codex/AGENTS.md - 个人全局指导
  2. 从存储库根到您的当前工作目录的每个目录(包含)。在每个目录中,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 以将额外的目录公开为当前会话的可写根,同时保持主工作目录不变。例如:

shell
codex --cd apps/frontend --add-dir ../backend --add-dir ../shared

然后 Codex 可以检查和编辑每个列出的目录中的文件,而不会离开主工作区。

Shell 完成

通过以下方式生成 shell 完成脚本:

shell
codex completion bash
codex completion zsh
codex completion fish

图像输入

直接将图像粘贴到编辑器中(Ctrl+V / Cmd+V)以将其附加到您的提示。您也可以使用 CLI 通过 -i/--image(逗号分隔)附加文件:

bash
codex -i screenshot.png "Explain this error"
codex --image img1.png,img2.jpg "Summarize these diagrams"

环境变量和可执行文件

在启动 Codex 之前确保您的环境已经设置,以便它不会花费标记来探测要激活什么。例如,源您的 Python virtualenv(或其他语言运行时)、启动任何所需的守护程序,并提前导出您期望使用的环境变量。