core-agent-ide/codex-rs
unship f7cb2f87a0
Bug fix: clone of incoming_tx can lead to deadlock (#2747)
POC code

```rust
use tokio::sync::mpsc;
use std::time::Duration;

#[tokio::main]
async fn main() {
    println!("=== Test 1: Simulating original MCP server pattern ===");
    test_original_pattern().await;
}

async fn test_original_pattern() {
    println!("Testing the original pattern from MCP server...");
    
    // Create channel - this simulates the original incoming_tx/incoming_rx
    let (tx, mut rx) = mpsc::channel::<String>(10);
    
    // Task 1: Simulates stdin reader that will naturally terminate
    let stdin_task = tokio::spawn({
        let tx_clone = tx.clone();
        async move {
            println!("  stdin_task: Started, will send 3 messages then exit");
            for i in 0..3 {
                let msg = format!("Message {}", i);
                if tx_clone.send(msg.clone()).await.is_err() {
                    println!("  stdin_task: Receiver dropped, exiting");
                    break;
                }
                println!("  stdin_task: Sent {}", msg);
                tokio::time::sleep(Duration::from_millis(300)).await;
            }
            println!("  stdin_task: Finished (simulating EOF)");
            // tx_clone is dropped here
        }
    });
    
    // Task 2: Simulates message processor
    let processor_task = tokio::spawn(async move {
        println!("  processor_task: Started, waiting for messages");
        while let Some(msg) = rx.recv().await {
            println!("  processor_task: Processing {}", msg);
            tokio::time::sleep(Duration::from_millis(100)).await;
        }
        println!("  processor_task: Finished (channel closed)");
    });
    
    // Task 3: Simulates stdout writer or other background task
    let background_task = tokio::spawn(async move {
        for i in 0..2 {
            tokio::time::sleep(Duration::from_millis(500)).await;
            println!("  background_task: Tick {}", i);
        }
        println!("  background_task: Finished");
    });
    
    println!("  main: Original tx is still alive here");
    println!("  main: About to call tokio::join! - will this deadlock?");
    
    // This is the pattern from the original code
    let _ = tokio::join!(stdin_task, processor_task, background_task);
}

```

---------

Co-authored-by: Michael Bolin <bolinfest@gmail.com>
2025-08-28 19:28:17 -07:00
..
ansi-escape Auto format toml (#1745) 2025-07-30 18:37:00 -07:00
apply-patch feat: use the arg0 trick with apply_patch (#2646) 2025-08-24 14:35:51 -07:00
arg0 feat: use the arg0 trick with apply_patch (#2646) 2025-08-24 14:35:51 -07:00
chatgpt test: faster test execution in codex-core (#2633) 2025-08-24 11:10:53 -07:00
cli Add AuthManager and enhance GetAuthStatus command (#2577) 2025-08-22 13:10:11 -07:00
common feat: copy tweaks (#2502) 2025-08-20 07:26:14 +00:00
core Following up on #2371 post commit feedback (#2852) 2025-08-28 19:24:38 -07:00
docs feat: initial import of Rust implementation of Codex CLI in codex-rs/ (#629) 2025-04-24 13:31:40 -07:00
exec Following up on #2371 post commit feedback (#2852) 2025-08-28 19:24:38 -07:00
execpolicy test: faster test execution in codex-core (#2633) 2025-08-24 11:10:53 -07:00
file-search chore(deps): bump serde_json from 1.0.142 to 1.0.143 in /codex-rs (#2498) 2025-08-22 15:45:14 -07:00
linux-sandbox test: faster test execution in codex-core (#2633) 2025-08-24 11:10:53 -07:00
login Changed OAuth success screen to use the string "Codex" rather than "Codex CLI" (#2737) 2025-08-28 21:21:10 +00:00
mcp-client fix: use std::env::args_os instead of std::env::args (#1698) 2025-07-28 08:52:18 -07:00
mcp-server Bug fix: clone of incoming_tx can lead to deadlock (#2747) 2025-08-28 19:28:17 -07:00
mcp-types test: faster test execution in codex-core (#2633) 2025-08-24 11:10:53 -07:00
ollama chore: upgrade to Rust 1.89 (#2465) 2025-08-19 13:22:02 -07:00
protocol Following up on #2371 post commit feedback (#2852) 2025-08-28 19:24:38 -07:00
protocol-ts Index file (#2678) 2025-08-25 13:23:32 -04:00
scripts fix: add stricter checks and better error messages to create_github_release.sh (#1874) 2025-08-05 23:33:21 -07:00
tui Following up on #2371 post commit feedback (#2852) 2025-08-28 19:24:38 -07:00
.gitignore fix: support arm64 build for Linux (#1225) 2025-06-05 20:29:46 -07:00
Cargo.lock Copying / Dragging image files (MacOS Terminal + iTerm) (#2567) 2025-08-25 16:39:42 -07:00
Cargo.toml chore: require uninlined_format_args from clippy (#2845) 2025-08-28 11:25:23 -07:00
clippy.toml fix: clean up styles & colors and define in styles.md (#2401) 2025-08-18 08:26:29 -07:00
config.md Added back codex-rs/config.md to link to new location (#2778) 2025-08-27 18:37:41 +00:00
default.nix restructure flake for codex-rs (#888) 2025-05-13 13:08:42 -07:00
justfile tui: tab-completing a command moves the cursor to the end (#2362) 2025-08-20 09:57:55 -07:00
README.md README / docs refactor (#2724) 2025-08-27 10:30:39 -07:00
rust-toolchain.toml chore: upgrade to Rust 1.89 (#2465) 2025-08-19 13:22:02 -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, though we plan to publish Codex to other package managers soon.

npm i -g @openai/codex@native
codex

You can also download a platform-specific release directly from our GitHub Releases.

What's new in the Rust CLI

While we are working to close the gap between the TypeScript and Rust implementations of Codex CLI, note that the Rust CLI has a number of features that the TypeScript CLI does not!

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

Codex CLI functions as an MCP client that can connect to MCP servers on startup. See the mcp_servers section in the configuration documentation for details.

It is still experimental, but you can also launch Codex as an MCP server by running codex mcp. Use the @modelcontextprotocol/inspector to try it out:

npx @modelcontextprotocol/inspector codex mcp

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 programmatially/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 debug seatbelt [--full-auto] [COMMAND]...

# Linux
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.