# Codex
> 全部文档的索引见 [llms.txt](https://ark.volcengine.com/llms.txt)；在任一文档页面地址后追加 `.md` 可获取该页的 Markdown 版本。
本文介绍如何在 Codex 中配置并使用方舟 Agent Plan 企业版。
# 前提条件
需由管理员账号完成以下前置操作后，子账号方可配置并使用 Codex：
1. 购买方舟 Agent Plan 企业版套餐：[一、购买 Agent Plan 企业版](/docs/agent-plan-enterprise-get-started#purchase-plan)。
2. 为子账号分配席位：[二、分配席位](/docs/agent-plan-enterprise-get-started#assign-seats)。
# Codex CLI
## 安装 Codex CLI
> **说明**
>
> Agent Plan 企业版支持 Responses API，可以使用最新版 Codex CLI。
**前提条件**：安装 [Node.js 18 或更新版本](https://nodejs.org/en/download/)。
在命令行界面，执行以下命令安装 Codex CLI。
```Bash
npm i -g @openai/codex
```
安装结束后，执行以下命令检查版本。
```Bash
codex --version
```
## 配置 Codex CLI
### 方式 1：一键配置（推荐）
Ark CLI 是火山方舟平台官方命令行工具，支持在本地终端快速完成认证与资源管理，并可将能力安装到常用 AI Agent 中，降低手动配置的时间成本和出错风险。
1. 安装 Ark CLI
环境要求：Node.js 18 或更新版本。支持 macOS、Linux、Windows。
```Bash
npm install -g @volcengine/ark-cli@latest
arkcli --version
```
2. 登录 Ark CLI
根据界面提示选择登录方式，推荐选择 **火山 SSO (浏览器登录)**，在浏览器中完成授权即可。
```Bash
arkcli auth login
```
3. 一键配置 Codex
```Bash
arkcli helper
```
运行 ArkCLI Helper，根据界面提示完成配置。
* **选择 Profile**：`agent-plan-team_cn-beijing_team`。
* **选择默认 model**：按需选择。
* **选择 AI Agent**：`Codex`。
支持配置 Harness 能力，根据界面提示按需选择`配置`或者`跳过`。
配置完成后，Codex 会自动识别配置的模型。启动 Codex 即可使用。
### 方式 2：手动配置
1. 新建或编辑 `~/.codex/config.toml`（Windows 路径：`%USERPROFILE%\.codex\config.toml`），配置信息如下：
* `model`：需配置文本生成模型。支持配置 `ark-code-latest`、配置 Model Name。模型信息见[支持模型及 Harness](/docs/agent-plan-enterprise-plan-overview#supported-models-harness)。
```PlainText
model = ""
model_provider = "volcengine-enterprise-agent-plan"
cli_auth_credentials_store = "file"
[model_providers.volcengine-enterprise-agent-plan]
name = "volcengine-enterprise-agent-plan"
base_url = "https://ark.cn-beijing.volces.com/api/plan/v3"
requires_openai_auth = true
wire_api = "responses"
```
> **注意**
>
> * `model_reasoning_effort`：控制思考长度，可以设置为 `low`、`medium`、`high`。
2. 新建或编辑 `~/.codex/auth.json`（Windows 路径：`%USERPROFILE%\.codex\auth.json`），将您的 [专属 API Key](https://ark.volcengine.com/region:cn-beijing/subscription/agent-plan-enterprise/mine) 写入 **OPENAI_API_KEY** 字段。
```JSON
{
"OPENAI_API_KEY": ""
}
```
**OPENAI_API_KEY** 是 Codex 认证文件的固定字段名，此处填写 [专属 API Key](https://ark.volcengine.com/region:cn-beijing/subscription/agent-plan-enterprise/mine)，无需设置环境变量或进行 OpenAI 登录。`auth.json` 包含明文密钥，请勿提交到代码仓库或分享。
配置完成后，即可使用 Codex CLI。
## 使用 Codex CLI
执行以下命令启动 Codex CLI。
```Bash
codex
```
# Codex 桌面客户端
OpenAI 更新后已取消 Codex 的独立应用，将其融入了 ChatGPT Desktop App 作为其中的一个模式。
## 安装 ChatGPT 桌面客户端
从 [OpenAI 官网](https://openai.com/chatgpt/download/) 下载并安装 ChatGPT 桌面客户端。
## 配置桌面客户端
登录 ChatGPT 桌面客户端后，通过左上角的选项切换 ChatGPT Work 和 Codex，切换到 Codex 模式后，根据以下步骤进行配置。
1. 单击左下角的**设置**。
2. 在**配置**页面单击**打开 config.toml**。
3. 编辑 `config.toml`，需关注的配置信息如下。
* `model`：需配置文本生成模型。支持配置 `ark-code-latest`、配置 Model Name。模型信息见[支持模型及 Harness](/docs/agent-plan-enterprise-plan-overview#supported-models-harness)。
```PlainText
model = ""
model_provider = "volcengine-enterprise-agent-plan"
cli_auth_credentials_store = "file"
[model_providers.volcengine-enterprise-agent-plan]
name = "volcengine-enterprise-agent-plan"
base_url = "https://ark.cn-beijing.volces.com/api/plan/v3"
requires_openai_auth = true
wire_api = "responses"
```
> **注意**
>
> * `model_reasoning_effort`：控制思考长度，可以设置为 `low`、`medium`、`high`。
4. 新建或编辑 `~/.codex/auth.json`（Windows 路径：`%USERPROFILE%\.codex\auth.json`），将您的 [专属 API Key](https://ark.volcengine.com/region:cn-beijing/subscription/agent-plan-enterprise/mine) 写入 **OPENAI_API_KEY** 字段。
```JSON
{
"OPENAI_API_KEY": ""
}
```
**OPENAI_API_KEY** 是 Codex 认证文件的固定字段名，此处填写 [专属 API Key](https://ark.volcengine.com/region:cn-beijing/subscription/agent-plan-enterprise/mine)，无需设置环境变量或进行 OpenAI 登录。`auth.json` 包含明文密钥，请勿提交到代码仓库或分享。
## 使用桌面客户端
配置完成后，需要退出 ChatGPT 桌面客户端并重新打开让配置生效。重新启动后，即可在对话界面中使用。
# 使用 Codex 的 Web Search 功能
> **说明**
>
> * 除了通过配置 MCP 或 Skill 使用豆包搜索能力外，在 Agent Plan 企业版场景下，通过 Responses API 接入的 Codex 也可原生使用 Web Search 功能。
> * 使用豆包搜索承接的 Web Search 会额外发起大模型 API 请求，对搜索结果进行总结。使用前需前往控制台开启豆包搜索抵扣，否则将无法使用 Web Search 功能。
> * 更多说明参见 [豆包搜索](/docs/agent-plan-enterprise-search)。
完成配置后，按以下步骤在 Codex 使用 Web Search 功能。
1. 在控制台开启豆包搜索抵扣。
2. 在 Codex 中直接提问，例如"GitHub 最近有哪些热门开源项目"。