core/core-agent-ide
8
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Agent IDE — Codex fork for AI-native development environment
1132 commits 2 branches 0 tags 80 MiB
Find a file
Kazuhiro Sera 97338de578
Remove a broken link to prompting_guide.md in docs/getting-started.md (#2858) 
The file no longer exists. We've been receiving this feedback several
times.
- https://github.com/openai/codex/issues/2374
- https://github.com/openai/codex/issues/2810
- https://github.com/openai/codex/issues/2826

My previous PR https://github.com/openai/codex/pull/2413 for this issue
restored the file but now it's compatible with the current file
structure. Thus, let's simply delete the link.
2025-09-10 10:52:50 -07:00
.devcontainer chore: install an extension for TOML syntax highlighting in the devcontainer (#1650) 2025-07-22 10:58:09 -07:00
.github No fail fast (#3387) 2025-09-09 13:17:14 -07:00
.vscode chore: add rust-lang.rust-analyzer and vadimcn.vscode-lldb to the list of recommended extensions (#3172) 2025-09-04 10:47:46 -07:00
codex-cli fix: include arm64 Windows executable in npm module (#3067) 2025-09-02 15:43:42 -07:00
codex-rs docs: fix codex exec heading typo (#2703) 2025-09-10 10:39:53 -07:00
docs Remove a broken link to prompting_guide.md in docs/getting-started.md (#2858) 2025-09-10 10:52:50 -07:00
scripts README / docs refactor (#2724) 2025-08-27 10:30:39 -07:00
.codespellignore feat: make it possible to toggle mouse mode in the Rust TUI (#971) 2025-05-16 16:16:50 -07:00
.codespellrc Re-add markdown streaming (#2029) 2025-08-12 17:37:28 -07:00
.gitignore restructure flake for codex-rs (#888) 2025-05-13 13:08:42 -07:00
.npmrc chore: migrate to pnpm for improved monorepo management (#287) 2025-04-18 16:25:15 -07:00
.prettierignore [apply-patch] Clean up apply-patch tool definitions (#2539) 2025-08-21 20:07:41 -07:00
.prettierrc.toml Initial commit 2025-04-16 12:56:08 -04:00
AGENTS.md syntax-highlight bash lines (#3142) 2025-09-05 14:10:32 +00:00
CHANGELOG.md Point the CHANGELOG to the releases page (#2780) 2025-08-27 11:45:40 -07:00
cliff.toml bump(version): 0.1.2504251709 (#660) 2025-04-25 17:15:40 -07:00
flake.lock restructure flake for codex-rs (#888) 2025-05-13 13:08:42 -07:00
flake.nix restructure flake for codex-rs (#888) 2025-05-13 13:08:42 -07:00
LICENSE Initial commit 2025-04-16 12:56:08 -04:00
NOTICE resizable viewport (#1732) 2025-07-31 00:06:55 +00:00
package.json [codex-cli] Add ripgrep as a dependency for node environment (#2237) 2025-08-13 13:49:27 -07:00
pnpm-lock.yaml chore: remove the TypeScript code from the repository (#2048) 2025-08-08 16:09:39 -07:00
pnpm-workspace.yaml chore: remove the TypeScript code from the repository (#2048) 2025-08-08 16:09:39 -07:00
PNPM.md fix: include pnpm lock file (#377) 2025-04-18 17:01:11 -07:00
README.md docs: fix broken link to the "Memory with AGENTS.md" section in codex/README.md (#3300) 2025-09-08 14:15:12 +00:00

README.md

OpenAI Codex CLI

npm i -g @openai/codex
or brew install codex

Codex CLI is a coding agent from OpenAI that runs locally on your computer.
If you are looking for the cloud-based agent from OpenAI, Codex Web, see chatgpt.com/codex.

Codex CLI splash

Quickstart

Installing and running Codex CLI

Install globally with your preferred package manager. If you use npm:

npm install -g @openai/codex

Alternatively, if you use Homebrew:

brew install codex

Then simply run codex to get started:

codex
You can also go to the latest GitHub Release and download the appropriate binary for your platform.

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.

Using Codex with your ChatGPT plan

Codex CLI login

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. If you previously used an API key for usage-based billing, see the migration steps. If you're having trouble with login, please comment on this issue.

Model Context Protocol (MCP)

Codex CLI supports MCP servers. Enable by adding an mcp_servers section to your ~/.codex/config.toml.

Configuration

Codex CLI supports a rich set of configuration options, with preferences stored in ~/.codex/config.toml. For full configuration options, see Configuration.

Docs & FAQ

License

This repository is licensed under the Apache-2.0 License.