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

# Codex 接入

> 将 Codex 接入极鸽，快速开始文档与研发协作

通过以下步骤，你可以将 Codex 接入极鸽并开始使用。

## 前置准备

* 你已安装 Node.js 18 或更高版本
* 你已有可用的极鸽 API 密钥
* 你可以访问终端（macOS、Linux 或 Windows 均可）

## 接入步骤

<Steps>
  <Step title="安装 Codex 命令行工具">
    ```bash theme={null}
    npm install -g @openai/codex
    ```

    安装完成后，建议执行以下命令确认安装成功：

    ```bash theme={null}
    codex --version
    ```
  </Step>

  <Step title="创建极鸽令牌">
    先进入极鸽控制台的**令牌管理**页面，创建一个新的访问令牌。\
    创建后请保存好令牌，后续会写入 `auth.json`。
  </Step>

  <Step title="配置 Codex 模型提供方">
    编辑 `~/config.toml`（`~` 表示你的用户主目录），填入以下配置：

    ```toml theme={null}
    model_provider = "jige"
    model = "gpt-5.3-codex"

    model_reasoning_effort = "medium"
    disable_response_storage = true

    [model_providers.jige]
    name = "jige"
    base_url = "https://jige.io/v1"
    wire_api = "responses"
    requires_openai_auth = true
    ```
  </Step>

  <Step title="配置 API 密钥">
    编辑 `~/auth.json`（`~` 表示你的用户主目录），写入你的极鸽令牌：

    ```json theme={null}
    {
      "OPENAI_API_KEY": "sk-mcfxxxx"
    }
    ```
  </Step>

  <Step title="开始使用 Codex">
    在项目目录运行：

    ```bash theme={null}
    codex
    ```

    进入后，你可以直接让 Codex 协助你完成文档编写、代码修改和命令执行。
  </Step>
</Steps>

## 常见问题

### 无法连接接口

请检查 `~/config.toml` 中 `base_url` 是否为 `https://jige.io/v1`，并确认当前网络环境可访问极鸽接口。