OpenAI clients

Prerequisites

Codex CLI requires Node.js (npm is included); the graphical clients need no extra setup.

1. Install

Install Codex CLI:

npm install --global @openai/codex

npm install --global @openai/codex

For a graphical client, install the ChatGPT app or Codex desktop app from the official OpenAI download page. Use Codex CLI on Linux.

2. Configure manually

Edit config.toml on the target system.

Preserve existing sandbox, MCP, project, and desktop settings in config.toml. Add or update only the top-level model_provider and model_providers.GetRun section below.

model_provider = "GetRun"

[model_providers.GetRun]
name = "GetRun"
base_url = "https://api.get-apikey.com/v1"
wire_api = "responses"
requires_openai_auth = true
experimental_bearer_token = "sk-xxxxx-xxx"

Replace sk-xxxxx-xxx with your GetRun API Key.

Windows

$codexHome = if ($env:CODEX_HOME) { $env:CODEX_HOME } else { Join-Path $HOME ".codex" }
New-Item -ItemType Directory -Force -Path $codexHome | Out-Null
notepad (Join-Path $codexHome "config.toml")

Paste and save the configuration above.

macOS

CODEX_DIR="${CODEX_HOME:-$HOME/.codex}"
mkdir -p "$CODEX_DIR"
open -e "$CODEX_DIR/config.toml"

Paste and save the configuration above.

Linux

CODEX_DIR="${CODEX_HOME:-$HOME/.codex}"
mkdir -p "$CODEX_DIR"
${EDITOR:-vi} "$CODEX_DIR/config.toml"

Paste and save the configuration above.

3. Restart

Fully quit the ChatGPT app, Codex CLI, or the Codex desktop app. Close and reopen the terminal, then start the client again.

4. Confirm a reply

Send one message:

codex exec --skip-git-repo-check "Reply only with OK"

The setup is complete when Codex CLI replies OK. In a graphical client, start a new conversation and send “Reply only with OK”.