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:

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


Run the following on Windows to install Codex CLI:

shell
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):

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


powershell
$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:

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


shell
 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.

Top issues

Discussions

Latest release

New Features

- Open the agent command center with codex agents --no-daemon. The command center and session picker now mark unread results (58238, 58239, 58263, 58264).
- Switch between connected backends from the terminal session picker and keep your drafts when switching (58280, 58457).
- Preview local image attachments while composing on supported terminals, and open viewed local images from clickable transcript paths (58261, 58446).
- Find API key and cloud provider options under “Sign in another way.” Enable gcp_setup_wizard to set up Google Cloud Vertex AI with Application Default Creden