diff options
| author | Olcan <[email protected]> | 2025-06-09 08:57:30 -0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-06-09 08:57:30 -0700 |
| commit | 87474e52d7e0f3abcaf74272b11c7b9244d98af5 (patch) | |
| tree | e8ead2ce030823fda16af21a3deafe17c7116afa /docs/tools/shell.md | |
| parent | c55a1d90120ff8b567e9059466819c4920dc560e (diff) | |
rename shell tool more intuitively as run_shell_command (from historical name of execute_bash_command inherited from terminal tool) (#869)
Diffstat (limited to 'docs/tools/shell.md')
| -rw-r--r-- | docs/tools/shell.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/tools/shell.md b/docs/tools/shell.md index 3c14c657..d8055deb 100644 --- a/docs/tools/shell.md +++ b/docs/tools/shell.md @@ -2,7 +2,7 @@ This document provides details on the shell tool. -## `execute_bash_command` +## `run_shell_command` - **Purpose:** Executes a given shell command using `bash -c <command>`. This tool is essential for interacting with the underlying operating system, running scripts, or performing command-line operations. - **Arguments:** @@ -24,15 +24,15 @@ This document provides details on the shell tool. - **Examples:** - Listing files in the current directory: ``` - execute_bash_command(command="ls -la") + run_shell_command(command="ls -la") ``` - Running a script in a specific directory: ``` - execute_bash_command(command="./my_script.sh", directory="scripts", description="Run my custom script") + run_shell_command(command="./my_script.sh", directory="scripts", description="Run my custom script") ``` - Starting a background server: ``` - execute_bash_command(command="npm run dev &", description="Start development server in background") + run_shell_command(command="npm run dev &", description="Start development server in background") ``` - **Important Notes:** - **Security:** Be cautious when executing commands, especially those constructed from user input, to prevent security vulnerabilities. |