Codex GUI/CLI setup

View the official Codex GUI (desktop) installation guide ↗

View the official Codex CLI installation guide ↗

Connect to Supakook

The GUI and CLI use the same configuration. Prepare your Supakook API key and configure it once.

Windows

Find the .codex folder in your user home directory and edit config.toml. If the folder does not exist, create it with the PowerShell commands below.

User configuration file: .codex\config.toml

PowerShell

New-Item -ItemType Directory -Force "$env:USERPROFILE\.codex" | Out-Null
notepad "$env:USERPROFILE\.codex\config.toml"

Linux

User configuration file: ~/.codex/config.toml

Use nano

Open the configuration file

mkdir -p ~/.codex
nano ~/.codex/config.toml

Paste the configuration, press Ctrl+O and Enter to save, then Ctrl+X to exit.

No nano? Install nano

Run the following commands on Ubuntu / Debian, then use the editor command above.

Ubuntu / Debian

sudo apt update
sudo apt install nano

Use Vim

Open the configuration file

mkdir -p ~/.codex
vim ~/.codex/config.toml

Press i to enter insert mode and paste the configuration. Press Esc, type :wq, and press Enter to save and exit.

No Vim? Install Vim

Run the following commands on Ubuntu / Debian, then use the editor command above.

Ubuntu / Debian

sudo apt update
sudo apt install vim

macOS

User configuration file: ~/.codex/config.toml

Use nano

mkdir -p ~/.codex
nano ~/.codex/config.toml

Paste the configuration, press Ctrl+O and Enter to save, then Ctrl+X to exit.

Add the following configuration to config.toml and save it.

config.toml

model_provider = "OpenAI"
model = "gpt-6-astra"
review_model = "gpt-6-astra"
disable_response_storage = true
network_access = "enabled"
windows_wsl_setup_acknowledged = true

[model_providers.OpenAI]
name = "OpenAI"
base_url = "https://api.supakook.com/v1"
wire_api = "responses"
requires_openai_auth = true

[features]
goals = true

Create auth.json in the same .codex folder, enter your API key, and save it.

Windows

.codex\auth.json

PowerShell

New-Item -ItemType Directory -Force "$env:USERPROFILE\.codex" | Out-Null
notepad "$env:USERPROFILE\.codex\auth.json"

Linux

~/.codex/auth.json

Use nano

Open the configuration file

mkdir -p ~/.codex
nano ~/.codex/auth.json

Paste the configuration, press Ctrl+O and Enter to save, then Ctrl+X to exit.

No nano? Install nano

Run the following commands on Ubuntu / Debian, then use the editor command above.

Ubuntu / Debian

sudo apt update
sudo apt install nano

Use Vim

Open the configuration file

mkdir -p ~/.codex
vim ~/.codex/auth.json

Press i to enter insert mode and paste the configuration. Press Esc, type :wq, and press Enter to save and exit.

No Vim? Install Vim

Run the following commands on Ubuntu / Debian, then use the editor command above.

Ubuntu / Debian

sudo apt update
sudo apt install vim

macOS

~/.codex/auth.json

Use nano

mkdir -p ~/.codex
nano ~/.codex/auth.json

Paste the configuration, press Ctrl+O and Enter to save, then Ctrl+X to exit.

auth.json

{
  "OPENAI_API_KEY": "YOUR_API_KEY"
}

We recommend CC Switch, currently the most popular open-source tool for configuring local API keys.

Tip: CODEX_HOME is an environment variable that sets a custom directory for Codex configuration and data. If you have not set it, use the default paths above; otherwise, edit the files in your chosen directory. WSL is a Linux environment within Windows and uses a separate Linux user directory.

Restart and verify

If Codex is running, close it first, then reopen the desktop app or enter codex in your terminal to start the CLI and send a message; a normal reply means the setup was successful.