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

# Codex CLI

> 在 Codex CLI 中使用 ApiGo 提供的模型进行 AI 编程。

## 安装 Codex CLI

使用 `npm` 全局安装 Codex CLI：

```bash theme={null}
# 建议使用 0.57.0 版本
npm i -g @openai/codex@0.57.0
```

## 配置 ApiGo API

> **重要提示：使用前请先清除 OpenAI 环境变量**
>
> 在配置前，请确保清除以下 OpenAI 相关的环境变量，以免影响 ApiGo API 的正常使用：
>
> * `OPENAI_BASE_URL`
> * `OPENAI_API_KEY`

## 选择接入方式

<Tabs>
  <Tab title="@apigo/vibe-coding">
    `@apigo/vibe-coding` 对应的是交互式终端工具 **Agent CLI Switch**。这一方式会直接帮你切换和写入 Codex 配置。

    可按截图中的实际流程操作：

    1. 打开 **Agent CLI Switch v0.1.0**。
    2. 在 **主菜单** 中选择 **配置工具**。

    <Frame>
      <img src="https://mintcdn.com/apigo/ooezceiFlVzP_oNP/images/coding-plan/vibe-coding/main-menu.png?fit=max&auto=format&n=ooezceiFlVzP_oNP&q=85&s=43f9a32685ab9f5dfa59217798a10ae0" alt="Agent CLI Switch 主菜单，当前选中“配置工具”。" style={{ borderRadius: '0.5rem' }} width="1238" height="956" data-path="images/coding-plan/vibe-coding/main-menu.png" />
    </Frame>

    3. 进入 **选择工具**，选择 **Codex**。

    <Frame>
      <img src="https://mintcdn.com/apigo/ooezceiFlVzP_oNP/images/coding-plan/vibe-coding/select-tool.png?fit=max&auto=format&n=ooezceiFlVzP_oNP&q=85&s=d53ff51f4047b809ce1482fec80b7ea1" alt="Agent CLI Switch 的选择工具界面，可在 Claude Code 和 Codex 间切换。" style={{ borderRadius: '0.5rem' }} width="1354" height="824" data-path="images/coding-plan/vibe-coding/select-tool.png" />
    </Frame>

    4. 进入 **Codex 编辑配置** 后，按提示输入：
       `API 地址`：`https://maas.apigo.ai/v1`
       `API Key`：你的 ApiGo Key
    5. 看到“配置已保存”后，选择立即应用配置。

    应用完成后，直接运行 `codex` 即可。使用前请先到 [模型广场](https://www.apigo.ai/models) 确认 Token Plan 当前支持的模型 ID，再按需选择。
  </Tab>

  <Tab title="手动配置（当前方式）">
    1. 编辑 Codex 的配置文件，路径为 `.codex/config.toml`，将以下配置添加到配置文件中：

    ```toml theme={null}
    [model_providers.apigo]
    name = "Chat Completions API"
    base_url = "https://maas.apigo.ai/v1"
    env_key = "APIGO_API_KEY"
    wire_api = "chat"
    requires_openai_auth = false
    request_max_retries = 4
    stream_max_retries = 10
    stream_idle_timeout_ms = 300000

    [profiles.apigo]
    model = "your-model-id"
    model_provider = "apigo"
    ```

    2. 将 `APIGO_API_KEY` 设置为你的平台 Key，并把 `your-model-id` 替换为 [模型广场](https://www.apigo.ai/models) 中当前仍支持的模型 ID。

    3. 使用指定的配置文件启动 Codex CLI：

    ```bash theme={null}
    codex --profile apigo
    ```
  </Tab>
</Tabs>