codex README

The project's README from github.com/openai/codex. As one markdown file: README.md.

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

Codex CLI splash


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

This repository is licensed under the Apache-2.0 License.

codex (openai/codex)

Searching Database…

129.7K ·GitHub
Codex
What is this?Codex is a lightweight coding agent from OpenAI that runs locally in your terminal, helping you write and work with code using natural language.
Is this just a CLI, or does it also come as an editor extension or desktop app?The core is a terminal CLI, but Codex is also available as an extension for VS Code, Cursor and Windsurf, as a standalone desktop app (codex app), and as a separate cloud-based version called Codex Web.
Do I need a ChatGPT subscription, or can I use an API key?Codex works with your ChatGPT Plus, Pro, Business, Edu, or Enterprise plan via 'Sign in with ChatGPT', or alternatively with an OpenAI API key.
Is using an API key as simple as signing in with ChatGPT?No, using Codex with an API key is supported but requires additional setup compared to just signing in with your ChatGPT account.
Which platforms does it run on?Prebuilt binaries are provided for macOS (Apple Silicon and Intel/x86_64) and Linux (x86_64 and arm64); no Windows release is mentioned.
What is 'codex app'?It is the desktop app version of Codex, launched by running the 'codex app' command or downloading it from the website, giving a GUI alongside the terminal CLI.
What is Codex Web?Codex Web is OpenAI's cloud-based version of the coding agent, separate from the locally running CLI, meant for running Codex without installing anything.
Can I use Codex directly inside my code editor?Yes, Codex is available as an extension for VS Code, Cursor, and Windsurf, so you can use the same agent without leaving your editor.
What are similar projects?billion-context, qwen-code, Baize, oh-my-pi, agent-router, continue, copperhead, openrig
Which topics is it in?ai-coding-agent, vscode, gpt, coding-agents, chatgpt, cli-tool, agents, command-line, coding-agent, ai-agent, openai, rust
Creator
openai
Size
668.9 MB
Stars
129.7K
Updated
CommitOct 18Releaserust-v0.163.0Oct 15
Age
1y
Commits · 90 Days