Codex

本文介绍如何在 Codex 中配置并使用方舟按量计费模型服务。

前提条件#

Codex CLI#

安装 Codex CLI#

在命令行界面，执行以下命令安装 Codex CLI。

1npm i -g @openai/codex

安装结束后，执行以下命令检查版本。

1codex --version

配置 Codex CLI#

创建并打开 Codex 的配置文件。文件路径因系统而异，具体操作如下：

macOS/Linux 系统 Codex 配置文件路径：~/.codex/config.toml。

如果在主目录下没有.codex目录，执行以下命令创建目录。
Bash
```
1mkdir -p ~/.codex
```
创建并打开配置文件。
Bash
```
1nano ~/.codex/config.toml
```

Windows 系统 Codex 配置文件路径：%USERPROFILE%\.codex\config.toml。以 CMD 命令行方式为例，操作如下。

如果当前用户目录下没有.codex目录，执行以下命令创建目录。
Bash
```
1if not exist "%USERPROFILE%\.codex" mkdir "%USERPROFILE%\.codex"
```

创建并打开配置文件。

1notepad "%USERPROFILE%\.codex\config.toml"

编辑 config.toml，需关注的配置信息如下：
- model：按需选择模型并获取 Model ID。可用模型参见模型列表。
- env_key：设置的是环境变量名称，请不要直接修改 ARK_API_KEY，您需要在下一步设置该环境变量的值。
Plain
```
1
2
3
4
5
6
7
8
9model = "<Model_ID>"
model_provider = "volcengine"
model_supports_reasoning_summaries = true

[model_providers.volcengine]
name = "volcengine"
base_url = "https://ark.cn-beijing.volces.com/api/v3"
env_key = "ARK_API_KEY"
wire_api = "responses"
```

配置环境变量，需要将 ARK_API_KEY 环境变量设置为 API Key。

查看 Shell 类型。
Bash
```
1echo $SHELL
```

将环境变量写入 Shell 配置文件，使其在新开终端时自动生效。

Zsh

1
2
3# 将 YOUR_API_KEY 替换为API Key。
echo 'export ARK_API_KEY="YOUR_API_KEY"' >> ~/.zshrc
source ~/.zshrc

Bash

1
2
3# 将 YOUR_API_KEY 替换为API Key。
echo 'export ARK_API_KEY="YOUR_API_KEY"' >> ~/.bashrc
source ~/.bashrc

CMD：环境变量设置完成后，新开 CMD 窗口生效。

1
2
3
4# 将 YOUR_API_KEY 替换为API Key。
setx ARK_API_KEY "YOUR_API_KEY"
# 新开窗口，检查环境变量是否生效
echo %ARK_API_KEY%

PowerShell：环境变量设置完成后，新开 PowerShell 窗口生效。

1
2
3
4# 将 YOUR_API_KEY 替换为API Key。
[Environment]::SetEnvironmentVariable("ARK_API_KEY", "YOUR_API_KEY", [EnvironmentVariableTarget]::User)
# 新开窗口，检查环境变量是否生效
echo $env:ARK_API_KEY

使用 Codex CLI#

执行以下命令启动 Codex CLI。

1codex

Codex 桌面客户端#

OpenAI 更新后已取消 Codex 的独立应用，将其融入了 ChatGPT Desktop App 作为其中的一个模式。

安装 ChatGPT 桌面客户端#

从 OpenAI 官网下载并安装 ChatGPT 桌面客户端。

配置桌面客户端#

单击左下角的设置。
在配置页面单击打开 config.toml。
编辑 config.toml，需关注的配置信息如下。
- model：按需选择模型并获取 Model ID。可用模型参见模型列表。
- env_key：设置的是环境变量名称，请不要直接修改 ARK_API_KEY，您需要在下一步设置该环境变量的值。
Plain
```
1
2
3
4
5
6
7
8
9model = "<Model_ID>"
model_provider = "volcengine"
model_supports_reasoning_summaries = true

[model_providers.volcengine]
name = "volcengine"
base_url = "https://ark.cn-beijing.volces.com/api/v3"
env_key = "ARK_API_KEY"
wire_api = "responses"
```

配置环境变量，需要将 ARK_API_KEY 环境变量设置为 API Key。

查看 Shell 类型。
Bash
```
1echo $SHELL
```

将环境变量写入 Shell 配置文件，使其在新开终端时自动生效。

Zsh

1
2
3# 将 YOUR_API_KEY 替换为API Key。
echo 'export ARK_API_KEY="YOUR_API_KEY"' >> ~/.zshrc
source ~/.zshrc

Bash

1
2
3# 将 YOUR_API_KEY 替换为API Key。
echo 'export ARK_API_KEY="YOUR_API_KEY"' >> ~/.bashrc
source ~/.bashrc

CMD：环境变量设置完成后，新开 CMD 窗口生效。

1
2
3
4# 将 YOUR_API_KEY 替换为API Key。
setx ARK_API_KEY "YOUR_API_KEY"
# 新开窗口，检查环境变量是否生效
echo %ARK_API_KEY%

PowerShell：环境变量设置完成后，新开 PowerShell 窗口生效。

1
2
3
4# 将 YOUR_API_KEY 替换为API Key。
[Environment]::SetEnvironmentVariable("ARK_API_KEY", "YOUR_API_KEY", [EnvironmentVariableTarget]::User)
# 新开窗口，检查环境变量是否生效
echo $env:ARK_API_KEY

使用桌面客户端#

配置完成后，需要退出 ChatGPT 桌面客户端并重新打开让配置生效。重新启动后，即可在对话界面中使用。

使用 Codex 的 Web Search 功能#

完成配置后，按以下步骤在 Codex 使用 Web Search 功能。

登录方舟控制台，打开应用组件库 > 豆包搜索标签页。
在豆包搜索 Custom 版的操作列中点击开通服务。
在 Codex 中直接提问，例如"GitHub 最近有哪些热门开源项目"。

接入 MCP Server#

若内置工具未覆盖您的使用场景，可在 Codex 中接入二方、三方 MCP Server，扩展模型可用的能力。

获取 MCP Server#

二方：访问智能体工具商店，获取火山引擎生态内的 MCP 工具（如巨量千川、知识库等），在 MCP 详情页获取服务地址与鉴权信息。
三方：接入其他 MCP 市场提供的 MCP Server，或自行部署开源 MCP Server。

配置 MCP Server#

编辑 ~/.codex/config.toml（Windows 为 %USERPROFILE%\.codex\config.toml），添加 MCP Server 配置。

1
2
3[mcp_servers.<MCP名称>]
command = "<启动命令>"
args = ["<启动参数>"]

配置完成后，重启 Codex 后生效。