Codex Docs 入门指南
English

入门指南

CLI 使用方法

命令 用途 示例
codex 交互式 TUI codex
codex "..." 交互式 TUI 的初始提示 codex "修复 lint 错误"
codex exec "..." 非交互式"自动化模式" codex exec "解释 utils.ts"

主要标志:--model/-m--ask-for-approval/-a

恢复交互式会话

示例:

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

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

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

使用提示作为输入运行

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

codex "向我解释这个代码库"
codex --full-auto "创建最精美的待办事项应用程序"

就这样 - Codex 将会搭建一个文件,在沙盒中运行它,安装任何缺失的依赖项,并向你显示实时结果。批准这些更改,它们将被提交到你的工作目录。

示例提示

以下是一些你可以复制粘贴的小型示例。将引号中的文本替换为你自己的任务。

你输入的内容 发生的情况
1 codex "将 Dashboard 组件重构为 React Hooks" Codex 重写类组件,运行 npm test,并显示差异。
2 codex "为添加用户表生成 SQL 迁移" 推断你的 ORM,创建迁移文件,并在沙盒数据库中运行它们。
3 codex "为 utils/date.ts 编写单元测试" 生成测试,执行它们,并迭代直到它们通过。
4 codex "使用 git mv 批量重命名 *.jpeg -> *.jpg" 安全地重命名文件并更新导入/使用。
5 codex "解释这个正则表达式的作用:^(?=.*[A-Z]).{8,}$" 输出逐步的人工解释。
6 codex "仔细审查这个仓库,并提出 3 个高影响、范围明确的 PR" 在当前代码库中建议有影响力的 PR。
7 codex "查找漏洞并创建安全审查报告" 查找并解释安全漏洞。

使用 AGENTS.md 的记忆功能

你可以使用 AGENTS.md 文件给 Codex 额外的指导和指示。Codex 在以下位置查找 AGENTS.md 文件,并按自上而下的顺序合并它们:

  1. ~/.codex/AGENTS.md - 个人全局指导
  2. 仓库根目录的 AGENTS.md - 共享项目说明
  3. 当前工作目录中的 AGENTS.md - 子文件夹/功能特定说明

有关如何使用 AGENTS.md 的更多信息,请参阅 官方 AGENTS.md 文档

提示和快捷方式

使用 @ 进行文件搜索

输入 @ 触发对工作区根目录的模糊文件名搜索。使用上下箭头在结果中选择,使用 Tab 或 Enter 用选定路径替换 @。你可以使用 Esc 取消搜索。

图像输入

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

codex -i screenshot.png "解释这个错误"
codex --image img1.png,img2.jpg "总结这些图表"

Esc–Esc 编辑之前的消息

当聊天编辑器为空时,按 Esc 激活"回溯"模式。再次按 Esc 打开转录预览,突出显示最后一条用户消息;重复按 Esc 以跳转到更早的用户消息。按 Enter 确认,Codex 将从该点分叉对话,相应地修剪可见的转录,并用选定的用户消息预填充编辑器,以便你可以编辑并重新提交。

在转录预览中,页脚在编辑激活时显示 Esc edit prev 提示。

Shell 补全

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

codex completion bash
codex completion zsh
codex completion fish

--cd/-C 标志

有时候在运行 Codex 之前 cd 到你希望 Codex 用作"工作根目录"的目录并不方便。幸运的是,codex 支持 --cd 选项,因此你可以指定任何你想要的文件夹。你可以通过双重检查 Codex 在新会话开始时在 TUI 中报告的 workdir 来确认 Codex 是否遵守 --cd