Skip to content

Codex 使用技巧

OpenAI Codex 提供 app、CLI、IDE 插件和 Cloud 等使用方式。日常编写代码、修改文件、查看 Git diff、管理分支时,建议优先使用带可视化界面的 Codex app。它可以集中查看项目、会话(thread)、diff、暂存区、分支、提交和推送状态。

如果你更习惯终端,或者需要在服务器、WSL、脚本化场景里使用 Codex,则推荐安装 CLI:

bash
npm i -g @openai/codex@latest

Waihub 的 Codex 配置请先看:手动配置 Codex。建议先完成 config.tomlauth.json,再回到本页学习使用技巧。

项目路径怎么管理

Codex app 中的 Project 表示 Codex 开始工作的项目目录。第一次打开 app 时,选择需要处理的项目文件夹;之后可以在侧边栏切换已打开过的项目。

在 Codex app 中打开项目目录
在 Codex app 中打开项目目录。

新建会话怎么选模式

Codex app 新建会话(thread)时,通常会看到 LocalWorktreeCloud 三类模式。

Local(本地开发首选)

Local 会直接在当前项目目录中工作,适合本地开发、日常验证和小范围修改。选择该模式前,建议确认当前分支和未提交改动。

在 Codex app 中选择 Local 模式
在 Codex app 中选择 Local 模式。

Worktree

Worktree 会基于 Git 分支创建隔离工作区,适合新功能、大范围重构,或不希望影响当前工作目录的任务。它要求项目本身是 Git 仓库,工作区位置默认由 Codex 管理;如需把结果带回本地,可以在 Worktree 中提交并推送,或使用 Hand off 交回 Local

注意

同一个 Git 分支不能同时被两个 worktree checkout。如果你已经在 Worktree 里创建并 checkout 了某个分支,就不要再在本地目录里 checkout 同一个分支。需要本地验证时,优先使用 Hand off

Cloud

Cloud 会在远端配置好的环境中运行,适合已经接入 GitHub、需要远程执行任务并生成 Pull Request 的团队工作流。只使用 Waihub 本地配置时,日常优先从 LocalWorktree 开始。

plan mode 怎么用

处理复杂任务时,建议先使用 plan mode。Codex 会先阅读相关代码、识别约束并拆解步骤,再进入实现阶段。

在 Codex app 中:

在 Codex app 中使用 plan mode
输入 / 启动计划模式。
Codex app 中的计划内容
点击启动计划模式。

在 Codex CLI 中:

text
/plan

也可以直接带上任务:

text
/plan 先分析登录流程,给出最小改动方案,不要直接修改文件

好的计划提示可以包含四块内容:

text
目标:我要实现什么
上下文:哪些文件、页面、错误、接口最相关
约束:不要改哪些东西,必须沿用什么风格
完成标准:怎样验证算完成,例如测试通过、页面可访问、diff 可审查

建议

如果计划范围过大,可以要求 Codex 收窄改动范围;如果计划缺少验证步骤,可以要求补充测试、构建或人工检查项。plan mode 的价值在于提前明确约束、风险和验收方式。

如何审查代码

Codex app 的 Review 面板用于查看和处理 Git diff。可以在 diff pane 中检查文件改动,并针对具体行留下修改意见。

在 Review 面板查看 Git diff
在 Review 面板查看 Git diff。

Git 提交和推送

在 Codex app 中提交并推送 Git 改动
在 Codex app 中提交并推送 Git 改动。

提交前检查

Review 面板展示的是整个 Git 仓库的状态,不只包含 Codex 改过的文件。如果你自己之前有未提交改动,它也会出现在里面。提交前一定确认 staged files 只包含这次任务需要的内容。

CLI 常用命令

安装后,在项目目录中启动:

bash
codex

CLI 会把当前目录作为工作目录。常用 slash commands:

  • /plan:进入 plan mode,先规划再执行
  • /diff:查看当前 Git diff,包括未跟踪文件
  • /review:审查当前工作区改动
  • /new:在同一个 CLI 会话中开启新对话
  • /resume:恢复之前保存的会话
  • /status:查看当前模型、权限、上下文和工作目录
  • /permissions:调整审批策略
  • /init:生成 AGENTS.md 初稿
  • /compact:长会话压缩上下文
  • /quit:退出 CLI

写好 AGENTS.md

AGENTS.md 是 Codex 的仓库说明文件,会自动进入上下文,适合记录团队长期有效的规则。

参考资料

Waihub Documentation