core-agent-ide/codex-rs
pchuri 44dce748b6
feat: add Android/Termux support by gating arboard dependency (#2895)
## Summary

This PR enables Codex to build and run on Android/Termux environments by
conditionally gating the arboard clipboard dependency for Android
targets.

## Key Changes

- **Android Compatibility**: Gate arboard dependency for Android targets
where clipboard access may be restricted
- **Build Fixes**: Add missing tempfile::Builder import for image
clipboard operations
- **Code Cleanup**: Remove unnecessary parentheses to resolve formatting
warnings

## Technical Details

### Clipboard Dependency Gating
- Uses conditional compilation to exclude arboard on Android targets
- Maintains full clipboard functionality on other platforms
- Prevents build failures on Android/Termux where system clipboard
access is limited

### Import Fixes
- Adds missing tempfile::Builder import that was causing compilation
errors
- Ensures image clipboard operations work correctly when clipboard is
available

## Platform Support

-  **Linux/macOS/Windows**: Full clipboard functionality maintained
-  **Android/Termux**: Builds successfully without clipboard dependency
-  **Other Unix platforms**: Unchanged behavior

## Testing

-  Builds successfully on Android/Termux
-  Maintains clipboard functionality on supported platforms  
-  No regression in existing functionality

This addresses the Android/Termux compatibility issues while keeping
clipboard functionality intact for platforms that support it.
2025-09-02 23:36:40 -07:00
..
ansi-escape prefer ratatui Stylized for constructing lines/spans (#3068) 2025-09-02 23:19:54 +00:00
apply-patch parse cd foo && ... for exec and apply_patch (#3083) 2025-09-03 05:26:06 +00:00
arg0 feat: use the arg0 trick with apply_patch (#2646) 2025-08-24 14:35:51 -07:00
chatgpt Move CodexAuth and AuthManager to the core crate (#3074) 2025-09-02 18:36:19 -07:00
cli Move CodexAuth and AuthManager to the core crate (#3074) 2025-09-02 18:36:19 -07:00
common feat: copy tweaks (#2502) 2025-08-20 07:26:14 +00:00
core parse cd foo && ... for exec and apply_patch (#3083) 2025-09-03 05:26:06 +00:00
docs feat: initial import of Rust implementation of Codex CLI in codex-rs/ (#629) 2025-04-24 13:31:40 -07:00
exec Move CodexAuth and AuthManager to the core crate (#3074) 2025-09-02 18:36:19 -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 Move CodexAuth and AuthManager to the core crate (#3074) 2025-09-02 18:36:19 -07:00
mcp-client fix: drop Mutexes earlier in MCP server (#2878) 2025-08-28 22:50:16 -07:00
mcp-server Move CodexAuth and AuthManager to the core crate (#3074) 2025-09-02 18:36:19 -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 rework message styling (#2877) 2025-09-02 17:29:58 +00: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 feat: add Android/Termux support by gating arboard dependency (#2895) 2025-09-02 23:36:40 -07:00
.gitignore fix: support arm64 build for Linux (#1225) 2025-06-05 20:29:46 -07:00
Cargo.lock parse cd foo && ... for exec and apply_patch (#3083) 2025-09-03 05:26:06 +00: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.