Struct BashTool 

pub struct BashTool { /* private fields */ }

Execute shell commands. Two constructors: BashTool::new restricts execution to commands matching a glob pattern; BashTool::unrestricted allows any command. Not read-only.

Examples

Pattern-restricted (only git ... commands):

use agentwerk::tools::BashTool;
use agentwerk::agents::agent::Agent;

Agent::new().tool(BashTool::new("git", "git *"));

Unrestricted:

use agentwerk::tools::BashTool;
use agentwerk::agents::agent::Agent;

Agent::new().tool(BashTool::unrestricted());

Implementations

impl BashTool

pub const DEFAULT_TIMEOUT: Duration

Default per-command timeout when the model omits timeout_ms.

pub const MAX_TIMEOUT: Duration

Maximum per-command timeout the model is allowed to request.

pub fn new(name: &str, pattern: &str) -> Self

Create a new BashTool with the given name that only permits commands matching pattern. The static description rendered from bash.tool.json is loaded once and a one-line pattern suffix is appended per instance. read_only defaults to the value declared in bash.tool.json and may be overridden via BashTool::read_only.

pub fn with_description(self, description: &str) -> Self

Override the auto-generated description.

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

Set whether this tool is considered read-only.

impl BashTool

pub fn unrestricted() -> Self

Create an unrestricted bash tool with the standard description.

Trait Implementations

impl ToolLike for BashTool

fn name(&self) -> &str

Unique name the model uses to call the tool.

fn description(&self) -> &str

Human-readable description shown to the model.

fn input_schema(&self) -> Value

JSON Schema describing the tool’s arguments.

fn is_read_only(&self) -> bool

Whether this tool has no side effects. Read-only tools in the same step run concurrently; non-read-only tools run serially. Default: false.

fn call<'a>( &'a self, input: Value, ctx: &'a ToolContext, ) -> Pin<Box<dyn Future<Output = Result<ToolResult>> + Send + 'a>>

Run the tool. The future is held by the agent loop and dropped on cancellation; pair long-running work with ToolContext::wait_for_cancel in a tokio::select! to drop the losing branch promptly.

fn should_defer(&self) -> bool

Whether the tool’s full definition is hidden until it is discovered via ToolSearchTool. Deferred tools appear to the model as name-only stubs. Default: false.