Skip to main content
Codex 是OpenAI 推出的一系列人工智能编码工具,通过将任务委托给强大的云端和本地编码代理,帮助开发人员提升工作效率。支持原生终端、vscode插件、cursor插件等场景使用。 官网网站 https://openai.com/codex/

系统要求

步骤一:安装Codex CLI

选择一种安装方式即可。 npm(通用)
Homebrew(macos系统推荐)
如遇 codex 无法执行或 Node 版本过旧,请升级 Node(常见需要 Node 22+),或改用 Homebrew 安装。

Codex配置

安装后,我们开始配置codex才能通过apikey方式接入我们的API。如果你是通过openai plus会员来使用codex,可跳过后续教程,codex中直接登录plus账号即可使用。

1.在v-api平台注册并充值

进入网站 https://api.iqqz.com 进行注册并充值,然后在“令牌管理”页面,复制apikey,后续需要用到。

2.codex配置文件config.toml

Codex 启动时会在~/.codex/ 读取config.toml文件。若不存在就新建:
config.toml中加入如下配置,根据需求修改:

3.添加apikey环境变量

这步很重要,我们需要将我们设置的环境变量V_API_KEY添加到系统配置中。
key值就是我们从“令牌管理”页面复制的sk-开头的apikey。

Window用户设置apikey环境变量:

Mac/Linux用户设置环境变量:

方法一:永久设置(推荐) 1.编辑配置文件(或直接手动打开文件)
2.在最后新行,添加以下内容
3.保存并生效
方法二:临时设置

验证是否设置成功

如果显示sk-xxxxxx则说明设置成功!

启动命令

Codex CLI原生命令

vscode中使用Codex插件

如果是在vscode中使用codex插件,我们配置好后需要完全退出vscode重新启动才能生效。

Codex高级使用技巧指南

CLI 参考

非交互/CI模式

在管道中以无头方式运行 Codex。示例 GitHub Action 步骤:

模型上下文协议(MCP)

通过在~/.codex/config.toml中定义一个mcp_servers部分,可以将 Codex CLI 配置为使用 MCP 服务器。它旨在反映 Claude 和 Cursor 等工具在其各自的 JSON 配置文件中的 mcpServers 定义方式,尽管 Codex 的格式略有不同,因为它使用的是 TOML 而不是 JSON,例如:

参考资料

Codex官方详细配置说明文档