Struct BashTool 

pub struct BashTool { /* private fields */ }

Agent tool that runs bash commands in a working directory.

Implementations

impl BashTool

pub fn new(cwd: impl Into<PathBuf>) -> Self

Creates a bash tool rooted at cwd.

pub fn with_options(options: BashToolOptions) -> Self

Creates a bash tool from explicit options.

pub fn parameters_schema() -> Value

Returns the JSON Schema for bash arguments (normalized TypeBox shape).

pub fn parse_input( args: &Map<String, Value>, ) -> Result<BashToolInput, ToolError>

Validates raw tool arguments into BashToolInput.

Errors

Returns ToolError when required fields are missing or mistyped, or when timeout fails TypeScript resolveTimeoutMs checks.

Trait Implementations

impl AgentTool for BashTool

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

Unique tool name.

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

Human-readable label for UI display.

fn description(&self) -> &str

Human-readable tool description.

fn parameters(&self) -> &Value

JSON Schema for tool arguments.

fn validate_arguments( &self, args: &Map<String, Value>, ) -> Result<Map<String, Value>, ToolError>

Validates prepared arguments for this tool.

fn execute( &self, _tool_call_id: &str, args: Map<String, Value>, cancel: CancellationToken, updates: ToolUpdates, ) -> BoxFuture<'static, Result<AgentToolResult, ToolError>>

Executes the tool call.

fn execution_mode(&self) -> Option<ToolExecutionMode>

Optional per-tool execution mode override.

fn prepare_arguments( &self, raw: &Map<String, Value>, ) -> Result<Map<String, Value>, ToolError>

Optional compatibility shim for raw tool-call arguments before validation.

fn prepare_and_validate_arguments( &self, raw: Map<String, Value>, ) -> Pin<Box<dyn Future<Output = Result<Map<String, Value>, ToolError>> + Send + '_>>

Prepares and validates raw arguments before lifecycle hooks and execution.

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.