Deploy CodeX CLI

Configure OpenAI CodeX CLI to use 3xCoder as its API endpoint.

Prerequisites

• Node.js installed (v22+)
• A 3xCoder API key

Step 1: Install CodeX CLI

npm install -g @openai/codex

Verify installation:

codex --version

Step 2: Configure CodeX

CodeX CLI uses two configuration files: config.toml for the API endpoint and auth.json for authentication.

Windows

Config file: %APPDATA%\codex\config.toml

[api]
base_url = "https://api.3xcoder.com/v1"

Auth file: %APPDATA%\codex\auth.json

{
  "api_key": "sk-your-api-key-here"
}

macOS

Config file: ~/Library/Application Support/codex/config.toml

[api]
base_url = "https://api.3xcoder.com/v1"

Auth file: ~/Library/Application Support/codex/auth.json

{
  "api_key": "sk-your-api-key-here"
}

Linux

Config file: ~/.config/codex/config.toml

[api]
base_url = "https://api.3xcoder.com/v1"

Auth file: ~/.config/codex/auth.json

{
  "api_key": "sk-your-api-key-here"
}

Step 3: Verify

Run CodeX:

codex "Hello, what can you do?"

Alternative: Environment Variables

You can also configure CodeX using environment variables:

Windows PowerShell

$env:OPENAI_BASE_URL = "https://api.3xcoder.com/v1"
$env:OPENAI_API_KEY = "sk-your-api-key-here"
codex "Hello!"

macOS / Linux

export OPENAI_BASE_URL="https://api.3xcoder.com/v1"
export OPENAI_API_KEY="sk-your-api-key-here"
codex "Hello!"

TIP

To make environment variables permanent, add the export lines to your shell profile (~/.bashrc, ~/.zshrc, or $PROFILE for PowerShell).

Using CC-Switch

You can also configure CodeX through CC-Switch:

1. Run npx cc-switch@latest
2. Select CodeX as the target tool
3. Set base URL to https://api.3xcoder.com/v1
4. Enter your API key
5. Apply the configuration

Troubleshooting

codex: command not found

• Ensure Node.js is installed and npm global bin is in your PATH
• Try reinstalling: npm install -g @openai/codex

API connection errors

• Verify your API key: curl https://api.3xcoder.com/v1/models -H "Authorization: Bearer sk-your-key"
• Check config file paths are correct for your OS
• Ensure no trailing slash on the base URL

Model errors

• CodeX uses OpenAI models by default. Verify the model is available through your 3xCoder account