Skip to main content

BASH_TOOL_DESCRIPTION

Constant BASH_TOOL_DESCRIPTION 

Source
pub const BASH_TOOL_DESCRIPTION: &str = r#"Executes bash commands with timeout and session support.

Usage:
- Executes the given command in a bash shell
- Supports configurable timeout (default: 120 seconds, max: 600 seconds)
- Working directory persists between commands in a session
- Shell environment is initialized from user's profile

Important Notes:
- Use this for system commands, git operations, build tools, etc.
- Avoid using for file operations (use dedicated file tools instead)
- Commands that require interactive input are not supported
- Long-running commands should use the background option

Options:
- command: The bash command to execute (required)
- timeout: Timeout in milliseconds (default: 120000, max: 600000)
- working_dir: Working directory for the command (optional)
- run_in_background: Run command in background and return immediately (optional)
- background_timeout: Timeout in milliseconds for background tasks (optional, no limit if not set)

Examples:
- Run git status: command="git status"
- Build with timeout: command="cargo build", timeout=300000
- Run in specific directory: command="ls -la", working_dir="/path/to/dir""#;
Expand description

Bash tool description constant.