Struct ShellTool 

pub struct ShellTool { /* private fields */ }

Shell command execution tool with sandboxing

Implementations

impl ShellTool

pub fn new( security: Arc<SecurityPolicy>, runtime: Arc<dyn RuntimeAdapter>, ) -> ShellTool

pub fn new_with_sandbox( security: Arc<SecurityPolicy>, runtime: Arc<dyn RuntimeAdapter>, sandbox: Arc<dyn Sandbox>, ) -> ShellTool

pub fn with_persistent_writes(self, persistent: bool) -> ShellTool

pub fn with_timeout_secs(self, secs: u64) -> ShellTool

Override the command execution timeout (in seconds).

pub fn with_tui_env(self, env: Option<HashMap<String, String>>) -> ShellTool

Overlay the TUI client’s environment on top of the safe-env snapshot. Pass Some(env) to enable forwarding; None is a no-op (same as not calling this method at all).

Trait Implementations

impl Attributable for ShellTool

fn role(&self) -> Role

fn alias(&self) -> &str

impl Tool for ShellTool

fn name(&self) -> &str

Tool name (used in LLM function calling)

fn description(&self) -> &str

Human-readable description

fn parameters_schema(&self) -> Value

JSON schema for parameters

fn execute<'life0, 'async_trait>( &'life0 self, args: Value, ) -> Pin<Box<dyn Future<Output = Result<ToolResult, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, ShellTool: 'async_trait,

Execute the tool with given arguments

fn output_schema(&self) -> Option<Value>

JSON schema describing the structured output this tool attaches to ToolOutput::data, when it declares one. None means the tool emits display text only; authoring surfaces fall back to sample-derived shapes from captured runs.

fn param_domains(&self) -> Vec<(&'static str, OptionDomain)>

Option domains for parameters whose value sets live in runtime config rather than the static schema (channel refs, peer targets, …). Surfaces resolve these through the runtime to render real selectable choices. Default: no domain-typed parameters.

fn spec(&self) -> ToolSpec