Compare commits

...

6 Commits

Author SHA1 Message Date
Edward Frazer
ad4cf0e5ec fix: move package manager installs below native readme header 2026-03-03 18:35:29 -08:00
Edward Frazer
27359f0591 fix: label native install commands in top-level readme 2026-03-03 18:16:38 -08:00
Edward Frazer
da544513b8 fix: restore rust readme copy and format install docs 2026-03-02 17:56:15 -08:00
Edward Frazer
9783bb9067 fix: simplify codex installer platform labels 2026-03-02 17:51:45 -08:00
Edward Frazer
ce63bf7391 fix: clarify codex npm install docs 2026-03-02 17:43:56 -08:00
Edward Frazer
8db0d9e878 docs: make Codex install docs native-first 2026-03-02 14:35:45 -08:00
4 changed files with 50 additions and 21 deletions

View File

@@ -1,4 +1,4 @@
<p align="center"><code>npm i -g @openai/codex</code><br />or <code>brew install --cask codex</code></p>
<p align="center"><strong>Mac/Linux:</strong> <code>curl -fsSL https://chatgpt.com/codex/install.sh | sh</code><br /><strong>Windows:</strong> <code>powershell -c "irm https://chatgpt.com/codex/install.ps1|iex"</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="https://github.com/openai/codex/blob/main/.github/codex-cli-splash.png" alt="Codex CLI splash" width="80%" />
@@ -14,18 +14,21 @@ If you want Codex in your code editor (VS Code, Cursor, Windsurf), <a href="http
### Installing and running Codex CLI
Install globally with your preferred package manager:
Install with the native installer for your platform:
```shell
# Install using npm
npm install -g @openai/codex
# Mac + Linux
curl -fsSL https://chatgpt.com/codex/install.sh | sh
```
```shell
# Install using Homebrew
brew install --cask codex
```powershell
# Windows
powershell -c "irm https://chatgpt.com/codex/install.ps1|iex"
```
> [!NOTE]
> If you prefer a package manager, you can also install with `npm install -g @openai/codex` or `brew install --cask codex`.
Then simply run `codex` to get started.
<details>
@@ -39,6 +42,8 @@ Each GitHub Release contains many executables, but in practice, you likely want
- Linux
- x86_64: `codex-x86_64-unknown-linux-musl.tar.gz`
- arm64: `codex-aarch64-unknown-linux-musl.tar.gz`
- Windows
- Use `install.ps1` or download the appropriate Windows `.zip` asset from the release page.
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.

View File

@@ -1,10 +1,11 @@
<h1 align="center">OpenAI Codex CLI</h1>
<p align="center">Lightweight coding agent that runs in your terminal</p>
<p align="center"><code>npm i -g @openai/codex</code></p>
<p align="center"><code>curl -fsSL https://chatgpt.com/codex/install.sh | sh</code><br /><code>powershell -c "irm https://chatgpt.com/codex/install.ps1|iex"</code></p>
> [!IMPORTANT]
> This is the documentation for the _legacy_ TypeScript implementation of the Codex CLI. It has been superseded by the _Rust_ implementation. See the [README in the root of the Codex repository](https://github.com/openai/codex/blob/main/README.md) for details.
> This directory contains the npm package entrypoint for Codex. For the primary Codex CLI docs and native installers, see the [README in the root of the Codex repository](https://github.com/openai/codex/blob/main/README.md).
> If you want to install Codex from npm instead of the native installers, use `npm install -g @openai/codex`.
![Codex demo GIF using: codex "explain this codebase to me"](../.github/demo.gif)
@@ -74,7 +75,7 @@ Help us improve by filing issues or submitting PRs (see the section below for ho
## Quickstart
Install globally:
For the primary Codex CLI install docs, use the native installers above or the root README. If you want to install Codex from npm, install it globally with npm:
```shell
npm install -g @openai/codex
@@ -284,7 +285,7 @@ Below are a few bite-size examples you can copy-paste. Replace the text in quote
## Installation
<details open>
<summary><strong>From npm (Recommended)</strong></summary>
<summary><strong>From npm / yarn / bun / pnpm</strong></summary>
```bash
npm install -g @openai/codex

View File

@@ -4,14 +4,21 @@ We provide Codex CLI as a standalone, native executable to ensure a zero-depende
## Installing Codex
Today, the easiest way to install Codex is via `npm`:
The easiest way to install Codex is with the native installer for your platform:
```shell
npm i -g @openai/codex
codex
```bash
# Mac + Linux
curl -fsSL https://chatgpt.com/codex/install.sh | sh
```
You can also install via Homebrew (`brew install --cask codex`) or download a platform-specific release directly from our [GitHub Releases](https://github.com/openai/codex/releases).
```powershell
# Windows
powershell -c "irm https://chatgpt.com/codex/install.ps1|iex"
```
Then run `codex`.
If you prefer a package manager, you can also install via npm (`npm install -g @openai/codex`) or Homebrew (`brew install --cask codex`). You can also download a platform-specific release directly from our [GitHub Releases](https://github.com/openai/codex/releases).
## Documentation quickstart

View File

@@ -2,11 +2,27 @@
### System requirements
| Requirement | Details |
| --------------------------- | --------------------------------------------------------------- |
| Operating systems | macOS 12+, Ubuntu 20.04+/Debian 10+, or Windows 11 **via WSL2** |
| Git (optional, recommended) | 2.23+ for built-in PR helpers |
| RAM | 4-GB minimum (8-GB recommended) |
| Requirement | Details |
| --------------------------- | -------------------------------------------------- |
| Operating systems | macOS 12+, Ubuntu 20.04+/Debian 10+, or Windows 11 |
| Git (optional, recommended) | 2.23+ for built-in PR helpers |
| RAM | 4-GB minimum (8-GB recommended) |
## Install Codex
Use the native installer for your platform:
```bash
# Mac + Linux
curl -fsSL https://chatgpt.com/codex/install.sh | sh
```
```powershell
# Windows
powershell -c "irm https://chatgpt.com/codex/install.ps1|iex"
```
If you prefer a package manager, you can also install via npm (`npm install -g @openai/codex`) or Homebrew (`brew install --cask codex`).
### DotSlash