跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.tokenlab.sh/llms.txt

Use this file to discover all available pages before exploring further.

​
概述

类型：编码工具主要路径：OpenAI Responses（高级可选路径）支持情况：在模型/路径限制下受支持
OpenAI Codex 是一个开源的命令行工具 (CLI)，作为轻量级的编码代理，能够在终端中读取、修改和运行代码。它基于 GPT 模型构建，并针对代码生成进行了优化。 对于 TokenLab，Codex CLI 可以使用 /v1/responses，但您应将其视为一个高级兼容路径。某些仅适用于 Responses 的功能并不保证在每个模型和路由路径上可用。 Codex CLI 远程压缩支持 POST /v1/responses/compact。Codex 在 /compact 和自动压缩时会把当前会话的 model 放在 body.model 中，因此请确保要用于压缩的模型在 Responses 路径上可用；不要配置 /v1/compact。

​
系统要求

  • OS：macOS、Linux（官方支持）、Windows 通过 WSL
  • Node.js：版本 18+
  • npm：版本 10.x.x 或更高

​
安装

npm install -g @openai/codex
验证安装： 
codex --version

​
配置

​
第 1 步：设置 API 密钥

临时（当前会话）： 
export OPENAI_API_KEY="sk-your-tokenlab-key"
永久配置： 添加到 ~/.bashrc、~/.zshrc 或 ~/.bash_profile： 
export OPENAI_API_KEY="sk-your-tokenlab-key"
然后重新加载： 
source ~/.zshrc  # or source ~/.bashrc

​
第 2 步：配置 config.toml

编辑 ~/.codex/config.toml： 
model_provider = "tokenlab"
model = "gpt-5.4"
model_reasoning_effort = "xhigh"
plan_mode_reasoning_effort = "xhigh"
fast_mode = true
model_context_window = 1000000
model_auto_compact_token_limit = 900000
sandbox_mode = "danger-full-access"
approval_policy = "never"

disable_response_storage = false
personality = "friendly"
service_tier = "fast"

[model_providers.tokenlab]
env_key = "OPENAI_API_KEY"
name = "TokenLab"
base_url = "https://api.tokenlab.sh/v1"
wire_api = "responses"
supports_websockets = true
websocket_connect_timeout_ms = 15000

[features]
responses_websockets = true
responses_websockets_v2 = true
此 WebSocket 模式是面向 Codex 客户端的 Responses-over-WebSocket 桥接层。它只接受 response.create 和 response.cancel；它不是 OpenAI Realtime API，也不接受 session.update、conversation.item.*、input_audio_buffer.*、二进制音频或嵌套的 Realtime response.create.response 信封。
如果配置文件不存在，请运行 codex 一次以生成该文件，然后编辑该文件。在更改 config.toml 后需完全重启 Codex，以便重新加载新的提供者设置。
Codex 正在弃用对自定义提供者的 chat/completions 支持。对于 TokenLab，请保持 wire_api = "responses"，除非您有意使用较旧的兼容路径。
如果请求使用了在所选模型或路由上不受支持的 Responses 专用字段，TokenLab 会返回明确的错误，而不是静默降级该请求。

​
基本用法

启动交互模式： 
codex
直接命令： 
codex "Fix the bug in main.py line 42"
指定模型： 
codex -m gpt-5.4 "Build a REST API server"

​
推荐模型

模型适用场景
gpt-5.4作为编码和推理的默认最佳选择
gpt-5-mini用于编码工作流的更快、更便宜的后备选项
claude-sonnet-4-6代码审查、文档编写
deepseek-r1算法设计、推理

​
交互命令

Command说明
/help显示帮助
/exit 或 Ctrl+C退出
/clear清除会话
/config查看配置
/model <name>切换模型
/tokens查看 token 使用情况

​
验证配置

# Check environment variable
echo $OPENAI_API_KEY

# Test API connection
codex "Hello, Codex!"

# View configuration
cat ~/.codex/config.toml

​
常见用例

代码审查： 
git diff | codex "Review these code changes"
生成提交信息： 
git diff --staged | codex "Generate a commit message for these changes"
修复错误： 
codex "Fix the TypeScript errors in src/components/"
解释代码： 
cat main.py | codex "Explain what this code does"

​
故障排除

  • 验证 base_url 在 config.toml 中是否为准确的 https://api.tokenlab.sh/v1
  • 检查网络连接
  • 确保没有代理干扰
  • 验证 env_key = "OPENAI_API_KEY" 是否存在于 ~/.codex/config.toml
  • 验证已设置 OPENAI_API_KEY 环境变量
  • 检查密钥是否以 sk- 开头
  • 确保密钥在 TokenLab 仪表板中处于激活状态
  • 某些字段仅在 TokenLab 能为所选模型和路由保证该行为时在 /v1/responses 可用
  • 如果看到 unsupported_request_field，请删除该字段或切换到不依赖该字段的工作流
  • Codex CLI 调用 POST /v1/responses/compact，不是 /v1/compact
  • 压缩请求使用当前会话的 model，因此该模型必须在 Responses 路径上可用
  • 保持 wire_api = "responses" 和 base_url = "https://api.tokenlab.sh/v1"