Struct Bash 

pub struct Bash<G: ToolGate> {
    gate: G,
}

Execute commands through a shell. The shell is non-interactive: there is no terminal and no stdin, so anything that would prompt (passwords, pagers, …) fails immediately instead of waiting.

The command runs asynchronously: awaiting execute does not block the runtime, and dropping the future (e.g. when the tool call is interrupted) kills the child.

Fields

gate: G

Gate for receiving permissions to execute bash commands

Implementations

impl<G: ToolGate> Bash<G>

pub fn new(gate: G) -> Self

Create a new bash tool, gated by gate

Trait Implementations

impl<G: ToolGate> CallableTool for Bash<G>

async fn execute( &self, _agent: &Agent, params: BashParams, ) -> Result<BashResult>

Execute a tool call.

impl<G: Debug + ToolGate> Debug for Bash<G>

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

Formats the value using the given formatter.

impl<G: ToolGate> Tool for Bash<G>

fn name(&self) -> String

Tool name

fn description(&self) -> Option<String>

Tool description, if any

fn schema(&self) -> Schema

Tool arguments JSON schema

fn execute_unparsed<'a>( &'a self, agent: &'a Agent, arguments: &'a str, ) -> Pin<Box<dyn Future<Output = Result<String>> + 'a>>

Execute this tool, arguments given in JSON format (unparsed)

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

Format the tool call arguments for Display

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

Format the tool call result for Display

impl<G: ToolGate> ToolState for Bash<G>

type ParamType = BashParams

Associated parameter type.

type ResultType = BashResult

Associated return type.