feature: Add "!cmd" user shell execution #2471

abhishek-oai · 2025-08-19T21:49:42Z

protocol: add Op::RunUserShellCommand to model a user-initiated one-off command
core: handle new Op by spawning a cancellable task that runs the command using the user’s default shell; stream output via ExecCommand* events; send TaskStarted/TaskComplete; track as current_task so Interrupt works
tui: detect leading '!' in composer submission and dispatch Op::RunUserShellCommand instead of sending a user message
No changes to sandbox env var behavior; uses existing exec pipeline and event types.
Handles Ctrl-C to send SIGINT to the user command
Handles limiting output from a user command to not overflow the tui

Demo video

bang-command-demo-video-1080p.mp4

github-actions · 2025-08-19T21:49:51Z

All contributors have signed the CLA ✍️ ✅
_{Posted by the CLA Assistant Lite bot.}

chatgpt-codex-connector

Codex Review: Here are some suggestions.

Reply with @codex fix comments to fix any unresolved comments.

About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you open a pull request that is ready for review, or mark a draft as ready for review. You can also ask for a review by commenting "@codex review".

Codex can also answer questions or update the PR. Try commenting "@codex fix this CI failure" or "@codex address that feedback".

codex-rs/tui/src/chatwidget.rs

easong-openai · 2025-08-19T22:24:25Z

We need to make sure cancellation works, particularly ctr-c. Right now it doesn't actually cancel the command.

If possible, we should show the command we just ran + any output and delineate it as a user command instead of using the shortening UI we do for the model.

Otherwise nice work!

easong-openai · 2025-08-19T22:29:16Z

This also doesn't support windows, which isn't necessarily a blocker but we might need to look at.

abhishek-oai · 2025-08-19T23:02:49Z

We need to make sure cancellation works, particularly ctr-c. Right now it doesn't actually cancel the command.

If possible, we should show the command we just ran + any output and delineate it as a user command instead of using the shortening UI we do for the model.

Otherwise nice work!

Happy to send a patch with both! Wanted to get something out to get buy-in first. Thanks for the prompt feedback.

SebastianSzturo · 2025-08-20T03:00:41Z

This is great! Would be also fantastic to have a way to run background commands like with Claude Code and have the output continuously attached to any new messages.

Background commands: (Ctrl-b) to run any Bash command in the background so Claude can keep working (great for dev servers, tailing logs, etc.)

Here is also a good description of the feature: sst/opencode#1970

abhishek-oai · 2025-08-24T07:57:04Z

I have read the CLA Document and I hereby sign the CLA

abhishek-oai · 2025-08-24T09:00:52Z

We need to make sure cancellation works, particularly ctr-c. Right now it doesn't actually cancel the command.

If possible, we should show the command we just ran + any output and delineate it as a user command instead of using the shortening UI we do for the model.

Otherwise nice work!

Alright both those things should work.

Also, the Tui still remains like the "frontend" and forwards the request to the "core". This is in line with the existing archiecture.

github-actions · 2025-08-25T00:48:04Z

Summary

Adds local “!” command execution with session events, env isolation, and TUI/CLI display. Updates docs and config to describe usage and line-capping.

Notes

codex-rs/README.md: New “Run a local command with !” section and usage tips.
codex-rs/config.md: Documents [tui] local_shell_max_lines (example 150; default described as 100).
codex-rs/core: Implements local exec runtime, process-group SIGINT on Unix, env derivation via policy, and LocalCommandBegin/End events.
codex-rs/tui: Wires local command begin/end into chat history; updates fixture.
codex-rs/exec,mcp-server: Handles/ignores new local-command events appropriately.

Review
Overall looks solid: process-group signaling, env hygiene, and event plumbing are well-done. A few small inconsistencies to address:

README link: “See config.md#tui.local_shell_max_lines” should point to config.md#tui (no anchor for the key).
Apply the documented line cap: local_shell_max_lines (core/src/config_types.rs, config.md) isn’t used; tui/src/history_cell.rs::new_local_command_output currently prints all lines. Consider using existing output_lines(...) with a default of 100 (configurable via Config.tui.local_shell_max_lines) and showing the “… +N lines” summary.
Non-Unix interrupt: core/src/local_exec.rs sets a flag but doesn’t actually signal/terminate the process. If acceptable for now, note the limitation; otherwise consider a Windows-friendly cancellation approach.

