Enum BashCommandAction 

pub enum BashCommandAction {
    Command {
        command: String,
        is_background: bool,
        allow_multi: bool,
    },
    StatusCheck {
        status_check: bool,
        bg_command_id: Option<String>,
        scrollback_lines: Option<usize>,
        verbose: bool,
    },
    SendText {
        send_text: String,
        bg_command_id: Option<String>,
        submit: bool,
    },
    SendSpecials {
        send_specials: Vec<SpecialKey>,
        bg_command_id: Option<String>,
        submit: bool,
    },
    SendAscii {
        send_ascii: Vec<u8>,
        bg_command_id: Option<String>,
        submit: bool,
    },
    Screen {
        screen: bool,
        bg_command_id: Option<String>,
        lines: Option<usize>,
        diff: bool,
    },
    WaitForTurn {
        wait_for_turn: bool,
        bg_command_id: Option<String>,
        recognizer: Option<String>,
        quiet_ms: Option<u64>,
        timeout_seconds: Option<f32>,
        lines: Option<usize>,
        wait_through_busy: bool,
    },
}

Types of actions that can be performed with the BashCommand tool

Variants

Command

Execute a shell command

Fields

command: String

is_background: bool

allow_multi: bool

Opt out of the single-top-level-statement guard. By default winx rejects multi-statement commands (a; b, a && b; c, etc.) so the agent has to be explicit about what it’s running. Set this to true when you knowingly want to run a composite command without wrapping it in bash -lc '...'.

StatusCheck

Check the status of a running command.

By default returns only what changed since the previous call — agents driving long-lived TUIs do not need the cumulative buffer on every poll. Set verbose: true to receive a fresh snapshot regardless of the dedup hash, or scrollback_lines: Some(N) to also pull the last N lines from the PTY ringbuffer.

Fields

status_check: bool

bg_command_id: Option<String>

scrollback_lines: Option<usize>

verbose: bool

SendText

Send text to a running command. Set submit to true to append a carriage return after the bytes so the target program receives the input as a completed line (matches what hitting Enter would do in a TUI).

Fields

send_text: String

Text to type into the running program. Must be non-empty: to press Enter alone, use send_specials: ["Enter"] instead.

bg_command_id: Option<String>

submit: bool

SendSpecials

Send special keys to a running command. submit works the same as in SendText.

Fields

send_specials: Vec<SpecialKey>

bg_command_id: Option<String>

submit: bool

SendAscii

Send ASCII characters to a running command. submit works the same as in SendText.

Fields

send_ascii: Vec<u8>

bg_command_id: Option<String>

submit: bool

Screen

Snapshot the live, stable screen of a shell’s terminal: the consolidated view a human would see right now (cursor moves, redraws, alternate-screen and synchronized-output already applied), ANSI stripped. Unlike status_check, it never stacks redraw generations and never waits — a point-in-time photo, ideal for reading an interactive TUI’s current frame (the claude CLI, vim, htop, fzf).

Fields

screen: bool

bg_command_id: Option<String>

lines: Option<usize>

Last N visible lines to return (0 or omitted = full screen buffer).

diff: bool

When true, return only the lines that CHANGED since the last screen look (big token savings when polling a TUI frame-by-frame) instead of the whole frame. First look, or a large change, still returns full.

WaitForTurn

Block until an interactive TUI finishes its turn and is ready for input. Combines generic quiescence (the screen stopped changing for quiet_ms) with a per-app recognizer, then returns the stable snapshot plus the detected turn state (busy / awaiting_input / awaiting_approval).

Fields

wait_for_turn: bool

bg_command_id: Option<String>

recognizer: Option<String>

Recognizer hint: auto (default, claude+codex), generic, or any bundled agent-manifest id/alias — claude, codex, gemini, antigravity (aka agy), cursor, opencode, copilot, grok, amp, droid, kimi, pi, qwen, and more.

quiet_ms: Option<u64>

Quiet window in ms — the screen must be unchanged this long to count as idle (default 600).

timeout_seconds: Option<f32>

Hard cap in seconds before returning regardless (default 30).

lines: Option<usize>

Visible lines to return in the final snapshot (0 or omitted = full).

wait_through_busy: bool

By default wait_for_turn returns as soon as it confirms the app is actively working (busy), instead of blocking until the turn ends or timeout_seconds elapses — so a long-running child never pins the caller for the whole cap (poll again to keep watching). Set this to true for the old behavior: block through busy until the app is ready for input (or the timeout fires).

Trait Implementations

impl Clone for BashCommandAction

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BashCommandAction

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BashCommandAction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for BashCommandAction

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for BashCommandAction

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.