https://github.com/openai/codex
Lightweight coding agent that runs in your terminal
https://github.com/openai/codex
Last synced: 24 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 (6 months ago)
- Default Branch: main
- Last Pushed: 2025-05-12T21:10:54.000Z (5 months ago)
- Last Synced: 2025-05-12T21:20:25.751Z (5 months ago)
- Language: TypeScript
- Homepage:
- Size: 21.3 MB
- Stars: 22,063
- Watchers: 168
- Forks: 2,186
- Open Issues: 248
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-vibe-coding - OpenAI Codex CLI
- awesome - openai/codex - Lightweight coding agent that runs in your terminal (Rust)
- awesome - openai/codex - Lightweight coding agent that runs in your terminal (TypeScript)
- 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
- AiTreasureBox - openai/codex - 10-01_45488_98](https://img.shields.io/github/stars/openai/codex.svg)|Lightweight coding agent that runs in your terminal| (Repos)
- awesome-repositories - openai/codex - Lightweight coding agent that runs in your terminal (Rust)
- Awesome-Vibe-Coding - OpenAI Codex
- awesome-copilots - OpenAI Codex CLI - Lightweight coding agent for the terminal (Coding Copilots / Terminal & Command Line Tools)
- awesome-AI-driven-development - OpenAI Codex CLI - Lightweight coding agent that runs in your terminal (Terminal & CLI Agents)
- awesome-starred - openai/codex - Lightweight coding agent that runs in your terminal (Rust)
- awesome-rainmana - openai/codex - Lightweight coding agent that runs in your terminal (Rust)
- awesome-vibe-coding - OpenAI Codex CLI - OpenAI的轻量级编程代理，在终端中运行 (命令行工具)
- definitive-opensource - Codex
- awesome-ccamel - openai/codex - Lightweight coding agent that runs in your terminal (Rust)
- awesome - openai/codex - Lightweight coding agent that runs in your terminal (Rust)
- 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)
README
OpenAI Codex CLI
npm i -g @openai/codex
or brew install codex
Codex CLI is a coding agent from OpenAI that runs locally on your computer.If you are looking for the cloud-based agent from OpenAI, Codex Web, see chatgpt.com/codex.
---
## Quickstart
### Installing and running Codex CLI
Install globally with your preferred package manager. If you use npm:
```shell
npm install -g @openai/codex
```
Alternatively, if you use Homebrew:
```shell
brew install codex
```
Then simply run `codex` to get started:
```shell
codex
```
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](./docs/authentication.md#usage-based-billing-alternative-use-an-openai-api-key). If you previously used an API key for usage-based billing, see the [migration steps](./docs/authentication.md#migrating-from-usage-based-billing-api-key). If you're having trouble with login, please comment on [this issue](https://github.com/openai/codex/issues/1243).
### Model Context Protocol (MCP)
Codex CLI supports [MCP servers](./docs/advanced.md#model-context-protocol-mcp). Enable by adding an `mcp_servers` section to your `~/.codex/config.toml`.
### Configuration
Codex CLI supports a rich set of configuration options, with preferences stored in `~/.codex/config.toml`. For full configuration options, see [Configuration](./docs/config.md).
---
### Docs & FAQ
- [**Getting started**](./docs/getting-started.md)
- [CLI usage](./docs/getting-started.md#cli-usage)
- [Running with a prompt as input](./docs/getting-started.md#running-with-a-prompt-as-input)
- [Example prompts](./docs/getting-started.md#example-prompts)
- [Memory with AGENTS.md](./docs/getting-started.md#memory-with-agentsmd)
- [Configuration](./docs/config.md)
- [**Sandbox & approvals**](./docs/sandbox.md)
- [**Authentication**](./docs/authentication.md)
- [Auth methods](./docs/authentication.md#forcing-a-specific-auth-method-advanced)
- [Login on a "Headless" machine](./docs/authentication.md#connecting-on-a-headless-machine)
- [**Advanced**](./docs/advanced.md)
- [Non-interactive / CI mode](./docs/advanced.md#non-interactive--ci-mode)
- [Tracing / verbose logging](./docs/advanced.md#tracing--verbose-logging)
- [Model Context Protocol (MCP)](./docs/advanced.md#model-context-protocol-mcp)
- [**Zero data retention (ZDR)**](./docs/zdr.md)
- [**Contributing**](./docs/contributing.md)
- [**Install & build**](./docs/install.md)
- [System Requirements](./docs/install.md#system-requirements)
- [DotSlash](./docs/install.md#dotslash)
- [Build from source](./docs/install.md#build-from-source)
- [**FAQ**](./docs/faq.md)
- [**Open source fund**](./docs/open-source-fund.md)
---
## License
This repository is licensed under the [Apache-2.0 License](LICENSE).