core-agent-ide/codex-rs
Maxime Savard ce0b38c056
FIX: WSL Paste image does not work (#6793)
## Related issues:  
- https://github.com/openai/codex/issues/3939  
- https://github.com/openai/codex/issues/2292  
- https://github.com/openai/codex/issues/7528 (After correction
https://github.com/openai/codex/pull/3990)

**Area:** `codex-cli` (image handling / clipboard & file uploads)  
**Platforms affected:** WSL (Ubuntu on Windows 10/11). No behavior
change on native Linux/macOS/Windows.

## Summary

This PR fixes image pasting and file uploads when running `codex-cli`
inside WSL. Previously, image operations failed silently or with
permission errors because paths weren't properly mapped between Windows
and WSL filesystems.

## Visual Result

<img width="1118" height="798" alt="image"
src="https://github.com/user-attachments/assets/14e10bc4-6b71-4d1f-b2a6-52c0a67dd069"
/>

## Last Rust-Cli

<img width="1175" height="859" alt="image"
src="https://github.com/user-attachments/assets/7ef41e29-9118-42c9-903c-7116d21e1751"
/>

## Root cause

The CLI assumed native Linux/Windows environments and didn't handle the
WSL↔Windows boundary:

- Used Linux paths for files that lived on the Windows host
- Missing path normalization between Windows (`C:\...`) and WSL
(`/mnt/c/...`)
- Clipboard access failed under WSL

### Why `Ctrl+V` doesn't work in WSL terminals

Most WSL terminal emulators (Windows Terminal, ConEmu, etc.) intercept
`Ctrl+V` at the terminal level to paste text from the Windows clipboard.
This keypress never reaches the CLI application itself, so our clipboard
image handler never gets triggered. Users need `Ctrl+Alt+V`.

## Changes

### WSL detection & path mapping

- Detects WSL by checking `/proc/sys/kernel/osrelease` and the
`WSL_INTEROP` env var
- Maps Windows drive paths to WSL mount paths (`C:\...` → `/mnt/c/...`)

### Clipboard fallback for WSL

- When clipboard access fails under WSL, falls back to PowerShell to
extract images from the Windows clipboard
- Saves to a temp file and maps the path back to WSL

### UI improvements

- Shows `Ctrl+Alt+V` hint on WSL (many terminals intercept plain
`Ctrl+V`)
- Better error messages for unreadable images

## Performance

- Negligible overhead. The fallback adds a single FS copy to a temp file
only when needed.
- Direct streaming remains the default.

## Files changed

- `protocol/src/lib.rs` – Added platform detection module  
- `protocol/src/models.rs` – Added WSL path mapping for local images  
- `protocol/src/platform.rs` – New module with WSL detection utilities  
- `tui/src/bottom_pane/chat_composer.rs` – Added base64 data URL support
and WSL path mapping
- `tui/src/bottom_pane/footer.rs` – WSL-aware keyboard shortcuts  
- `tui/src/clipboard_paste.rs` – PowerShell clipboard fallback

## How to reproduce the original bug (pre-fix)

1. Run `codex-cli` inside WSL2 on Windows.  
2. Paste an image from the Windows clipboard or drag an image from
`C:\...` into the terminal.
3. Observe that the image is not attached (silent failure) or an error
is logged; no artifact reaches the tool.

## How to verify the fix

1. Build this branch and run `codex-cli` inside WSL2.  
2. Paste from clipboard and drag from both Windows and WSL paths.  
3. Confirm that the image appears in the tool and the CLI shows a single
concise info line (no warning unless fallback was used).

I’m happy to adjust paths, naming, or split helpers into a separate
module if you prefer.

## How to try this branch

If you want to try this before it’s merged, you can use my Git branch:

Repository: https://github.com/Waxime64/codex.git  
Branch: `wsl-image-2`

1. Start WSL on your Windows machine.
2. Clone the repository and switch to the branch:
   ```bash
   git clone https://github.com/Waxime64/codex.git
   cd codex
   git checkout wsl-image-2
   # then go into the Rust workspace root, e.g.:
   cd codex-rs
3. Build the TUI binary:
  cargo build -p codex-tui --bin codex-tui --release
4. Install the binary:
   sudo install -m 0755 target/release/codex-tui /usr/local/bin/codex
5. From the project directory where you want to use Codex, start it
with:
   cd /path/to/your/project
   /usr/local/bin/codex

On WSL, use CTRL+ALT+V to paste an image from the Windows clipboard into
the chat.
2025-12-04 10:50:20 -08:00
..
.cargo chore(ci): add cargo audit workflow and policy (#7108) 2025-11-24 12:20:55 -08:00
.config fix flaky test: approval_matrix_covers_all_modes (#7028) 2025-11-20 14:37:42 -08:00
.github/workflows chore(ci): add cargo audit workflow and policy (#7108) 2025-11-24 12:20:55 -08:00
ansi-escape chore: add cargo-deny configuration (#7119) 2025-11-24 12:22:18 -08:00
app-server Refactor execpolicy fallback evaluation (#7544) 2025-12-03 23:39:48 -08:00
app-server-protocol [app-server] make file_path for config optional (#7560) 2025-12-04 03:08:18 +00:00
app-server-test-client fix: remove serde(flatten) annotation for TurnError (#7499) 2025-12-02 21:39:10 +00:00
apply-patch chore: add cargo-deny configuration (#7119) 2025-11-24 12:22:18 -08:00
arg0 chore: add cargo-deny configuration (#7119) 2025-11-24 12:22:18 -08:00
async-utils chore: add cargo-deny configuration (#7119) 2025-11-24 12:22:18 -08:00
backend-client chore: add cargo-deny configuration (#7119) 2025-11-24 12:22:18 -08:00
chatgpt chore: add cargo-deny configuration (#7119) 2025-11-24 12:22:18 -08:00
cli Refactor execpolicy fallback evaluation (#7544) 2025-12-03 23:39:48 -08:00
cloud-tasks chore: add cargo-deny configuration (#7119) 2025-11-24 12:22:18 -08:00
cloud-tasks-client chore: add cargo-deny configuration (#7119) 2025-11-24 12:22:18 -08:00
codex-api Migrate model preset (#7542) 2025-12-03 20:30:43 +00:00
codex-backend-openapi-models chore: add cargo-deny configuration (#7119) 2025-11-24 12:22:18 -08:00
codex-client Add request logging back (#7471) 2025-12-02 07:57:55 -08:00
common Migrate model preset (#7542) 2025-12-03 20:30:43 +00:00
core chore(core): test apply_patch_cli on Windows (#7554) 2025-12-04 10:39:45 -08:00
docs Revert "[core] add optional status_code to error events (#6865)" (#6955) 2025-11-20 01:26:14 +00:00
exec Introduce ModelsManager and migrate app-server to use it. (#7552) 2025-12-03 17:17:56 -08:00
exec-server feat: support --version flag for @openai/codex-shell-tool-mcp (#7504) 2025-12-02 23:43:25 +00:00
execpolicy Refactor execpolicy fallback evaluation (#7544) 2025-12-03 23:39:48 -08:00
execpolicy-legacy chore: add cargo-deny configuration (#7119) 2025-11-24 12:22:18 -08:00
feedback chore: add cargo-deny configuration (#7119) 2025-11-24 12:22:18 -08:00
file-search chore: add cargo-deny configuration (#7119) 2025-11-24 12:22:18 -08:00
keyring-store chore: add cargo-deny configuration (#7119) 2025-11-24 12:22:18 -08:00
linux-sandbox chore: add cargo-deny configuration (#7119) 2025-11-24 12:22:18 -08:00
lmstudio chore(deps): bump tracing from 0.1.41 to 0.1.43 in /codex-rs (#7428) 2025-11-30 20:36:03 -08:00
login Update device code auth strings. (#7498) 2025-12-02 17:36:38 -08:00
mcp-server Refactor execpolicy fallback evaluation (#7544) 2025-12-03 23:39:48 -08:00
mcp-types fix: prevent MCP startup failure on missing 'type' field (#7417) 2025-12-01 13:58:20 -05:00
ollama chore: add cargo-deny configuration (#7119) 2025-11-24 12:22:18 -08:00
otel whitelist command prefix integration in core and tui (#7033) 2025-12-03 23:17:02 -08:00
process-hardening chore: add cargo-deny configuration (#7119) 2025-11-24 12:22:18 -08:00
protocol Refactor execpolicy fallback evaluation (#7544) 2025-12-03 23:39:48 -08:00
responses-api-proxy chore: add cargo-deny configuration (#7119) 2025-11-24 12:22:18 -08:00
rmcp-client chore: add cargo-deny configuration (#7119) 2025-11-24 12:22:18 -08:00
scripts fix(scripts) next_minor_version should reset patch number (#7050) 2025-11-21 10:17:12 -08:00
stdio-to-uds chore: add cargo-deny configuration (#7119) 2025-11-24 12:22:18 -08:00
tui FIX: WSL Paste image does not work (#6793) 2025-12-04 10:50:20 -08:00
utils feat: add pycache to excluded directories (#7545) 2025-12-03 20:06:55 +00:00
windows-sandbox-rs Windows Sandbox: treat <workspace_root>/.git as read-only in workspace-write mode (#7142) 2025-11-24 12:41:21 -08:00
.gitignore [MCP] Prefix MCP tools names with mcp__ (#5309) 2025-10-19 20:41:55 -04:00
Cargo.lock Migrate model preset (#7542) 2025-12-03 20:30:43 +00:00
Cargo.toml feat: experimental support for skills.md (#7412) 2025-12-01 20:22:35 -08:00
clippy.toml fix: switch rate limit reset handling to timestamps (#5304) 2025-10-17 17:39:37 -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 missing rmcp output hash (#7436) 2025-12-01 10:45:31 -08:00
deny.toml chore: add cargo-deny configuration (#7119) 2025-11-24 12:22:18 -08:00
justfile feat: add app-server-test-client crate for internal use (#5391) 2025-11-14 12:39:58 -08:00
README.md add codex debug seatbelt --log-denials (#4098) 2025-11-10 22:48:14 +00: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 --cask codex) or download a platform-specific release directly from our GitHub Releases.

Documentation quickstart

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.

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] [--log-denials] [COMMAND]...

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

# Windows
codex sandbox windows [--full-auto] [COMMAND]...

# Legacy aliases
codex debug seatbelt [--full-auto] [--log-denials] [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.