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

# Codex

## Codex

Codex 是 OpenAI 提供的 AI 编程助手，既有命令行工具（Codex CLI），也有 VS Code 扩展。本指南介绍如何将 Codex 连接到 Siflow Model Inference API，并使用平台模型完成编程任务。CLI 和扩展共用同一份 `config.toml`，因此下面的配置同时适用于两者。

Codex 的配置通过主目录中的 `config.toml` 文件完成，通常位于 `~/.codex/config.toml`。完整配置项请参见 [Codex Configuration Reference](https://developers.openai.com/codex/config-reference)。

支持的模型包括 **glm-5.2** 和 **kimi-k2.6**。您可以在 [模型广场](https://console.siflow.cn/maas-api/model_plaza) 中查看价格。

***

### 安装 Codex

如果使用 CLI，可通过 npm（或 Homebrew）安装：

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

其他安装方式请参见[官方安装指南](https://github.com/openai/codex#installation)。

如果使用 VS Code 扩展：

1. 在 VS Code 中打开 **Extensions**（`Ctrl+Shift+X` / `Cmd+Shift+X`）。
2. 搜索 **Codex** 并安装官方扩展。

<img src="https://mintcdn.com/siflow/vap4jT3tfBA1sSQZ/products/model-inference/img/codex_ext.png?fit=max&auto=format&n=vap4jT3tfBA1sSQZ&q=85&s=264c61e567a39b7cf665c97c0dd09a72" alt="Codex 扩展市场页面" width="1778" height="1210" data-path="products/model-inference/img/codex_ext.png" />

3. 点击编辑器右上角的 Codex 图标，打开 **CODEX** 面板。

***

### 配置模型

Codex 会从 `~/.codex/config.toml` 读取配置。请先在 Siflow 的 [API 密钥管理](https://console.siflow.cn/maas-api/api_keys) 页面创建 API 密钥，再通过**以下两种方式之一**提供给 Codex。

#### 方式一：通过环境变量提供 API 密钥

编辑 `~/.codex/config.toml`，使用 `env_key` 指向一个环境变量：

```toml theme={null}
model = "kimi-k2.6"
model_provider = "siflow"
approval_policy = "never"
sandbox_mode = "workspace-write"

[model_providers.siflow]
name = "Siflow"
base_url = "https://api.siflow.cn/model-api"
env_key = "SIFLOW_API_KEY"
wire_api = "responses"
```

在启动 Codex 前设置该密钥：

```bash theme={null}
export SIFLOW_API_KEY="<Your API Key>"
code .
```

#### 方式二：在配置文件中提供令牌

如果您不想使用环境变量，可以用 `experimental_bearer_token` 替代 `env_key`，将密钥直接写入 `config.toml`。这样就不需要再额外执行 `export`：

```toml theme={null}
model = "kimi-k2.6"
model_provider = "siflow"
approval_policy = "never"
sandbox_mode = "workspace-write"
model_reasoning_effort = "medium"

[model_providers.siflow]
name = "Siflow"
base_url = "https://api.siflow.cn/model-api"
experimental_bearer_token = "<API_KEY>"
wire_api = "responses"
```

由于密钥保存在文件中，请勿将 `config.toml` 纳入版本控制。

无论采用哪种方式，配置完成后都可以在 Codex 中使用对应模型：

<img src="https://mintcdn.com/siflow/vap4jT3tfBA1sSQZ/products/model-inference/img/codex_open_source.png?fit=max&auto=format&n=vap4jT3tfBA1sSQZ&q=85&s=56b3b208d77190acccad8ee4a1fb48e1" alt="Codex — 模型配置" width="3006" height="1764" data-path="products/model-inference/img/codex_open_source.png" />

| 字段                          | 说明                                                                               |
| --------------------------- | -------------------------------------------------------------------------------- |
| model                       | 来自 [模型广场](https://console.siflow.cn/maas-api/model_plaza) 的模型 ID，例如 `kimi-k2.6`。 |
| model\_provider             | 必须与 `[model_providers.<name>]` 小节名称一致，这里使用 `siflow`。                             |
| approval\_policy            | `never` 表示不弹出审批提示；`on-request` 或 `untrusted` 提供更细的控制。                            |
| sandbox\_mode               | `workspace-write` 表示可在工作区内读取和编辑文件；`read-only` 为只读模式。                             |
| base\_url                   | Siflow Model Inference API 的接入地址：`https://api.siflow.cn/model-api`。              |
| wire\_api                   | 对于最新版本的 Codex，请使用 `responses`。                                                   |
| env\_key                    | （方式一）保存您的 API 密钥的环境变量，例如 `SIFLOW_API_KEY`。                                       |
| experimental\_bearer\_token | （方式二）您的 Siflow API 密钥，直接嵌入而非通过 `env_key` 提供。                                     |
| model\_reasoning\_effort    | 模型的推理深度，例如 `low`、`medium` 或 `high`。                                              |

***

### MCP 服务器（可选）

某些内置工具类型（如 `web_search`）在这些模型上可能不可用。您可以通过 **MCP（Model Context Protocol）服务器**补充这些能力，例如在 `config.toml` 的 `[mcp_servers.<name>]` 下配置一个搜索类 MCP 服务器，这样 Codex 在需要联网搜索时就可以调用它。MCP 服务器的配置细节请参见 [Codex Configuration Reference](https://developers.openai.com/codex/config-reference)。

***

### 注意事项

* 请勿将 `SIFLOW_API_KEY` 和其他密钥纳入 Git——请使用环境变量或被版本控制忽略的本地 `.env` 文件。
* 请确保 base URL 使用完整且准确的地址：`https://api.siflow.cn/model-api`。
* 上下文长度和价格因模型而异——请参见 [模型广场](https://console.siflow.cn/maas-api/model_plaza)。