Struct BashTool 

pub struct BashTool { /* private fields */ }

Tool for executing shell commands.

Uses bash on Unix, cmd on Windows.

Implementations

impl BashTool

pub fn new() -> Self

Creates a new bash tool instance with default settings.

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

Sets the default timeout for commands.

This timeout is used when timeout_ms is not provided in the tool arguments.

pub fn with_default_workdir(self, workdir: impl Into<PathBuf>) -> Self

Sets the default working directory.

This directory is used when workdir is not provided in the tool arguments.

Trait Implementations

impl Clone for BashTool

fn clone(&self) -> BashTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BashTool

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

Formats the value using the given formatter.

impl Default for BashTool

fn default() -> BashTool

Returns the “default value” for a type.

impl<Deps: Send + Sync> Tool<Deps> for BashTool

fn definition(&self) -> ToolDefinition

Get the tool’s definition.

fn call<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 RunContext<Deps>, args: Value, ) -> Pin<Box<dyn Future<Output = ToolResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Execute the tool with given arguments.

fn max_retries(&self) -> Option<u32>

Maximum retries for this tool.

fn prepare<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 RunContext<Deps>, def: ToolDefinition, ) -> Pin<Box<dyn Future<Output = Option<ToolDefinition>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Prepare the tool definition at runtime.

fn name(&self) -> String

Get the tool name.

fn description(&self) -> String

Get the tool description.

impl ToolContext for BashTool

const NAME: &'static str = tool_names::BASH

Tool name used for section headers in generated system prompt.

fn context(&self) -> &'static str

Returns the tool’s context string for system prompt generation.