Struct Bash 

pub struct Bash {
    pub description_run: ToolDescription,
    /* private fields */
}

Shared-state wrapper for bash execution.

Use the builder methods after new to configure the environment, then call run to execute a command.

Fields

description_run: ToolDescription

MCP Tool description for run.

Implementations

impl Bash

pub fn new() -> Self

Create a new Bash with default settings.

• timeout: DEFAULT_TIMEOUT_MS (10 minutes)
• env: None (inherit parent process)
• pty: false (piped stdout/stderr, not pseudo-terminal)
• cwd: "" (inherited from the parent process)

pub fn timeout(self, ms: u64) -> Self

Set the execution timeout in milliseconds.

When the timeout elapses, the child process is killed and the stream yields a final item with signal: Some(-1) and exit_code: None. The model-facing tool description is regenerated with the new value, so it always states the threshold run_with_timeout enforces.

pub fn env(self, env: Option<Vec<(String, String)>>) -> Self

Set environment variables for the child process.

Pass None to inherit the parent’s environment.

pub const fn pty(self, v: bool) -> Self

Use a pseudo-terminal for the child process.

When true, stdout and stderr are multiplexed into the PTY (colored output, prompts, etc.). When false (default), they are captured as separate piped streams.

pub fn cwd(self, path: impl Into<String>) -> Self

Set the working directory for the command.

pub fn run<'a>( &'a self, command: &'a str, ) -> Result<Pin<Box<dyn Stream<Item = SpawnOutput> + Send + 'a>>, BashError>

Execute a bash command and return its output as an async stream.

The returned stream borrows from self — it must not outlive the Bash instance.

Errors

Returns BashError if the command is an absolute path or matches a dangerous security pattern.

pub fn run_with_timeout<'a>( &'a self, command: &'a str, timeout_ms: Option<u64>, ) -> Result<Pin<Box<dyn Stream<Item = SpawnOutput> + Send + 'a>>, BashError>

Execute a bash command with an optional per-call timeout override.

timeout_ms extends the configured timeout for this call only — it never changes the default held by self. It may only raise the timeout: a value that is not strictly greater than the instance’s configured timeout is rejected with a BashError and nothing is executed. None runs with the configured timeout.

Errors

Returns BashError if the command is an absolute path, matches a dangerous security pattern, or timeout_ms fails to raise the configured timeout.

Trait Implementations

impl Default for Bash

fn default() -> Self

Returns the “default value” for a type.