Struct BashTool 

pub struct BashTool { /* private fields */ }

Tool that executes bash commands with permission checks.

Implementations

impl BashTool

pub fn new(permission_registry: Arc<PermissionRegistry>) -> BashTool

Create a new BashTool with the given permission registry.

Arguments

• permission_registry - The registry used to request and cache permissions.

pub fn with_working_dir( permission_registry: Arc<PermissionRegistry>, working_dir: PathBuf, ) -> BashTool

Create a new BashTool with a default working directory.

Arguments

• permission_registry - The registry used to request and cache permissions.
• working_dir - The default working directory for commands.

pub async fn cleanup_session(&self, session_id: i64)

Cleans up session-specific state when a session is removed.

This removes the working directory state for the given session, preventing unbounded memory growth from abandoned sessions.

Trait Implementations

impl Executable for BashTool

fn name(&self) -> &str

Get the tool name.

fn description(&self) -> &str

Get the tool description.

fn input_schema(&self) -> &str

Get the input schema as JSON string.

fn tool_type(&self) -> ToolType

Get the tool type.

fn execute( &self, context: ToolContext, input: HashMap<String, Value>, ) -> Pin<Box<dyn Future<Output = Result<String, String>> + Send>>

Execute the tool with given input.

fn display_config(&self) -> DisplayConfig

Get display configuration for UI rendering.

fn compact_summary( &self, input: &HashMap<String, Value>, result: &str, ) -> String

Generate compact summary for context compaction.

fn required_permissions( &self, context: &ToolContext, input: &HashMap<String, Value>, ) -> Option<Vec<PermissionRequest>>

Return the permissions required to execute this tool with the given input.

fn cleanup_session( &self, session_id: i64, ) -> Pin<Box<dyn Future<Output = ()> + Send + '_>>

Cleans up any session-specific state when a session is removed.

fn to_definition(&self) -> ToolDefinition

Convert to LLM tool definition.

fn to_llm_tool(&self) -> Tool

Convert to LLMTool for provider APIs.

fn handles_own_permissions(&self) -> bool

Whether this tool handles its own permission flow internally.