面向 AI 助手:本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/agent-plan-enterprise-codex.md,全部文档索引见 https://ark.volcengine.com/llms.txt。

Codex

本文介绍如何配置方舟 Agent Plan 企业版到 Codex 中使用。

前提条件#

需由管理员账号完成以下操作后,子账号方可配置并使用 AI 工具:

  1. 购买方舟 Agent Plan 企业版套餐:一、购买 Agent Plan 企业版。
  2. 为子账号分配席位:二、分配席位。

Codex CLI#

一、安装 Codex CLI#

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

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

Bash
npm i -g @openai/codex

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

Bash
codex --version

二、配置 Codex CLI#

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

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

  1. 如果在主目录下没有.codex目录,执行以下命令创建目录。

    Bash
    mkdir -p ~/.codex
    
  2. 创建并打开配置文件。

    Bash
    nano ~/.codex/config.toml
    

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

  1. 如果当前用户目录下没有.codex目录,执行以下命令创建目录。

    Bash
    if not exist "%USERPROFILE%\.codex" mkdir "%USERPROFILE%\.codex"
    
  2. 创建并打开配置文件。

    Bash
    notepad "%USERPROFILE%\.codex\config.toml"
    
  1. 编辑 config.toml,需关注的配置信息如下:

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

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

      Plain
      model = "<Model_Name>"
      model_provider = "volcengine-enterprise-agent-plan"
      model_supports_reasoning_summaries = true
      
      [model_providers.volcengine-enterprise-agent-plan]
      name = "volcengine-enterprise-agent-plan"
      base_url = "https://ark.cn-beijing.volces.com/api/plan/v3"
      env_key = "ARK_API_KEY"
      wire_api = "responses"
      
  1. 配置环境变量,需要将 ARK_API_KEY 环境变量设置为 专属 API Key。
  1. 查看 Shell 类型。

    Bash
    echo $SHELL
    
  2. 将环境变量写入 Shell 配置文件,使其在新开终端时自动生效。

    • Zsh

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

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

    Bash
    # 需要将 YOUR_API_KEY 替换为专属 API Key。
    setx ARK_API_KEY "YOUR_API_KEY"
    # 新开窗口,检查环境变量是否生效
    echo %ARK_API_KEY%
    
  • PowerShell:环境变量设置完成后,新开 PowerShell 窗口生效。

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

三、开始使用#

执行以下命令启动 Codex CLI。

Bash
codex

Codex 桌面客户端#

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

一、安装 ChatGPT 桌面客户端#

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

二、配置桌面客户端#

登录 ChatGPT 桌面客户端后,通过左上角的选项切换 ChatGPT Work 和 Codex,切换到 Codex 模式后,根据以下步骤进行配置。

  1. 单击左下角的设置。
    image-20260630-172328-897.png

  2. 在配置页面单击打开 config.toml。
    image-20260630-172525-618.png

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

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

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

      Plain
      model = "<Model_Name>"
      model_provider = "volcengine-enterprise-agent-plan"
      model_supports_reasoning_summaries = true
      
      [model_providers.volcengine-enterprise-agent-plan]
      name = "volcengine-enterprise-agent-plan"
      base_url = "https://ark.cn-beijing.volces.com/api/plan/v3"
      env_key = "ARK_API_KEY"
      wire_api = "responses"
      
  1. 配置环境变量,需要将 ARK_API_KEY 环境变量设置为 专属 API Key。
  1. 查看 Shell 类型。

    Bash
    echo $SHELL
    
  2. 将环境变量写入 Shell 配置文件,使其在新开终端时自动生效。

    • Zsh

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

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

    Bash
    # 需要将 YOUR_API_KEY 替换为专属 API Key。
    setx ARK_API_KEY "YOUR_API_KEY"
    # 新开窗口,检查环境变量是否生效
    echo %ARK_API_KEY%
    
  • PowerShell:环境变量设置完成后,新开 PowerShell 窗口生效。

    Bash
    # 需要将 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 功能。

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

image-20260909-120358-687.png

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