Follow-up (outside this PR scope)

Optionally align the CLI’s MAX_OUTPUT_LINES_FOR_EXEC_TOOL_CALL with the TUI default or make it configurable for consistency.

View workflow run

tibo-openai · 2025-08-25T01:20:22Z

@codex review in depth

chatgpt-codex-connector

Codex Review: Here are some suggestions.

Reply with @codex fix comments to fix any unresolved comments.

About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you open a pull request for review, mark a draft as ready, or comment "@codex review". If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex fix this CI failure" or "@codex address that feedback".

codex-rs/tui/src/history_cell.rs

codex-rs/core/src/local_exec.rs

easong-openai · 2025-08-25T07:21:53Z

Seems worth addressing the codex review notes above ^

abhishek-oai · 2025-08-25T23:21:14Z

Seems worth addressing the codex review notes above ^

Fixed.

abhishek-oai · 2025-08-25T23:21:54Z

@codex review in depth

chatgpt-codex-connector

Codex Review: Here are some suggestions.

Reply with @codex fix comments to fix any unresolved comments.

About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you open a pull request for review, mark a draft as ready, or comment "@codex review". If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex fix this CI failure" or "@codex address that feedback".

codex-rs/core/src/local_exec.rs

abhishek-oai · 2025-08-26T03:15:16Z

Seems worth addressing the codex review notes above ^

All fixed!

takatoshi-maeda · 2025-09-10T11:41:13Z

Does this pull request have a planned release schedule?

When I was using a different coding agent, I was able to provide the necessary context with the ! command—for example, executing database queries or checking schemas. Supplying context through the ! command also helped the coding agent experiment autonomously.

With Codex, I’ve been following this workflow by copying and pasting from the shell, which requires some additional steps. For that reason, I’m very much looking forward to the release of this feature.

bolinfest · 2025-09-10T17:41:21Z

As discussed offline, I think this needs a new approach that uses more of the existing exec functionality.

abhishek-oai · 2025-09-14T00:28:07Z

@bolinfest Updated the implementation to align with our discussion offline

codex-rs/core/src/shell.rs

bolinfest

Can you please add a video to the PR body?

codex-rs/core/src/codex.rs

codex-rs/core/tests/suite/user_shell_cmd.rs

codex-rs/tui/src/history_cell.rs

codex-rs/core/src/shell.rs

abhishek-oai · 2025-09-17T05:45:27Z

Does this pull request have a planned release schedule?

When I was using a different coding agent, I was able to provide the necessary context with the ! command—for example, executing database queries or checking schemas. Supplying context through the ! command also helped the coding agent experiment autonomously.

With Codex, I’ve been following this workflow by copying and pasting from the shell, which requires some additional steps. For that reason, I’m very much looking forward to the release of this feature.

Actively working to land this.

takatoshi-maeda · 2025-09-17T05:51:26Z

Thank you, I really appreciate it. I’m looking forward to trying it out.

abhishek-oai

Addressed all comments

codex-rs/core/src/codex.rs

codex-rs/core/src/shell.rs

codex-rs/core/tests/suite/user_shell_cmd.rs

codex-rs/tui/src/history_cell.rs

codex-rs/core/src/codex.rs

abhishek-oai · 2025-09-18T08:29:41Z

Fix for CI failure (seems like a flake) - #3844

abhishek-oai · 2025-09-18T15:21:03Z

Can you please add a video to the PR body?

Also done

bolinfest

This is generally good, but there are some things I'd like you to look at!

bolinfest · 2025-09-22T22:24:30Z

codex-rs/protocol/src/protocol.rs

        assert_eq!(deserialized, event);
    }
+
+    #[test]


I think we can do without this test: it doesn't provide much in the way of additional code correctness.

bolinfest · 2025-09-22T22:26:01Z

codex-rs/protocol/src/protocol.rs

+    /// True when this exec was initiated directly by the user (e.g. bang command),
+    /// not by the agent/model. Defaults to false for backwards compatibility.
+    #[serde(default)]
+    pub user_initiated_shell_command: bool,


How about: is_user_shell_command to mirror the name of the Op?

bolinfest · 2025-09-22T22:26:22Z

