Struct ShellTool 

pub struct ShellTool { /* private fields */ }

Implementations

impl ShellTool

pub fn new(project_path: PathBuf) -> Self

pub fn with_allowed_commands( project_path: PathBuf, allowed_commands: Arc<AllowedCommands>, ) -> Self

Create with shared allowed commands state (for session persistence)

pub fn without_confirmation(self) -> Self

Disable confirmation prompts (useful for scripted/batch mode)

pub fn with_read_only(self, read_only: bool) -> Self

Enable read-only mode (for plan mode) - only allows read-only commands

Trait Implementations

impl Clone for ShellTool

fn clone(&self) -> ShellTool

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ShellTool

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

Formats the value using the given formatter.

impl Tool for ShellTool

const NAME: &'static str = "shell"

The name of the tool. This name should be unique.

type Error = ShellError

The error type of the tool.

type Args = ShellArgs

The arguments type of the tool.

type Output = String

The output type of the tool.

async fn definition(&self, _prompt: String) -> ToolDefinition

A method returning the tool definition. The user prompt can be used to tailor the definition to the specific use case.

async fn call(&self, args: Self::Args) -> Result<Self::Output, Self::Error>

The tool execution method. Both the arguments and return value are a String since these values are meant to be the output and input of LLM models (respectively)

fn name(&self) -> String

A method returning the name of the tool.