Struct BashTool 

pub struct BashTool { /* private fields */ }

Built-in tool that executes a shell command.

On Unix-like targets the command is passed to sh -c. On Windows the command is passed to cmd /C, matching the platform’s native shell.

Security

This tool executes arbitrary shell commands via the platform shell. It should only be used with trusted input. It is NOT suitable for production agents exposed to untrusted users.

Implementations

impl BashTool

pub fn new() -> Self

Create a new BashTool.

Trait Implementations

impl AgentTool for BashTool

fn name(&self) -> &str

Unique routing key used to dispatch tool calls.

fn label(&self) -> &str

Human-readable display name for logging and UI.

fn description(&self) -> &str

Natural-language description included in the LLM prompt.

fn parameters_schema(&self) -> &Value

JSON Schema describing the tool’s input shape, used for validation.

fn requires_approval(&self) -> bool

Whether this tool requires user approval before execution. Default is false — tools execute immediately.

fn execute( &self, _tool_call_id: &str, params: Value, cancellation_token: CancellationToken, _on_update: Option<Box<dyn Fn(AgentToolResult) + Send + Sync>>, _state: Arc<RwLock<SessionState>>, _credential: Option<ResolvedCredential>, ) -> ToolFuture<'_>

Execute the tool with validated parameters.

fn metadata(&self) -> Option<ToolMetadata>

Optional organizational metadata (namespace, version).

fn approval_context(&self, _params: &Value) -> Option<Value>

Optional rich context for the approval UI.

fn auth_config(&self) -> Option<AuthConfig>

Optional authentication configuration for this tool.

impl Default for BashTool

fn default() -> Self

Returns the “default value” for a type.