> ## Documentation Index
> Fetch the complete documentation index at: https://docs.routerlink.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Codex

> 本文档仅供参考，演示如何配置我们的 API 与第三方 AI 聊天界面配合使用。文中提及的任何第三方软件、网站或服务均非由我们运营、控制或背书。

# **Codex 简介**

<Frame>
  <img src="https://mintcdn.com/matrixlabs/lwKziVVFMY8tXGQu/images/image-69.png?fit=max&auto=format&n=lwKziVVFMY8tXGQu&q=85&s=56c339cb0641f72f94ca9e8e9ec7138a" alt="Image" width="3600" height="2026" data-path="images/image-69.png" />
</Frame>

[Codex](https://github.com/openai/codex) 是 OpenAI 面向软件开发的编程智能体。ChatGPT Plus、Pro、Business、Edu 和 Enterprise 订阅均包含 Codex。它可以帮助您：

**Codex** 核心特性：

* **编写代码**：描述您想构建的内容，Codex 会生成符合您意图的代码，并自动适配现有项目结构与规范。
* **理解陌生代码库**：Codex 可以阅读并解释复杂或遗留代码，帮助您快速掌握团队的系统架构。
* **审查代码**：Codex 分析代码，识别潜在 Bug、逻辑错误和未处理的边界情况。
* **调试与修复问题**：当代码出现问题时，Codex 帮助追踪故障、诊断根本原因，并提出精准的修复建议。
* **自动化开发任务**：Codex 可执行重复性工作流，如重构、测试、数据迁移和环境初始化，让您专注于更高层次的工程工作。

# **步骤**

<Steps>
  <Step title="安装 Codex">
    <Tip>
      需要一键配置工具？不妨尝试下 Routerlink 官方推出的 [Routerlink Starter](https://docs.routerlink.ai/zh/basics/routerlink-starter)。
    </Tip>

    <Tabs>
      <Tab title="CLI - Node.js">
        RouterLink 已经为你写好安装脚本，你可以运行以下命令进行一键安装 Node.js 和对应的 Coding Agent.

        **macOS、Linux、WSL：**

        ```shellscript theme={null}
        curl -fsSL https://install.routerlink.ai/codex.sh | bash
        ```

        **Windows PowerShell：**

        ```powershell theme={null}
        irm https://install.routerlink.ai/codex.ps1 | iex
        ```

        > **Windows** 用户可能出现因为数字签名而无法运行脚本的问题，请运行如下命令:
        >
        > ```powershell theme={null}
        > Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned -Force
        > ```

        **或者**，你可以选择**手动**安装 Node.js 和对应的 Coding Agent：

        安装 [最新 LTS 版本的 Node.js](https://nodejs.org/en/download/)。

        安装完成后，打开终端（Windows 用户使用 PowerShell）并检查版本号。

        * macOS、Linux、Windows：

        ```shellscript theme={null}
        npm i -g @openai/codex
        ```

        验证安装：

        ```shellscript theme={null}
        codex --version
        ```

        如果版本号正确显示，则安装成功。
      </Tab>

      <Tab title="App">
        Codex App 支持 macOS 和 Windows。

        请按照[官方教程](https://developers.openai.com/codex/app#getting-started)完成安装。
      </Tab>

      <Tab title="VS Code 扩展">
        从 [**VS Code**](https://code.visualstudio.com/download) 应用市场**安装** [Codex 扩展](https://marketplace.visualstudio.com/items?itemName=openai.chatgpt) — Codex 是 OpenAI 推出的编码代理，可帮助你更快地编写、审查和交付代码。你可以在 IDE 中并排使用它，或将更大的任务委托到云端处理。

        <Frame>
          <img src="https://mintcdn.com/matrixlabs/K0A5vv7bEAxRSIcd/images/image-93.png?fit=max&auto=format&n=K0A5vv7bEAxRSIcd&q=85&s=0cc52927659a4bd22771a586b730c286" alt="Image" width="983" height="258" data-path="images/image-93.png" />
        </Frame>
      </Tab>
    </Tabs>
  </Step>

  <Step title="配置 Codex">
    Codex 使用 `config.toml` 文件解析提供商参数。请根据您的操作系统找到并创建/编辑该文件。

    **编辑或创建** `config.toml` 文件

    macOS 和 Linux：`~/.codex/config.toml`

    Windows：`C:\Users\<USERNAME>\.codex\config.toml`

    删除原有内容并替换为以下配置：

    ```shellscript theme={null}
    model_provider = "custom"
    model = "gpt-5.5"
    model_reasoning_effort = "high"
    disable_response_storage = true

    [model_providers.custom]
    name = "custom"
    wire_api = "responses"
    base_url = "https://router-link.world3.ai/api/v1"
    ```

    您可以将 "model" 字段替换为任何与 OpenAI 格式兼容的[模型](https://routerlink.ai/models):

    <Frame>
      <img src="https://mintcdn.com/matrixlabs/ltkRsDbAxyB4nlOA/images/image-92.png?fit=max&auto=format&n=ltkRsDbAxyB4nlOA&q=85&s=5db79d68829c4b7ef0b9ba681ea23747" alt="Image" width="1180" height="913" data-path="images/image-92.png" />
    </Frame>

    接下来，**编辑或创建** `auth.json` 文件。Codex 使用此文件读取 API Key。

    macOS 和 Linux：`~/.codex/auth.json`

    Windows：`C:\Users\<USERNAME>\.codex\auth.json`

    请确保将 `<ROUTERLINK_API_KEY>` 替换为从 [RouterLink Key](https://routerlink.ai/settings/api-keys) 获取的实际 Key，**替换时请勿保留尖括号**`< `**和** `>`。

    ```json theme={null}
    {
      "OPENAI_API_KEY": "<ROUTERLINK_API_KEY>"
    }
    ```
  </Step>

  <Step title="加载并验证 Codex">
    <Tabs>
      <Tab title="CLI">
        > **Windows** 用户可能出现因为缺少 VC 运行库而无法运行的问题，请下载并安装[此软件](https://aka.ms/vs/17/release/vc_redist.x64.exe)。

        进入您的代码工作目录，在终端中运行 `codex` 命令：

        ```shellscript theme={null}
        codex
        ```

        选择"Yes"以信任此文件夹。

        <Frame>
          <img src="https://mintcdn.com/matrixlabs/xDQbqIXsjCOPeJoa/images/image-71.png?fit=max&auto=format&n=xDQbqIXsjCOPeJoa&q=85&s=cce2bf7b5b9b8c13945dfc24c2fc1f6a" alt="Image" width="1126" height="276" data-path="images/image-71.png" />
        </Frame>

        现在您可以使用 Codex CLI 了。
      </Tab>

      <Tab title="App">
        打开 Codex App。如果系统提示选择登录方式，请选择"sign in with your OpenAI API key"，并输入您从 [RouterLink](https://routerlink.ai/settings/api-keys) 获取的 API Key。

        现在您可以使用 Codex App 了。

        <Frame>
          <img src="https://mintcdn.com/matrixlabs/gZAsOOdNTNP5Nmcy/images/img_v3_0211f_cb906c37-5e8d-4c44-bed3-bce56b67e8hu.jpg?fit=max&auto=format&n=gZAsOOdNTNP5Nmcy&q=85&s=8ef34cac14cfa1b4c9fb9258e6b8c6a7" alt="Img V3 0211f Cb906c37 5e8d 4c44 Bed3 Bce56b67e8hu" width="2560" height="1640" data-path="images/img_v3_0211f_cb906c37-5e8d-4c44-bed3-bce56b67e8hu.jpg" />
        </Frame>
      </Tab>

      <Tab title="VS Code 扩展">
        点击上方的 Toggle Chat （快捷键 Ctrl+Alt+I）, 再点击 Codex。

        <Frame>
          <img src="https://mintcdn.com/matrixlabs/9M5olMZ8YMDkECKE/images/1.jpg?fit=max&auto=format&n=9M5olMZ8YMDkECKE&q=85&s=124310660b30cc2a012116473327aeac" alt="1" width="1360" height="940" data-path="images/1.jpg" />
        </Frame>

        完成！您现在可以使用 Codex for VS Code。
      </Tab>
    </Tabs>
  </Step>
</Steps>