> ## Documentation Index
> Fetch the complete documentation index at: https://docs-vip.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="手动配置">
    1. 编辑 Codex 的配置文件，路径为 `.codex/config.toml`，将以下配置添加到配置文件中：

    ```toml theme={null}
    [model_providers.apigo]
    name = "Chat Completions API"
    base_url = "https://api-vip.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 = "gpt-5.4"
    model_provider = "apigo"
    ```

    2. 将 `APIGO_API_KEY` 设置为你的平台 Key。
    3. 使用指定的配置文件启动 Codex CLI：

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