文档中心

火山方舟

接入 AI 工具

Codex

本文介绍如何在 Codex 中配置并使用方舟 Agent Plan。

前提条件

您已按需订阅 Agent Plan 套餐。如未订阅，请访问开通管理-Agent Plan 页面订阅套餐。

Codex CLI

安装 Codex CLI

说明

Agent Plan 支持 Responses API，可以使用最新版 Codex CLI。

前提条件：安装 Node.js 18 或更新版本。

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

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

配置 Codex CLI

方式 1：一键配置（推荐）

Ark CLI 是火山方舟平台官方命令行工具，支持在本地终端快速完成认证与资源管理，并可将能力安装到常用 AI Agent 中，降低手动配置的时间成本和出错风险。

安装 Ark CLI

环境要求：Node.js 18 或更新版本。支持 macOS、Linux、Windows。

根据界面提示选择登录方式，推荐选择火山 SSO (浏览器登录)，在浏览器中完成授权即可。

一键配置 Codex

运行 ArkCLI Helper，根据界面提示完成配置。

选择 Profile：agent-plan_cn-beijing_personal。

选择默认 model：按需选择。

选择 AI Agent：Codex。

支持配置 Harness 能力，根据界面提示按需选择配置或者跳过。

配置完成后，Codex 会自动识别配置的模型。启动 Codex 即可使用。

方式 2：手动配置

新建 ~/.codex/config.toml（Windows 路径：%USERPROFILE%\.codex\config.toml），配置信息如下：

model：需配置文本生成模型。支持配置 ark-code-latest、配置 Model Name。模型信息见支持模型及 Harness。

env_key：设置的是环境变量名称，请不要直接修改 ARK_API_KEY，您需要在下一步设置该环境变量的值。

model = "<MODEL_NAME>"
model_provider = "volcengine-agent-plan"

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

注意

model_reasoning_effort：控制思考长度，可以设置为 low、medium、high。

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

macOS / Linux
Windows
查看 Shell 类型。

echo $SHELL

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

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

Bash

# 将 YOUR_API_KEY 替换为专属 API Key。
echo 'export ARK_API_KEY="YOUR_API_KEY"' >> ~/.bashrc
source ~/.bashrc
CMD：环境变量设置完成后，新开 CMD 窗口生效。

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

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

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

配置完成后，即可使用 Codex CLI。

使用 Codex CLI

执行以下命令启动 Codex CLI。

Codex 桌面客户端

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

安装 ChatGPT 桌面客户端

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

配置桌面客户端

单击左下角的设置。

在配置页面单击打开 config.toml。

编辑 config.toml，需关注的配置信息如下。

model：需配置文本生成模型。支持配置 ark-code-latest、配置 Model Name。模型信息见支持模型及 Harness。

env_key：设置的是环境变量名称，请不要直接修改 ARK_API_KEY，您需要在下一步设置该环境变量的值。

model = "<MODEL_NAME>"
model_provider = "volcengine-agent-plan"

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

注意

model_reasoning_effort：控制思考长度，可以设置为 low、medium、high。

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

macOS / Linux
Windows
查看 Shell 类型。

echo $SHELL

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

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

Bash

# 将 YOUR_API_KEY 替换为专属 API Key。
echo 'export ARK_API_KEY="YOUR_API_KEY"' >> ~/.bashrc
source ~/.bashrc
CMD：环境变量设置完成后，新开 CMD 窗口生效。

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

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

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

使用桌面客户端

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

使用 Codex 的 Web Search 功能

说明

除了通过配置 MCP 或 Skill 使用豆包搜索能力外，在 Agent Plan 场景下，通过 Responses API 接入的 Codex 也可原生使用 Web Search 功能。

使用豆包搜索承接的 Web Search 会额外发起大模型 API 请求，对搜索结果进行总结。使用前需前往控制台开启豆包搜索抵扣，否则将无法使用 Web Search 功能。

更多说明参见豆包搜索。

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

在控制台开启豆包搜索抵扣。

在 Codex 中直接提问，例如"GitHub 最近有哪些热门开源项目"。

最近更新时间：2026.11.04 17:47:43

这个页面对您有帮助吗？

有用

无用