入门
CLI 使用方法
命令 | 作用 | 示例 |
---|---|---|
codex |
交互式 TUI | codex |
codex "..." |
为交互式 TUI 提供初始 prompt | 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)
示例:
# 打开最近会话的选择器
codex resume
# 恢复最近一次会话
codex resume --last
# 根据 id 恢复指定会话
codex resume 7f9f9a2e-1b3c-4c7a-9b0e-123456789abc
使用 prompt 作为输入运行
你也可以直接通过 prompt 来运行 Codex CLI:
codex "explain this codebase to me"
codex --full-auto "create the fanciest todo-list app"
Codex 会自动生成一个文件,在沙箱中运行,安装缺失的依赖,并展示实时结果。你确认变更后,它们就会被提交到工作目录。
示例 prompts
下面是一些可以复制粘贴的示例,你只需要把引号里的内容换成自己的任务。
✨ | 你输入的命令 | Codex 会做的事 |
---|---|---|
1 | codex "Refactor the Dashboard component to React Hooks" |
Codex 会把 class 组件改写成 React Hooks,运行 npm test 并展示 diff。 |
2 | codex "Generate SQL migrations for adding a users table" |
推断你的 ORM,生成 migration 文件,并在沙箱数据库中运行它们。 |
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" |
为当前代码库建议 3 个有影响力且范围明确的 PR。 |
7 | codex "Look for vulnerabilities and create a security review report" |
查找并解释安全漏洞。 |
使用 AGENTS.md 来提供记忆
你可以通过 AGENTS.md
文件为 Codex 提供额外的指令和指导。Codex 会按照以下顺序查找并自上而下合并 AGENTS.md
文件:
~/.codex/AGENTS.md
- 个人全局指导- 代码库根目录下的
AGENTS.md
- 项目共享笔记 - 当前工作目录下的
AGENTS.md
- 针对子文件夹/功能的特定说明
更多关于 AGENTS.md
的用法,请参考 官方 AGENTS.md 文档。
小技巧 & 快捷操作
使用 @
进行文件搜索
输入 @
会触发工作区根目录下的模糊文件名搜索。使用上下键选择结果,按 Tab 或 Enter 来替换 @
为选中的路径。按 Esc 可以取消搜索。
图片输入
你可以直接在 composer 中粘贴图片(Ctrl+V / Cmd+V)来把它附加到 prompt。
也可以通过 CLI 参数 -i/--image
附加文件(支持逗号分隔):
codex -i screenshot.png "Explain this error"
codex --image img1.png,img2.jpg "Summarize these diagrams"
Esc–Esc 编辑上一条消息
当输入框为空时,按 Esc 会进入“回溯模式”。再次按 Esc 会打开历史消息预览并高亮上一个用户消息;多次按 Esc 可以依次回溯更早的消息。按 Enter 确认后,Codex 会从该点分叉会话、修剪可见对话,并将选中的消息填入输入框供你修改后重新提交。
在历史预览中,底部会显示 Esc edit prev
提示。
Shell 自动补全
你可以生成 Shell 补全脚本:
codex completion bash
codex completion zsh
codex completion fish
--cd
/-C
参数
有时你不方便先 cd
到 Codex 需要使用的目录。
此时可以直接用 --cd
指定目录。
你可以在 TUI 新会话开始时查看 Codex 报告的 workdir,确认它是否正确使用了 --cd
。