mirror of
https://github.com/openai/codex.git
synced 2026-08-23 13:09:46 +00:00
ab753387cc
This eliminates redundant user documentation and allows us to focus our documentation investments. I left tombstone files for most of the existing ".md" docs files to avoid broken links. These now contain brief links to the developers docs site.
60 lines
2.6 KiB
Markdown
60 lines
2.6 KiB
Markdown
<p align="center"><code>npm i -g @openai/codex</code><br />or <code>brew install --cask codex</code></p>
|
|
<p align="center"><strong>Codex CLI</strong> is a coding agent from OpenAI that runs locally on your computer.
|
|
<p align="center">
|
|
<img src="./.github/codex-cli-splash.png" alt="Codex CLI splash" width="80%" />
|
|
</p>
|
|
</br>
|
|
If you want Codex in your code editor (VS Code, Cursor, Windsurf), <a href="https://developers.openai.com/codex/ide">install in your IDE.</a>
|
|
</br>If you are looking for the <em>cloud-based agent</em> from OpenAI, <strong>Codex Web</strong>, go to <a href="https://chatgpt.com/codex">chatgpt.com/codex</a>.</p>
|
|
|
|
---
|
|
|
|
## 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.
|
|
|
|
<details>
|
|
<summary>You can also go to the <a href="https://github.com/openai/codex/releases/latest">latest GitHub Release</a> and download the appropriate binary for your platform.</summary>
|
|
|
|
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.
|
|
|
|
</details>
|
|
|
|
### 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).
|
|
|
|
## 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).
|