clone/codex
1
0
Fork 0
mirror of https://github.com/openai/codex.git synced 2026-04-24 14:45:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: clarify codex npm install docs

Browse Source
This commit is contained in:
Edward Frazer
2026-03-02 17:43:56 -08:00
parent 8db0d9e878
commit ce63bf7391
2 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
codex-cli/README.md
View File

@@ -4,8 +4,8 @@
<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`.
> 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)
@@ -75,7 +75,7 @@ Help us improve by filing issues or submitting PRs (see the section below for ho
## Quickstart
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:
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
@@ -285,7 +285,7 @@ Below are a few bite-size examples you can copy-paste. Replace the text in quote
## Installation
<details open>
<summary><strong>Legacy TypeScript CLI via npm / yarn / bun / pnpm</strong></summary>
<summary><strong>From npm / yarn / bun / pnpm</strong></summary>
```bash
npm install -g @openai/codex

2
codex-rs/README.md
View File

@@ -27,7 +27,7 @@ If you prefer a package manager, you can also install via npm (`npm install -g @
## What's new in the Rust CLI
The Rust implementation is now the maintained Codex CLI and serves as the default experience. It includes a number of features that the legacy TypeScript CLI never supported.
The Rust implementation is the maintained Codex CLI and serves as the default experience.
### Config