Codex CLI Configuration Guide
What is Codex CLI
Codex CLI is a powerful AI programming assistant that allows you to collaborate with AI directly in your terminal. Supported on macOS, Linux, and Windows (WSL).
Installation Requirements
- Node.js version ≥ 18.0
- Supported operating systems: macOS, Linux, Windows (WSL)
Note
If you are using Windows, make sure you have WSL installed to use Codex CLI. Do not use Windows built-in cmd.
Installation Steps
1. Install Node.js
If you haven't installed Node.js 18.0 or higher, please install it first.
2. Install Codex CLI
Install using npm:
npm install -g @openai/codexOr using Homebrew (macOS):
brew install codexConfigure ai.TokenHub API
Get Required Configuration
You need to prepare two important configuration items:
| Config | Description | How to Get |
|---|---|---|
| OPENAI_API_KEY | API authentication token | Get from API Keys page after registration (starts with sk-) |
| OPENAI_BASE_URL | API service address | Use https://ai-tokenhub.com/v1 |
Configure Environment Variables
Method 1: Temporary Configuration
Run in your project directory:
export OPENAI_API_KEY="your_api_key_here"
export OPENAI_BASE_URL="https://ai-tokenhub.com/v1"Method 2: Permanent Configuration
To avoid manually setting environment variables each time, add the configuration to your system config file:
# Add the following to ~/.bashrc or ~/.zshrc
export OPENAI_API_KEY="your_api_key_here"
export OPENAI_BASE_URL="https://ai-tokenhub.com/v1"Then run:
source ~/.bashrc # or source ~/.zshrcRunning Codex CLI
Determine the Model to Use
If you want to use the model gpt-5, the corresponding model name on the platform is gpt-5-2025-08-07, so you need to use the parameter --model gpt-5-2025-08-07 when starting.
Launch Codex CLI
Enter your project directory and run:
codexSelect option 2 (Run Codex CLI using API).
First Run Authorization
On first run, select option 1 to grant permissions.
Test Verification
After successful startup, enter "Hello" to test.
FAQ
Request Failed
Check if the API Key is correct and if the account has sufficient balance.
Connection Timeout
Check network connectivity and ensure you can access https://ai-tokenhub.com.
Wrong Model Name
Ensure the model name is spelled correctly. Please check the platform for available models.