🤖 CodeX Setup

CodeX is OpenAI's GPT-based AI coding assistant CLI tool. By routing through this platform, you can access CodeX with a unified API key. Official docs

📋 Prerequisites

Node.js 18+ (see Install Node.js)
An API key from this platform (create one in API Key Management)

⚡ Installation

npm install -g @openai/codex@latest
codex --version

⚙️ Configuration

CodeX stores configuration in ~/.codex/. You need to create two files:

Step 1: Create Config Directory

macOS / Linux

mkdir -p ~/.codex && cd ~/.codex

Windows (PowerShell)

mkdir $env:USERPROFILE\.codex
cd $env:USERPROFILE\.codex

Step 2: Create config.toml

model_provider = "custom"
model = "codex-mini-latest"
approval_policy = "on-request"

[model_providers.custom]
name = "TokenReply"
base_url = "https://api.tokenreply.com/v1"
wire_api = "responses"
requires_openai_auth = true

Step 3: Create auth.json

{
  "OPENAI_API_KEY": "sk-xxx"
}

Replace sk-xxx with your API Key.

⚠️ Important

Ensure your token has access to CodeX / GPT models. Different models may require different token group permissions.

🚀 Start Using

cd your-project
codex

❓ Troubleshooting

Connection Failed

Verify base_url is set to https://api.tokenreply.com/v1
Verify the API key is valid and the account has in-plan usage available; once in-plan usage runs out, paid models fall through to the wallet balance, so make sure it is sufficient
Check config file paths and format

Config File Locations

macOS / Linux: ~/.codex/
Windows: %USERPROFILE%\.codex\