core-agent-ide/codex-rs
2025-10-17 14:58:27 -07:00
..
ansi-escape Fix transcript mode rendering issue when showing tab chars (#4911) 2025-10-08 11:42:09 -07:00
app-server feat: add Vec<ParsedCommand> to ExecApprovalRequestEvent (#5222) 2025-10-15 13:58:40 -07:00
app-server-protocol feat: add Vec<ParsedCommand> to ExecApprovalRequestEvent (#5222) 2025-10-15 13:58:40 -07:00
apply-patch Use assert_matches (#4756) 2025-10-05 21:12:31 +00:00
arg0 chore: clippy on redundant closure (#4058) 2025-09-22 19:30:16 +00:00
async-utils Support graceful agent interruption (#5287) 2025-10-17 18:52:57 +00:00
backend-client Add cloud tasks (#3197) 2025-09-30 10:10:33 +00:00
chatgpt add(core): managed config (#3868) 2025-10-03 13:02:26 -07:00
cli [MCP] Allow specifying cwd and additional env vars (#5246) 2025-10-17 00:24:43 -04:00
cloud-tasks cloud: codex cloud exec (#5060) 2025-10-14 10:49:17 -07:00
cloud-tasks-client Add cloud tasks (#3197) 2025-09-30 10:10:33 +00:00
codex-backend-openapi-models Add cloud tasks (#3197) 2025-09-30 10:10:33 +00:00
common [MCP] Allow specifying cwd and additional env vars (#5246) 2025-10-17 00:24:43 -04:00
core [MCP] Render full MCP errors to the model (#5298) 2025-10-17 17:47:50 -04:00
docs [MCP] Improve docs (#4811) 2025-10-06 11:43:50 -04:00
exec feat: add auto-approval for codex exec (#5043) 2025-10-15 19:03:54 +01:00
execpolicy Use anyhow::Result in tests for error propagation (#4105) 2025-09-23 13:31:36 -07:00
feedback Add log upload support (#5257) 2025-10-16 21:03:23 -07:00
file-search [mcp-server] Expose fuzzy file search in MCP (#2677) 2025-09-29 12:19:09 -07:00
git-apply Add cloud tasks (#3197) 2025-09-30 10:10:33 +00:00
git-tooling Use assert_matches (#4756) 2025-10-05 21:12:31 +00:00
linux-sandbox chore: clippy on redundant closure (#4058) 2025-09-22 19:30:16 +00:00
login login: device code text (#4616) 2025-10-03 16:35:40 -07:00
mcp-client [MCP] Allow specifying cwd and additional env vars (#5246) 2025-10-17 00:24:43 -04:00
mcp-server feat: add Vec<ParsedCommand> to ExecApprovalRequestEvent (#5222) 2025-10-15 13:58:40 -07:00
mcp-types chore: unify cargo versions (#4044) 2025-09-22 16:47:01 +00:00
ollama Use assert_matches (#4756) 2025-10-05 21:12:31 +00:00
otel [codex][otel] propagate user email in otel events (#5223) 2025-10-15 17:53:33 -07:00
process-hardening feat: introduce npm module for codex-responses-api-proxy (#4417) 2025-09-28 19:34:06 -07:00
protocol feat: add path field to ParsedCommand::Read variant (#5275) 2025-10-17 06:19:54 +00:00
protocol-ts fix: remove mcp-types from app server protocol (#4537) 2025-10-01 02:16:26 +00:00
responses-api-proxy fix: use low-level stdin read logic to avoid a BufReader (#4778) 2025-10-05 13:58:30 -07:00
rmcp-client [MCP] Add support for resources (#5239) 2025-10-17 01:05:15 -04:00
scripts feat: add --emergency-version-override option to create_github_release script (#4556) 2025-10-01 11:40:04 -07:00
tui [MCP] Render full MCP errors to the model (#5298) 2025-10-17 17:47:50 -04:00
utils Use assert_matches (#4756) 2025-10-05 21:12:31 +00:00
.gitignore fix: support arm64 build for Linux (#1225) 2025-06-05 20:29:46 -07:00
Cargo.lock Support graceful agent interruption (#5287) 2025-10-17 18:52:57 +00:00
Cargo.toml Support graceful agent interruption (#5287) 2025-10-17 18:52:57 +00:00
clippy.toml fix: clean up styles & colors and define in styles.md (#2401) 2025-08-18 08:26:29 -07:00
code Send text parameter for non-gpt-5 models (#4195) 2025-09-24 22:00:06 +00:00
config.md Fix link to MCP Servers config section (#5301) 2025-10-17 14:58:27 -07:00
default.nix Fix nix build (#4048) 2025-10-17 12:19:08 -07:00
justfile [MCP] Add experimental support for streamable HTTP MCP servers (#4317) 2025-09-26 21:24:01 -04:00
README.md [MCP] Improve docs (#4811) 2025-10-06 11:43:50 -04:00
rust-toolchain.toml chore: upgrade to Rust 1.90 (#4124) 2025-09-24 08:32:00 -07:00
rustfmt.toml Update cargo to 2024 edition (#842) 2025-05-07 08:37:48 -07:00

Codex CLI (Rust Implementation)

We provide Codex CLI as a standalone, native executable to ensure a zero-dependency install.

Installing Codex

Today, the easiest way to install Codex is via npm:

npm i -g @openai/codex
codex

You can also install via Homebrew (brew install codex) or download a platform-specific release directly from our GitHub Releases.

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.

Config

Codex supports a rich set of configuration options. Note that the Rust CLI uses config.toml instead of config.json. See docs/config.md for details.

Model Context Protocol Support

MCP client

Codex CLI functions as an MCP client that allows the Codex CLI and IDE extension to connect to MCP servers on startup. See the configuration documentation for details.

MCP server (experimental)

Codex can be launched as an MCP server by running codex mcp-server. This allows other MCP clients to use Codex as a tool for another agent.

Use the @modelcontextprotocol/inspector to try it out:

npx @modelcontextprotocol/inspector codex mcp-server

Use codex mcp to add/list/get/remove MCP server launchers defined in config.toml, and codex mcp-server to run the MCP server directly.

Notifications

You can enable notifications by configuring a script that is run whenever the agent finishes a turn. The notify documentation includes a detailed example that explains how to get desktop notifications via terminal-notifier on macOS.

codex exec to run Codex programmatically/non-interactively

To run Codex non-interactively, run codex exec PROMPT (you can also pass the prompt via stdin) and Codex will work on your task until it decides that it is done and exits. Output is printed to the terminal directly. You can set the RUST_LOG environment variable to see more about what's going on.

Typing @ triggers a fuzzy-filename search over the workspace root. Use up/down to select among the results and Tab or Enter to replace the @ with the selected path. You can use Esc to cancel the search.

EscEsc to edit a previous message

When the chat composer is empty, press Esc to prime “backtrack” mode. Press Esc again to open a transcript preview highlighting the last user message; press Esc repeatedly to step to older user messages. Press Enter to confirm and Codex will fork the conversation from that point, trim the visible transcript accordingly, and prefill the composer with the selected user message so you can edit and resubmit it.

In the transcript preview, the footer shows an Esc edit prev hint while editing is active.

--cd/-C flag

Sometimes it is not convenient to cd to the directory you want Codex to use as the "working root" before running Codex. Fortunately, codex supports a --cd option so you can specify whatever folder you want. You can confirm that Codex is honoring --cd by double-checking the workdir it reports in the TUI at the start of a new session.

Shell completions

Generate shell completion scripts via:

codex completion bash
codex completion zsh
codex completion fish

Experimenting with the Codex Sandbox

To test to see what happens when a command is run under the sandbox provided by Codex, we provide the following subcommands in Codex CLI:

# macOS
codex sandbox macos [--full-auto] [COMMAND]...

# Linux
codex sandbox linux [--full-auto] [COMMAND]...

# Legacy aliases
codex debug seatbelt [--full-auto] [COMMAND]...
codex debug landlock [--full-auto] [COMMAND]...

Selecting a sandbox policy via --sandbox

The Rust CLI exposes a dedicated --sandbox (-s) flag that lets you pick the sandbox policy without having to reach for the generic -c/--config option:

# Run Codex with the default, read-only sandbox
codex --sandbox read-only

# Allow the agent to write within the current workspace while still blocking network access
codex --sandbox workspace-write

# Danger! Disable sandboxing entirely (only do this if you are already running in a container or other isolated env)
codex --sandbox danger-full-access

The same setting can be persisted in ~/.codex/config.toml via the top-level sandbox_mode = "MODE" key, e.g. sandbox_mode = "workspace-write".

Code Organization

This folder is the root of a Cargo workspace. It contains quite a bit of experimental code, but here are the key crates:

  • core/ contains the business logic for Codex. Ultimately, we hope this to be a library crate that is generally useful for building other Rust/native applications that use Codex.
  • exec/ "headless" CLI for use in automation.
  • tui/ CLI that launches a fullscreen TUI built with Ratatui.
  • cli/ CLI multitool that provides the aforementioned CLIs via subcommands.