Codex-plugin-cc 实战教程:智能代码审查与任务委托
本教程将指导您如何安装和使用 Codex-plugin-cc,实现智能代码审查和任务委托。通过本教程,您将能够使用 Codex 从 Claude Code 内部进行代码审查、委托任务和管理背景作业。
1. 安装和配置 Codex-plugin-cc
要使用 Codex-plugin-cc,首先我们需要安装和配置它。这个过程其实并不复杂,我们一步步来做。
首先,你需要确保自己具备必要的条件:有一个 ChatGPT 订阅(包括免费版本)或 OpenAI API 密钥,以及 Node.js 18.18 或更高版本。这些条件是使用 Codex-plugin-cc 的基础。
接着,我们来安装这个插件。我们需要在 Claude Code 中添加 marketplace:
/plugin marketplace add openai/codex-plugin-cc然后安装插件:
/plugin install codex@openai-codex安装完成后,别忘了重载插件:
/reload-plugins现在,运行以下命令来设置 Codex:
/codex:setup这个命令会检查 Codex 是否已经准备就绪。如果 Codex 没有安装,并且你有 npm 可用,它会提供安装 Codex 的选项。如果你更喜欢自己安装 Codex,可以使用以下命令:
npm install -g @openai/codex如果 Codex 已经安装但是尚未登录,你需要运行:
!codex login安装和配置完成后,你应该能够看到相关的 slash 命令,并且在 /agents 中看到 codex:codex-rescue 子代理。
为了测试是否一切正常,你可以运行一个简单的代码审查命令:
/codex:review --background
/codex:status
/codex:result这个过程会让你对 Codex-plugin-cc 有一个基本的了解,并确保它在你的环境中正常工作。
本章小结:
- 确保具备 ChatGPT 订阅或 OpenAI API 密钥,以及 Node.js 18.18 或更高版本。
- 在 Claude Code 中添加 marketplace、安装 Codex-plugin-cc 并重载插件。
- 运行
/codex:setup来设置 Codex,并确保它已经安装并登录。 - 通过运行
/codex:review命令来测试 Codex-plugin-cc 是否正常工作。
2. 使用 /codex:review 命令进行代码审查
让我们开始使用 /codex:review 命令进行代码审查。假设你已经安装并配置好了 Codex-plugin-cc,现在你可以使用这个命令来审查你的代码。
首先,确保你已经安装了 Node.js 18.18 或更高版本,并且已经安装了 Codex-plugin-cc。然后,reload plugins 并运行 /codex:setup 命令来设置 Codex。
现在,我们可以开始使用 /codex:review 命令了。这个命令可以对你的当前工作进行正常的 Codex 审查,给你同样的代码审查质量,就像直接在 Codex 中运行 /review 命令一样。
/codex:review这个命令会对你的当前未提交的更改进行审查。如果你想对你的分支进行审查,可以使用 --base <ref> 参数。例如:
/codex:review --base main这会对你的当前分支与 main 分支进行比较的审查。
如果你想在后台运行审查,可以使用 --background 参数:
/codex:review --background然后,你可以使用 /codex:status 命令来检查审查的进度,并使用 /codex:cancel 命令来取消正在进行的任务。
需要注意的是,/codex:review 命令是只读的,不会对你的代码进行任何更改。
本章小结
- 使用
/codex:review命令进行代码审查 - 可以使用
--base <ref>参数对分支进行比较的审查 - 可以使用
--background参数在后台运行审查 - 使用
/codex:status命令检查审查进度 - 使用
/codex:cancel命令取消正在进行的任务
3. 使用 /codex:adversarial-review 命令进行可控审查
我们来看看如何使用 /codex:adversarial-review 命令进行可控审查。这个命令可以帮助我们对代码进行更深入的审查,挑战现有的实现和设计。
在使用 /codex:adversarial-review 命令之前,我们需要确保已经安装并配置好了 Codex-plugin-cc。如果你还没有安装,可以按照前一章的步骤进行安装和配置。
现在,我们可以开始使用 /codex:adversarial-review 命令了。这个命令的基本用法如下:
/codex:adversarial-review这会启动一个可控审查过程,Codex 会对我们的代码进行审查和挑战。我们可以使用 --base <ref> 参数指定要比较的基准分支,例如:
/codex:adversarial-review --base main这会比较我们的当前分支和 main 分支的代码。
我们也可以使用 --background 参数将审查过程放到后台运行,例如:
/codex:adversarial-review --background这会让 Codex 在后台进行审查,我们可以使用 /codex:status 命令检查审查的进度。
如果我们想对特定的代码区域进行审查,我们可以在命令后面添加额外的文本,例如:
/codex:adversarial-review --background challenge whether this was the right caching and retry design这会让 Codex 对我们的缓存和重试设计进行审查和挑战。
在进行可控审查时,我们需要注意以下几点:
- 可控审查是只读的,不会修改我们的代码。
- 可控审查可以帮助我们发现代码中的潜在问题和改进点。
- 我们可以使用
/codex:status命令检查审查的进度,并使用/codex:cancel命令取消正在进行的审查。
本章小结
- 我们学习了如何使用
/codex:adversarial-review命令进行可控审查。 - 我们了解了如何使用
--base <ref>参数指定要比较的基准分支。 - 我们知道了如何使用
--background参数将审查过程放到后台运行。 - 我们意识到可控审查是只读的,不会修改我们的代码。
4. 使用 /codex:rescue 命令委托任务
我们先来看看如何使用 /codex:rescue 命令来委托任务给 Codex。在上一章中,我们已经学会了如何使用 /codex:review 和 /codex:adversarial-review 命令进行代码审查和可控审查。现在,我们要将任务委托给 Codex,让它帮助我们解决问题或完成任务。
在开始之前,请确保你已经安装并配置了 Codex-plugin-cc,并且已经运行了 /codex:setup 命令来设置 Codex。
使用 /codex:rescue 命令非常简单,你只需要在命令行中输入 /codex:rescue,然后跟上你要委托的任务描述。例如:
/codex:rescue investigate why the tests started failing这条命令会让 Codex 调查为什么测试开始失败。你也可以使用 --background 参数来让任务在后台运行:
/codex:rescue --background investigate why the tests started failing如果你想继续之前的 Codex 任务,可以使用 --resume 参数:
/codex:rescue --resume apply the top fix from the last run你也可以指定使用哪个模型和努力级别来完成任务:
/codex:rescue --model gpt-5.4-mini --effort medium investigate the flaky integration test在使用 /codex:rescue 命令时,你需要注意以下几点:
- 如果你不指定
--model或--effort参数,Codex 会选择其自己的默认值。 - 如果你指定
spark作为模型,插件会将其映射为gpt-5.3-codex-spark。 - 后续的救援请求可以继续上一个 Codex 任务在存储库中的上下文。
如果你遇到问题或任务没有完成,你可以使用 /codex:status 命令来检查任务的状态,并使用 /codex:cancel 命令来取消任务。
本章小结
- 使用
/codex:rescue命令来委托任务给 Codex。 - 可以使用
--background参数来让任务在后台运行。 - 可以使用
--resume参数来继续之前的 Codex 任务。 - 可以指定使用哪个模型和努力级别来完成任务。
- 需要注意任务的状态和取消任务的方法。
5. 使用 /codex:transfer 命令转移会话
现在我们要学习如何使用 /codex:transfer 命令来转移会话。这意味着你可以将当前在 Claude Code 中的调试或实现对话直接转移到 Codex 中继续。这样,你就可以保持对话的上下文,不用重新开始。
首先,确保你已经安装并配置了 Codex-plugin-cc。如果你还没有安装,可以按照之前章节的步骤来安装和配置。
接下来,让我们看一下如何使用 /codex:transfer 命令。这个命令可以创建一个持久的 Codex 线程从当前 Claude Code 会话开始,并打印出一个 codex resume <session-id> 命令。这个命令非常有用,当你在 Claude Code 中开始了一个调试或实现对话,但你想直接在 Codex 中继续这个对话时。
这里有一个简单的例子:
/codex:transfer运行这个命令后,Codex-plugin-cc 会创建一个新的 Codex 会话,并打印出一个 codex resume <session-id> 命令。你可以使用这个命令在 Codex 中继续之前的对话。
如果你想指定源会话文件,你可以使用 --source 参数。例如:
/codex:transfer --source ~/.claude/projects/-Users-me-repo/<session-id>.jsonl这个命令会从指定的源会话文件中创建一个新的 Codex 会话。
需要注意的是,源会话文件必须位于 ~/.claude/projects 目录下。同时,老版本的 Codex 可能不支持会话导入,所以你可能需要升级 Codex 到最新版本。
如果你遇到问题,可以检查 Codex-plugin-cc 的日志文件来排查错误。同时,你也可以在 Claude Code 中使用 /codex:status 命令来检查当前的 Codex 会话状态。
本章小结
- 使用
/codex:transfer命令可以将 Claude Code 中的会话转移到 Codex 中。 - 可以使用
--source参数来指定源会话文件。 - 源会话文件必须位于
~/.claude/projects目录下。 - 老版本的 Codex 可能不支持会话导入,需要升级到最新版本。
6. 使用 /codex:status 和 /codex:result 命令管理作业
我们已经学会了如何使用 /codex:review、/codex:adversarial-review 和 /codex:rescue 命令来进行代码审查和任务委托。现在,我们需要一种方式来管理这些作业,了解它们的状态和结果。这就是 /codex:status 和 /codex:result 命令的用途。
在使用这些命令之前,请确保你已经安装并配置了 Codex-plugin-cc,并且已经运行过 /codex:setup 命令来检查 Codex 是否准备就绪。
使用 /codex:status 命令
当你运行一个作业(比如代码审查或任务委托)时,你可以使用 /codex:status 命令来检查它的状态。这个命令会显示作业的当前状态,包括是否正在运行、已完成或遇到错误。
/codex:status运行这个命令后,你会看到类似这样的输出:
作业状态:正在运行
作业 ID:<job-id>或者,如果作业已经完成,你会看到:
作业状态:已完成
作业 ID:<job-id>
结果:<result>使用 /codex:result 命令
一旦作业完成,你可以使用 /codex:result 命令来查看结果。这个命令会显示作业的详细结果,包括任何输出或错误信息。
/codex:result运行这个命令后,你会看到类似这样的输出:
结果:<result>
输出:<output>
错误:<error>示例用法
假设你已经运行了一个代码审查作业,并且想要检查它的状态和结果。你可以使用以下命令:
/codex:review --background
/codex:status
/codex:result第一个命令运行代码审查作业并将其放入背景中。第二个命令检查作业的状态,第三个命令查看作业的结果。
常见问题和故障排除
如果你遇到任何问题或错误,你可以检查作业的状态和结果来诊断问题。例如,如果作业状态为“错误”,你可以使用 /codex:result 命令来查看错误信息。
小结
- 使用
/codex:status命令来检查作业的状态。 - 使用
/codex:result命令来查看作业的结果。 - 这些命令可以帮助你管理作业,了解它们的状态和结果。
- 如果遇到问题或错误,可以使用这些命令来诊断问题。
7. 使用 /codex:cancel 命令取消背景作业
取消背景作业是我们在使用 Codex-plugin-cc 过程中可能会遇到的一个需求,尤其是在我们启动了一个耗时的代码审查或任务委托后,发现不需要了或者需要更改参数时。那么,我们如何使用 /codex:cancel 命令来取消这些背景作业呢?
首先,确保你已经正确安装并配置了 Codex-plugin-cc。如果你还没有安装,可以按照项目的 README 中的指示,运行以下命令:
/plugin marketplace add openai/codex-plugin-cc
/plugin install codex@openai-codex
/reload-plugins
/codex:setup如果你已经安装了 Codex 但尚未登录,别忘了运行 !codex login 来登录。
现在,让我们开始取消背景作业的步骤:
- 启动一个背景作业:你可以使用
/codex:review或/codex:rescue命令启动一个背景作业。例如:
/codex:review --background或者
/codex:rescue investigate why the tests started failing --background- 检查作业状态:在取消作业之前,你可能想要检查一下作业的状态。使用
/codex:status命令可以查看当前作业的进度:
/codex:status- 取消作业:如果你确定要取消这个作业,可以使用
/codex:cancel命令。这个命令会终止当前正在运行的背景作业:
/codex:cancel预期结果:作业将被取消,你将收到一条确认消息,表明作业已经被成功取消。
注意事项:在取消作业时,请确保你确实想要终止这个作业,因为一旦作业被取消,就不能再恢复了。如果你遇到任何问题或错误,可以参考项目的 README 或寻求社区的帮助。
本章小结:
- 确保 Codex-plugin-cc 已经正确安装并配置。
- 使用
/codex:review或/codex:rescue启动一个背景作业。 - 使用
/codex:status检查作业状态。 - 使用
/codex:cancel取消背景作业。 - 取消作业后,作业将被终止,无法恢复。
8. 高级配置和定制
高级配置和定制是我们使用 Codex-plugin-cc 的最后一公里。到目前为止,我们已经学会了如何安装、配置和使用各种 /codex: 命令来进行代码审查、委托任务等。在这一章,我们将深入探讨如何根据自己的需求定制和优化 Codex-plugin-cc 的使用。
首先,确保你已经安装并配置好了 Codex-plugin-cc,并且有一个 ChatGPT 订阅或 OpenAI API 密钥。同时,Node.js 18.18 或更高版本也是必需的。
接下来,让我们来看一下如何定制 /codex:review 和 /codex:adversarial-review 命令。这些命令提供了代码审查和可控审查的功能,我们可以通过添加参数来定制它们的行为。例如,我们可以使用 --base <ref> 参数来指定审查的基准分支,或者使用 --background 参数来让审查在后台运行。
/codex:review --base main
/codex:review --background对于 /codex:adversarial-review 命令,我们可以使用 --wait 和 --background 参数来控制审查的流程。同时,我们也可以添加额外的文本来指定审查的焦点。
/codex:adversarial-review --base main challenge whether this was the right caching and retry design
/codex:adversarial-review --background look for race conditions and question the chosen approach此外,我们还可以使用 /codex:rescue 命令来委托任务给 Codex。这个命令提供了多种参数来定制任务的行为,例如 --model 和 --effort。
/codex:rescue investigate why the tests started failing
/codex:rescue --model gpt-5.4-mini --effort medium investigate the flaky integration test最后,我们可以使用 /codex:transfer 命令来创建一个持久的 Codex 线程,从而继续在 Codex 中进行调试或实现的对话。
/codex:transfer本章小结
- 我们可以通过添加参数来定制
/codex:review和/codex:adversarial-review命令的行为。 /codex:rescue命令提供了多种参数来定制任务的行为。/codex:transfer命令可以创建一个持久的 Codex 线程,从而继续在 Codex 中进行调试或实现的对话。- 通过高级配置和定制,我们可以更好地利用 Codex-plugin-cc 的功能来提高我们的开发效率。
9. 常见问题和故障排除
我们先来看看可能遇到的常见问题和故障排除方法。使用 Codex-plugin-cc 的过程中,可能会遇到一些问题,例如安装失败、命令无法使用、任务取消失败等。
首先,我们需要确保已经正确安装了 Codex-plugin-cc。如果你还没有安装,可以使用以下命令:
/plugin marketplace add openai/codex-plugin-cc
/plugin install codex@openai-codex
/reload-plugins
/codex:setup如果安装过程中遇到问题,可以尝试检查 Node.js 版本是否符合要求(18.18 或更高)。
如果已经安装了 Codex-plugin-cc,但仍然无法使用某些命令,可能是因为没有正确配置 ChatGPT 订阅或 OpenAI API 密钥。可以使用 /codex:setup 命令检查是否已经配置好了。
在使用 /codex:review、/codex:adversarial-review 和 /codex:rescue 命令时,可能会遇到任务取消失败的问题。可以使用 /codex:cancel 命令取消正在运行的任务。
此外,可能会遇到一些其他问题,例如:
/codex:transfer命令无法创建持久的 Codex 线程:检查是否已经正确配置了 Claude Code 会话和 Codex 外部代理。/codex:rescue命令无法委托任务:检查是否已经正确配置了 Codex 模型和 effort。
如果遇到这些问题,可以尝试检查以下几点:
- 是否已经正确安装和配置了 Codex-plugin-cc。
- 是否已经正确配置了 ChatGPT 订阅或 OpenAI API 密钥。
- 是否已经正确使用了命令和参数。
- 是否已经检查了 Claude Code 会话和 Codex 外部代理的配置。
本章小结
- 确保正确安装和配置了 Codex-plugin-cc。
- 检查 ChatGPT 订阅或 OpenAI API 密钥的配置。
- 使用
/codex:cancel命令取消正在运行的任务。 - 检查 Claude Code 会话和 Codex 外部代理的配置。
- 参考 README 文档和官方文档获取更多信息和帮助。
常见问题
问题:如何安装openai/codex-plugin-cc插件?
在 Claude Code 中添加 marketplace 并安装插件,步骤如下:
/plugin marketplace add openai/codex-plugin-cc
/plugin install codex@openai-codex
/reload-plugins
/codex:setup如果 Codex 未安装,运行 /codex:setup 会提示是否安装。也可以手动安装:
npm install -g @openai/codex然后登录:
!codex login问题:使用openai/codex-plugin-cc插件的前提条件是什么?
需要 ChatGPT 订阅(包括免费版)或 OpenAI API 密钥 以及 Node.js 18.18 或更高版本。
问题:如何运行 Codex 代码审查?
使用 /codex:review 命令运行代码审查,例如:
/codex:review
/codex:review --base main
/codex:review --background问题:如何运行可控的代码审查?
使用 /codex:adversarial-review 命令运行可控的代码审查,例如:
/codex:adversarial-review
/codex:adversarial-review --base main challenge 是否选择了正确的缓存和重试设计
/codex:adversarial-review --background 查找竞态条件并质疑所选的方法问题:如何委托任务给 Codex?
使用 /codex:rescue 命令委托任务给 Codex,例如:
/codex:rescue 调查为什么测试开始失败
/codex:rescue --resume 应用上次运行的顶级修复
/codex:rescue --model gpt-5.4-mini --effort medium 调查 flaky 集成测试问题:如何将 Claude Code 会话转移到 Codex?
使用 /codex:transfer 命令将 Claude Code 会话转移到 Codex,例如:
/codex:transfer
/codex:transfer --source ~/.claude/projects/-Users-me-repo/<session-id>.jsonl问题:如何查看 Codex 任务状态?
使用 /codex:status 命令查看 Codex 任务状态。例如:
/codex:status问题:如何取消正在进行的 Codex 任务?
使用 /codex:cancel 命令取消正在进行的 Codex 任务。例如:
/codex:cancel