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

# 在 Codex CLI 中使用 Sub2API

> 配置 Codex CLI 使用 Sub2API 作为 API 后端，支持 OpenAI 兼容格式，快速在终端中使用 AI 编程助手。

你可以通过 Codex CLI 在终端中直接调用 Sub2API 提供的多种模型，包括 GPT 系列、Claude、Gemini 等。Codex CLI 使用 OpenAI 兼容格式，因此只需配置 OPENAI\_API\_KEY 和 OPENAI\_BASE\_URL 两个环境变量即可。

## 前置条件

* 已安装 Node.js（推荐 18 及以上版本）
* 已获取 Sub2API API Key（详见 [创建 API Key](/getting-started/create-api-key)）
* 已安装 Codex CLI

## 安装 Codex CLI

通过 npm 全局安装 Codex CLI：

```bash theme={null}
# macOS / Linux
npm install -g @openai/codex

# Windows
npm install -g @openai/codex
```

## 配置环境变量

将 Sub2API 设置为 Codex CLI 的 API 后端：

```bash theme={null}
# macOS / Linux
export OPENAI_API_KEY="your_sub2api_key"
export OPENAI_BASE_URL="https://sub2api.ruilinlu.com"

# Windows PowerShell
$env:OPENAI_API_KEY="your_sub2api_key"
$env:OPENAI_BASE_URL="https://sub2api.ruilinlu.com"
```

> 截图占位：此处可插入实际客户端配置截图

## 运行 Codex CLI

配置完成后，直接在终端中使用 codex 命令：

```bash theme={null}
# 使用默认模型执行一次性任务
codex "请解释这段代码的作用"

# 进入交互式模式
codex
```

## 使用项目级 env 文件

推荐在每个项目的根目录下创建 `.env` 文件，便于管理不同项目的 API Key 和配置：

```bash theme={null}
OPENAI_API_KEY=your_sub2api_key
OPENAI_BASE_URL=https://sub2api.ruilinlu.com
```

Codex CLI 会自动读取项目目录下的 `.env` 文件加载环境变量。

## 故障排查

<Accordion title="提示 401 Unauthorized 错误">
  * 请确认 OPENAI\_API\_KEY 已正确设置为 Sub2API API Key
  * 确认环境变量已正确导出（可使用 `echo $OPENAI_API_KEY` 检查）
  * 参考 [401 错误排查](/troubleshooting/401)
</Accordion>

<Accordion title="提示无法连接到 API">
  * 确认 OPENAI\_BASE\_URL 已设置为 `https://sub2api.ruilinlu.com`（注意无尾部斜杠）
  * 检查网络连通性，尝试 `curl https://sub2api.ruilinlu.com`
  * 参考 [Base URL 配置](/configuration/base-url)
</Accordion>

<Accordion title="模型不可用或返回错误">
  * 确认所请求的模型在 Sub2API 支持列表中
  * 使用 `codex --model gpt-4o` 显式指定模型名称
</Accordion>

你可以通过 Codex CLI 在终端中直接调用 Sub2API 提供的多种模型，包括 GPT 系列、Claude、Gemini 等。Codex CLI 使用 OpenAI 兼容格式，因此只需配置 OPENAI\_API\_KEY 和 OPENAI\_BASE\_URL 两个环境变量即可。

## 前置条件

* 已安装 Node.js（推荐 18 及以上版本）
* 已获取 Sub2API API Key（详见 [创建 API Key](/getting-started/create-api-key)）
* 已安装 Codex CLI

## 安装 Codex CLI

通过 npm 全局安装 Codex CLI：

```bash theme={null}
# macOS / Linux
npm install -g @openai/codex

# Windows
npm install -g @openai/codex
```

## 配置环境变量

将 Sub2API 设置为 Codex CLI 的 API 后端：

```bash theme={null}
# macOS / Linux
export OPENAI_API_KEY="your_sub2api_key"
export OPENAI_BASE_URL="https://sub2api.ruilinlu.com"

# Windows PowerShell
$env:OPENAI_API_KEY="your_sub2api_key"
$env:OPENAI_BASE_URL="https://sub2api.ruilinlu.com"
```

> 截图占位：此处可插入实际客户端配置截图

## 运行 Codex CLI

配置完成后，直接在终端中使用 codex 命令：

```bash theme={null}
# 使用默认模型执行一次性任务
codex "请解释这段代码的作用"

# 进入交互式模式
codex
```

## 使用项目级 env 文件

推荐在每个项目的根目录下创建 `.env` 文件，便于管理不同项目的 API Key 和配置：

```bash theme={null}
OPENAI_API_KEY=your_sub2api_key
OPENAI_BASE_URL=https://sub2api.ruilinlu.com
```

Codex CLI 会自动读取项目目录下的 `.env` 文件加载环境变量。

## 故障排查

<Accordion title="提示 401 Unauthorized 错误">
  * 请确认 OPENAI\_API\_KEY 已正确设置为 Sub2API API Key
  * 确认环境变量已正确导出（可使用 `echo $OPENAI_API_KEY` 检查）
  * 参考 [401 错误排查](/troubleshooting/401)
</Accordion>

<Accordion title="提示无法连接到 API">
  * 确认 OPENAI\_BASE\_URL 已设置为 `https://sub2api.ruilinlu.com`（注意无尾部斜杠）
  * 检查网络连通性，尝试 `curl https://sub2api.ruilinlu.com`
  * 参考 [Base URL 配置](/configuration/base-url)
</Accordion>

<Accordion title="模型不可用或返回错误">
  * 确认所请求的模型在 Sub2API 支持列表中
  * 使用 `codex --model gpt-4o` 显式指定模型名称
</Accordion>