> ## Documentation Index
> Fetch the complete documentation index at: https://veniceai-mintlify-6ce01df5.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Codex CLI

> 通过本地 config.toml 文件将 OpenAI Codex CLI 与 Venice AI 模型一起使用

本指南展示如何通过 Codex 官方配置路径（用户级 `~/.codex/config.toml` 或项目级 `.codex/config.toml`）让 OpenAI Codex CLI 与 Venice 协同工作。

<CardGroup cols={3}>
  <Card title="简单设置" icon="gear">
    在项目中放置一个配置文件
  </Card>

  <Card title="OpenAI 兼容" icon="plug">
    使用 Venice 兼容 OpenAI 的 API
  </Card>

  <Card title="模型灵活性" icon="microchip">
    可替换为任意受支持的 Venice 文本模型
  </Card>
</CardGroup>

***

## 前置条件

* 来自 [venice.ai/settings/api](https://venice.ai/settings/api) 的 Venice API 密钥
* 已在您的机器上安装并可正常使用的 Codex CLI

***

## 设置

<Steps>
  <Step title="创建项目配置路径">
    从项目根目录执行：

    ```bash theme={"system"}
    mkdir -p .codex
    ```
  </Step>

  <Step title="创建 .codex/config.toml">
    创建该文件并粘贴以下配置：

    ```toml theme={"system"}
    #:schema https://developers.openai.com/codex/config-schema.json

    model = "openai-gpt-54" # use any Venice model
    model_provider = "venice"
    model_reasoning_effort = "high"
    personality = "pragmatic"
    sandbox_mode = "workspace-write"

    [model_providers.venice]
    name = "Venice"
    base_url = "https://api.venice.ai/api/v1/"
    experimental_bearer_token = "YOUR VENICE API KEY"
    wire_api = "responses"
    ```
  </Step>

  <Step title="替换两个占位符">
    更新：

    * `model` 替换为您想使用的 Venice 模型 ID
    * `experimental_bearer_token` 替换为您真实的 Venice API 密钥

    可在[文本模型目录](/models/text)中浏览可用的模型 ID。
  </Step>

  <Step title="正常运行 Codex CLI">
    从同一项目启动 Codex CLI。它将加载 `.codex/config.toml`（用于可信项目），并通过 Venice 路由请求。
  </Step>
</Steps>

***

## 官方 Codex 配置位置

* **用户默认**：`~/.codex/config.toml`
* **项目覆盖**：`.codex/config.toml`（仅对可信项目加载）

如果您希望 Venice 设置在所有地方生效，请将相同配置放入 `~/.codex/config.toml`。

***

## 配置优先级（从高到低）

1. CLI 标志和 `--config` 覆盖
2. Profile 值（`--profile <name>`）
3. 项目配置层（`.codex/config.toml`，最近的目录优先）
4. 用户配置（`~/.codex/config.toml`）
5. 系统配置（`/etc/codex/config.toml`，Unix）
6. 内置默认值

***

## 注意事项

* 请妥善保管您的 API 密钥，切勿将真实密钥提交到 git。
* 当项目被标记为不可信时，Codex 会忽略项目的 `.codex/` 配置。
* 如果切换模型，只需更新 `model` 字段。
* 此提供商设置要求 `wire_api = "responses"`。

***

## 资源

<CardGroup cols={2}>
  <Card title="Venice API 参考" icon="book" href="/api-reference/api-spec">
    完整端点和参数文档
  </Card>

  <Card title="Venice 文本模型" icon="list" href="/models/text">
    可用的模型 ID
  </Card>
</CardGroup>