https://github.com/openai/codex
Lightweight coding agent that runs in your terminal
https://github.com/openai/codex
Last synced: 3 days ago
JSON representation
Lightweight coding agent that runs in your terminal
- Host: GitHub
- URL: https://github.com/openai/codex
- Owner: openai
- License: apache-2.0
- Created: 2025-04-13T05:37:54.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2026-01-15T22:31:00.000Z (5 days ago)
- Last Synced: 2026-01-15T22:40:09.744Z (5 days ago)
- Language: Rust
- Homepage:
- Size: 83.1 MB
- Stars: 56,242
- Watchers: 362
- Forks: 7,247
- Open Issues: 866
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing.md
- License: LICENSE
- Notice: NOTICE
- Agents: AGENTS.md
- Cla: docs/CLA.md
Awesome Lists containing this project
- awesome-LLM-resources - CodeX
- awesome-AI-driven-development - OpenAI Codex CLI - Lightweight coding agent that runs in your terminal (Terminal & CLI Agents)
- awesome - openai/codex - Lightweight coding agent that runs in your terminal (Rust)
- awesome-ccamel - openai/codex - Lightweight coding agent that runs in your terminal (Rust)
- awesome - openai/codex - Lightweight coding agent that runs in your terminal (<a name="Rust"></a>Rust)
- student-gpt-tools - Codex - Codex-blue)](https://github.com/openai/codex) [](https://github.com/openai/codex) | Need OpenAI API key. | OpenAI Codex CLI, lightweight coding agent that runs in your terminal. | (Coding and Debugging / Data Analysis)
- awesome-ai-coding - Codex - hour | No | No | Yes | (CLI)
- FreeTools - Codex
- awesome-codex-cli - GitHub Repository - Official OpenAI Codex CLI repository (Official Resources / Documentation)
- awesome-repositories - openai/codex - Lightweight coding agent that runs in your terminal (Rust)
- awesome - openai/codex - Lightweight coding agent that runs in your terminal (Rust)
- awesome-copilots - OpenAI Codex CLI - Lightweight coding agent for the terminal (Coding Copilots / Terminal & Command Line Tools)
- awesome-vibe-coding - OpenAI Codex CLI - OpenAI的轻量级编程代理，在终端中运行 (命令行工具)
- definitive-opensource - Codex
- Awesome-LLMOps - Codex - commit/openai/codex?color=green)  (Runtime / AI Terminal)
- awesome-claude-code - **OpenAI Codex CLI**
- awesome-ai-tools - OpenAI Codex CLI - Experimental terminal assistant for code generation (AI Tools / 👨💻 Developer Tools)
- AiTreasureBox - openai/codex - 11-03_49568_1](https://img.shields.io/github/stars/openai/codex.svg)|Lightweight coding agent that runs in your terminal| (Repos)
- my-awesome-github-stars - openai/codex - Lightweight coding agent that runs in your terminal (Rust)
- Awesome-Vibe-Coding - OpenAI Codex
- awesome-rainmana - openai/codex - Lightweight coding agent that runs in your terminal (Rust)
- Dev-Notes - Codex
- awesome-agentic-coding-papers - [Project
- awesome-terminals-ai - OpenAI Codex CLI - OpenAI's official CLI agent for general-purpose AI tasks that runs in your terminal. (AI Coding Assistants & Agents / Provider-Native Coding CLIs)
- awesome-starred - openai/codex - Lightweight coding agent that runs in your terminal (Rust)
- awesome-vibe-coding - OpenAI Codex CLI
- awesome-tuis - codex
- awesome-ai-tools - Codex CLI
- awesome-cli-agents - openai/codex - Lightweight coding agent that runs in your terminal [Terminal] (56k⭐) (🚀 AI Tools for Vim, Neovim, and Terminal)
README
npm i -g @openai/codex
or brew install --cask codex
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 are looking for the cloud-based agent from OpenAI, Codex Web, go to chatgpt.com/codex.
---
## Quickstart
### Installing and running Codex CLI
Install globally with your preferred package manager:
```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, Team, Edu, or Enterprise plan. [Learn more about what's included in your ChatGPT plan](https://help.openai.com/en/articles/11369540-codex-in-chatgpt).
You can also use Codex with an API key, but this requires [additional setup](https://developers.openai.com/codex/auth#sign-in-with-an-api-key).
## Docs
- [**Codex Documentation**](https://developers.openai.com/codex)
- [**Contributing**](./docs/contributing.md)
- [**Installing & building**](./docs/install.md)
- [**Open source fund**](./docs/open-source-fund.md)
This repository is licensed under the [Apache-2.0 License](LICENSE).