Codex

OpenAI 提供了 Codex 编码 Agent。 可以按如下三种方式使用 TokenOff 提供的 OpenAI 模型服务:

• Codex App
• IDE Extension
• Codex CLI

三种使用方式的配置基本一致。

获取 API Key

前往 API 密钥 页面创建你的 API 密钥。

配置

Codex 支持全局配置，在用户的家目录下的 .codex 目录。

• 在 .codex 目录下创建配置文件 config.toml，内容如下:

  model = "gpt-5.3-codex"
  model_provider = "tokenoff"
  
  [model_providers.tokenoff]
  name = "TokenOff Chat Completions API"
  base_url = "https://tokenoff.com/api/v1"
  requires_openai_auth = false
  env_key = "TOKENOFF_API_KEY"
  http_headers = { "X-Api-Key" = "<your-api-key-here>" }

  上述配置中给出了两种鉴权的方式，分别是 env_key 和 http_headers，按需选择其中一种即可。

  选择其中一种，请把另一种方式对应的配置移除。

  • 如果是选择 env_key，填入的值代表的是 环境变量名称。值可以自定义，只要符合系统的环境变量命名要求即可。在使用 Codex 前，还需要 user profile 中添加环境变量，如下:

    export TOKENOFF_API_KEY=<your-api-key-here>

  • 如果是选择 http_headers，header 名称必须是 X-Api-Key，注意大小写。

• model 是默认使用的模型。可以不填。

Codex 也支持项目级别的配置，在打开的项目的根目录下，创建一个 .codex 目录，在其中创建 config.toml 文件即可定义项目级别的配置。优先级高于全局配置。

VSCode

OpenAI 提供了 VSCode 插件 --- Codex – OpenAI’s coding agent。

安装插件，按上述添加全局或者项目配置，即可使用。

如果是采用环境变量的方式设置鉴权，请确保环境变量已添加到 user profile 中。

Codex CLI

执行如下命令安装:

npm install -g @openai/codex

安装完成后，按上述添加全局或者项目配置，执行 codex 命令即可使用。

Codex App

目前官方支持 macOS 和 Windows。 按照 官方文档 安装。

Codex 的文档有使用区域限制，如果访问出现 403 错误，可使用 VPN 访问。

最佳实践

可以参考官方提供的 最佳实践 了解如何更好地使用 Codex。

由于官方文档存在服务区域限制，我们在 github 备份了最佳实践的文档。

联系我们