codex-rs/tui/src/chatwidget.rs

 struct RunningCommand {
    command: Vec<String>,
    parsed_cmd: Vec<ParsedCommand>,
+    user_initiated_shell_command: bool,


Rename this as well?

bolinfest · 2025-09-22T22:28:01Z

codex-rs/tui/src/chatwidget.rs

+        // Special-case: "!cmd" executes a local shell command instead of sending to the model.
+        if let Some(stripped) = text.strip_prefix('!') {
+            let cmd = stripped.trim().to_string();
+            if !cmd.is_empty() {


So if the user types ! by itself, we'll send the message "!" to the agent, correct?

I guess this is fine, though we could take this opportunity to tell the user about the ! feature instead?

bolinfest · 2025-09-22T22:29:31Z

codex-rs/tui/src/history_cell.rs

-                    body_lines.extend(wrapped.into_iter().map(|l| Line::from(l.to_string().dim())));
+
+        if let Some(output) = call.output.as_ref() {
+            let is_shell_exec_cell = self.calls.iter().any(|c| c.user_initiated_shell_command);


Do we believe we could have a mix of exec calls in flight, only some of which are user initiated shell commands?

bolinfest · 2025-09-22T22:34:21Z

codex-rs/core/src/codex.rs

+    sub_id: String,
+    command: String,
+) {
+    let spawn_sub_id = sub_id.clone();


Do this inside let handle, as well?

bolinfest · 2025-09-22T22:35:50Z

codex-rs/core/tests/suite/user_shell_cmd.rs

+    unsafe {
+        std::env::set_var("CODEX_HERMETIC_TEST_SHELL", "1");
+    }


Please find another way to do this: this is unsafe for a reason.

bolinfest · 2025-09-22T22:37:16Z

codex-rs/core/tests/suite/user_shell_cmd.rs

+use std::path::PathBuf;
+use tempfile::TempDir;
+
+#[tokio::test(flavor = "multi_thread", worker_threads = 2)]


Please omit worker_threads unless you have a reason to believe you need them.

Empirically, tests that only pass with more than one worker thread imply bugs in our code, so I would prefer to try to catch them.

bolinfest · 2025-09-22T22:39:02Z

codex-rs/core/tests/suite/user_shell_cmd.rs

@@ -0,0 +1,119 @@
+#![cfg(unix)]


Given these tests are limited to unix for now (which I would prefer not to do), do we really need CODEX_HERMETIC_TEST_SHELL?

bolinfest · 2025-09-22T22:39:45Z

codex-rs/core/tests/suite/user_shell_cmd.rs

+    // 1) ls should list the file
+    codex
+        .submit(Op::RunUserShellCommand {
+            command: "ls".to_string(),


I often use python3 -c as an example for cross-platform shell calls.

rtl-ai · 2025-10-07T18:40:46Z

Any update on the merge timeline for this PR?

- protocol: add Op::RunUserShellCommand to model a user-initiated one-off command - core: handle new Op by spawning a cancellable task that runs the command using the user’s default shell; stream output via ExecCommand* events; send TaskStarted/TaskComplete; track as current_task so Interrupt works - tui: detect leading '!' in composer submission and dispatch Op::RunUserShellCommand instead of sending a user message No changes to sandbox env var behavior; uses existing exec pipeline and event types.

abhishek-oai requested a review from gpeal August 19, 2025 21:51

chatgpt-codex-connector bot reviewed Aug 19, 2025

View reviewed changes

codex-rs/tui/src/chatwidget.rs Show resolved Hide resolved

codex-rs/tui/src/chatwidget.rs Outdated Show resolved Hide resolved

gpeal requested review from bolinfest and easong-openai August 19, 2025 22:45

abhishek-oai force-pushed the bang-command-support branch from 7318b7e to 31a20a2 Compare August 24, 2025 07:48

abhishek-oai changed the title ~~TUI: ! commands passthrough to shell for execution~~ [tui][core] ! commands passthrough to shell for execution Aug 24, 2025

github-actions bot added a commit that referenced this pull request Aug 24, 2025

@abhishek-oai has signed the CLA in #2471

d5a8e79

easong-openai added the codex-review label Aug 25, 2025

github-actions bot added codex-review-in-progress and removed codex-review labels Aug 25, 2025

github-actions bot added codex-review-completed and removed codex-review-in-progress labels Aug 25, 2025

chatgpt-codex-connector bot reviewed Aug 25, 2025

View reviewed changes

codex-rs/tui/src/history_cell.rs Outdated Show resolved Hide resolved

codex-rs/core/src/local_exec.rs Outdated Show resolved Hide resolved

abhishek-oai force-pushed the bang-command-support branch from 18d2af7 to fec03bc Compare August 25, 2025 23:19

abhishek-oai enabled auto-merge (squash) August 25, 2025 23:19

chatgpt-codex-connector bot reviewed Aug 25, 2025

View reviewed changes

codex-rs/core/src/local_exec.rs Outdated Show resolved Hide resolved

abhishek-oai force-pushed the bang-command-support branch 2 times, most recently from 771ae55 to 8aaf9f0 Compare August 26, 2025 02:58

abhishek-oai force-pushed the bang-command-support branch from 8aaf9f0 to 1f4d16f Compare August 26, 2025 04:08

This was referenced Aug 29, 2025

Allow shell command pass through (eg. with ! prefix) #2866

Open

Custom prompts - passing arguments #2890

Closed

buihongduc132 mentioned this pull request Sep 7, 2025

feat: Subprocess/child process exec (shell passthrough, timeouts, kill grandchildren) buihongduc132/codex#3

Closed

bolinfest removed their request for review September 10, 2025 17:41

abhishek-oai force-pushed the bang-command-support branch from b72c0da to 9518387 Compare September 14, 2025 00:25

abhishek-oai changed the title ~~[tui][core] ! commands passthrough to shell for execution~~ feature: Add "!cmd" user shell execution Sep 14, 2025

abhishek-oai commented Sep 14, 2025

View reviewed changes

codex-rs/core/src/shell.rs Outdated Show resolved Hide resolved

bolinfest requested changes Sep 14, 2025

View reviewed changes

abhishek-oai force-pushed the bang-command-support branch from e973899 to dbd41cc Compare September 18, 2025 06:49

abhishek-oai commented Sep 18, 2025

View reviewed changes

abhishek-oai removed the codex-review-completed label Sep 18, 2025

abhishek-oai requested a review from bolinfest September 19, 2025 01:12

bolinfest requested changes Sep 22, 2025

View reviewed changes

abhishek-oai force-pushed the bang-command-support branch from 0bc6e90 to 2f0bc51 Compare September 25, 2025 01:29

abhishek-oai requested a review from bolinfest September 25, 2025 05:27

abhishek-oai added 2 commits October 17, 2025 00:48

output truncation

45dc4f1

abhishek-oai force-pushed the bang-command-support branch from 5578dbe to 45dc4f1 Compare October 17, 2025 08:19

Comment

f0ad4bf

feature: Add "!cmd" user shell execution #2471

Are you sure you want to change the base?

feature: Add "!cmd" user shell execution #2471

Uh oh!

Conversation

abhishek-oai commented Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

easong-openai commented Aug 19, 2025

Uh oh!

easong-openai commented Aug 19, 2025

Uh oh!

abhishek-oai commented Aug 19, 2025

Uh oh!

SebastianSzturo commented Aug 20, 2025

Uh oh!

abhishek-oai commented Aug 24, 2025

Uh oh!

abhishek-oai commented Aug 24, 2025

Uh oh!

github-actions bot commented Aug 25, 2025

Uh oh!

tibo-openai commented Aug 25, 2025

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

easong-openai commented Aug 25, 2025

Uh oh!

abhishek-oai commented Aug 25, 2025

Uh oh!

abhishek-oai commented Aug 25, 2025

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

abhishek-oai commented Aug 26, 2025

Uh oh!

takatoshi-maeda commented Sep 10, 2025

Uh oh!

bolinfest commented Sep 10, 2025

Uh oh!

abhishek-oai commented Sep 14, 2025

Uh oh!

Uh oh!

bolinfest left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

abhishek-oai commented Sep 17, 2025

Uh oh!

takatoshi-maeda commented Sep 17, 2025

Uh oh!

abhishek-oai left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

abhishek-oai commented Aug 19, 2025 •

edited

Loading

github-actions bot commented Aug 19, 2025 •

edited

Loading