Skip to main content

BashTool

Struct BashTool 

Source
pub struct BashTool {
    pub cwd: Option<String>,
    pub timeout: Duration,
    pub max_output_bytes: usize,
    pub deny_patterns: Vec<String>,
    pub confirm_fn: Option<ConfirmFn>,
}
Expand description

Execute shell commands. Captures stdout + stderr.

Fields§

§cwd: Option<String>

Working directory for commands (None = inherit from current process)

§timeout: Duration

Max execution time per command (default: 120s)

§max_output_bytes: usize

Max output bytes to capture (prevents OOM on huge outputs, default: 256KB)

§deny_patterns: Vec<String>

Commands/patterns that are always blocked (e.g., “rm -rf /”)

§confirm_fn: Option<ConfirmFn>

Optional callback for confirming dangerous commands (None = auto-allow)

Implementations§

Source§

impl BashTool

Source

pub fn new() -> Self

Source

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

Source

pub fn with_timeout(self, timeout: Duration) -> Self

Source

pub fn with_deny_patterns(self, patterns: Vec<String>) -> Self

Source

pub fn with_confirm( self, f: impl Fn(&str) -> bool + Send + Sync + 'static, ) -> Self

Trait Implementations§

Source§

impl AgentTool for BashTool

Source§

fn name(&self) -> &str

Unique tool name (used in LLM tool_use)
Source§

fn label(&self) -> &str

Human-readable label for UI
Source§

fn description(&self) -> &str

Description for the LLM
Source§

fn parameters_schema(&self) -> Value

JSON Schema for parameters
Source§

fn execute<'life0, 'async_trait>( &'life0 self, params: Value, ctx: ToolContext, ) -> Pin<Box<dyn Future<Output = Result<ToolResult, ToolError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Execute the tool. Read more
Source§

fn timeout(&self) -> Option<Duration>

Optional per-tool execution timeout. Read more
Source§

impl Default for BashTool

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more