npm package: @jonnyhoo/codex
Description: <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="https
Latest version: 0.3.5

<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="https://github.com/openai/codex/blob/main/.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 want the desktop app experience, run <code>codex app</code> or visit <a href="https://chatgpt.com/codex?app-landing-page=true">the Codex App page</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](https://developers.openai.com/codex/auth#sign-in-with-an-api-key).

## Fork-specific notes

- Current fork release target is `0.3.0`, rebased onto upstream `rust-v0.114.0`.
- This fork publishes the npm package as `@jonnyhoo/codex`.
- It adds built-in LSP tooling, first-class `write_file` and `edit_file` tools, and TUI visibility for provider health and status.
- It also tightens broad repo search defaults by preferring `grep_files` and skipping common generated or dependency directories unless explicitly requested.
- Native Windows development is supported through `scripts/windows/just.cmd`; see [Installing & building](./docs/upstream/install.md) for the MSVC-shell workflow.
- Component-specific notes live in [`codex-rs/core/README.md`](./codex-rs/core/README.md) and [`codex-rs/tui/README.md`](./codex-rs/tui/README.md).

## Docs

- [**Codex Documentation**](https://developers.openai.com/codex)
- [**Contributing**](./docs/upstream/contributing.md)
- [**Installing & building**](./docs/upstream/install.md)
- [**Open source fund**](./docs/upstream/open-source-fund.md)

This repository is licensed under the [Apache-2.0 License](LICENSE).