@jonnyhoo/codex
v0.3.15
Published
<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://
Readme
Quickstart
Installing and running Codex CLI
Install globally with your preferred package manager:
# Install using npm
npm install -g @openai/codex# Install using Homebrew
brew install --cask codexThen simply run codex to get started.
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
- Apple Silicon/arm64:
- Linux
- x86_64:
codex-x86_64-unknown-linux-musl.tar.gz - arm64:
codex-aarch64-unknown-linux-musl.tar.gz
- x86_64:
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.
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.
You can also use Codex with an API key, but this requires additional setup.
Fork-specific notes
- Current fork release target is
0.3.14, rebased onto upstreamrust-v0.114.0. - This fork publishes the npm package as
@jonnyhoo/codex. - It adds explicit
lspsemantic tooling with provider-awaresemantic_unavailablefallback toread_file+grep_files, first-classedit/apply_patch/write_file/edit_filemutation tools backed by the unified edit engine, and TUI visibility for provider health and status. - It also tightens broad repo search defaults by preferring
grep_filesand skipping common generated or dependency directories unless explicitly requested. - Native Windows development is supported through
scripts/windows/just.cmd; see Installing & building for the MSVC-shell workflow. - Component-specific notes live in
codex-rs/core/README.mdandcodex-rs/tui/README.md.
Docs
This repository is licensed under the Apache-2.0 License.
