clone/codex
1
0
Fork 0
mirror of https://github.com/openai/codex.git synced 2026-05-05 11:57:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: make Codex install docs native-first

Browse Source
This commit is contained in:
Edward Frazer
2026-03-02 14:35:45 -08:00
parent f90e97e414
commit 8db0d9e878
4 changed files with 49 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
codex-cli/README.md
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.
> Use the native installers above for the maintained Codex CLI. If you specifically need the legacy TypeScript CLI described in this document, install it with `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 maintained Codex CLI, use the native installers above or the root README. If you specifically need the legacy TypeScript CLI, 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>Legacy TypeScript CLI via npm / yarn / bun / pnpm</strong></summary>
```bash
npm install -g @openai/codex