Codex Custom for Windows

This is an independently maintained custom build of OpenAI Codex, currently based on 0.153.4. It is not an official OpenAI distribution. Upstream source history and license notices are retained.

The custom Rust change is in codex-rs/tui/src/keymap.rs: a Windows-only Ctrl+Enter newline binding preserves Shift+Enter behavior in console environments that report it as Enter+CONTROL. Other platforms retain their upstream bindings.

For a working Windows installation:

• Build the main CLI from the custom branch with cargo build --release --bin codex in codex-rs.
• Install the matching 0.153.4 codex-code-mode-host.exe beside codex.exe. Building only the main CLI does not produce this helper. The official release provides it separately; the x86_64 Windows .exe has SHA-256 deaebc21f354f151fcebeac46e12c6e8c4ef75ee448e25e3577502074e04b8d9.
• When sharing existing state databases with official Windows builds, preserve matching migration line endings. This custom build normalizes SQL files in every codex-rs/state/*migrations/ directory to CRLF before compiling.

Personal credentials, MCP configuration, conversations, and machine-specific installation scripts are not part of this repository. The upstream installation commands below install official Codex rather than this custom build.

Upstream README

Codex CLI is a coding agent from OpenAI that runs locally on your computer.

If you want Codex in your code editor (VS Code, Cursor, Windsurf), install in your IDE.
If you want the desktop app experience, run codex app or visit the Codex App page.
If you are looking for the cloud-based agent from OpenAI, Codex Web, go to chatgpt.com/codex.

---

Quickstart

Installing and running Codex CLI

Run the following on Mac or Linux to install Codex CLI:

curl -fsSL https://chatgpt.com/codex/install.sh | sh

Run the following on Windows to install Codex CLI:

powershell -ExecutionPolicy ByPass -c "irm https://chatgpt.com/codex/install.ps1 | iex"

The standalone installers download from https://releases.openai.com/codex by default and fall back to GitHub Releases if a metadata or asset download is unavailable. To force GitHub Releases, set CODEX_INSTALLER_USE_RELEASES_OPENAI_COM to false (0 and no are also accepted):

curl -fsSL https://chatgpt.com/codex/install.sh | CODEX_INSTALLER_USE_RELEASES_OPENAI_COM=false sh

$env:CODEX_INSTALLER_USE_RELEASES_OPENAI_COM='false'; irm https://chatgpt.com/codex/install.ps1 | iex

Codex CLI can also be installed via the following package managers:

# Install using npm
npm install -g @openai/codex

# Install using Homebrew
brew install --cask codex

Then simply run codex to get started.

You can also go to the latest GitHub Release and download the appropriate binary for your platform.

Each GitHub Release contains many executables, but in practice, you likely want one of these:

• macOS
  • Apple Silicon/arm64: codex-aarch64-apple-darwin.tar.gz
  • x86_64 (older Mac hardware): codex-x86_64-apple-darwin.tar.gz
• Linux
  • x86_64: codex-x86_64-unknown-linux-musl.tar.gz
  • arm64: codex-aarch64-unknown-linux-musl.tar.gz

Each archive contains a single entry with the platform baked into the name (e.g., codex-x86_64-unknown-linux-musl), so you likely want to rename it to codex after extracting it.

Using Codex with your ChatGPT plan

Run codex and select Sign in with ChatGPT. We recommend signing into your ChatGPT account to use Codex as part of your Plus, Pro, Business, Edu, or Enterprise plan. Learn more about what's included in your ChatGPT plan.

You can also use Codex with an API key, but this requires additional setup.

Docs

• Codex Documentation
• Contributing
• Installing & building
• Open source fund

This repository is licensed under the Apache-2.0 License.