diff options
Diffstat (limited to 'docs/tools')
| -rw-r--r-- | docs/tools/index.md | 4 | ||||
| -rw-r--r-- | docs/tools/shell.md | 8 |
2 files changed, 6 insertions, 6 deletions
diff --git a/docs/tools/index.md b/docs/tools/index.md index 2e3b7c26..2efce3bd 100644 --- a/docs/tools/index.md +++ b/docs/tools/index.md @@ -11,7 +11,7 @@ The core component (`packages/core`) manages these tools, presents their definit ## Why are Tools Important? - **Access to Local Information:** Tools allow Gemini to access your local file system, read file contents, list directories, etc. -- **Execution of Commands:** With tools like `execute_bash_command`, Gemini can run shell commands (with appropriate safety measures and user confirmation). +- **Execution of Commands:** With tools like `run_shell_command`, Gemini can run shell commands (with appropriate safety measures and user confirmation). - **Interaction with the Web:** Tools can fetch content from URLs. - **Action Taking:** Tools can modify files, write new files, or perform other actions on your system (again, typically with safeguards). - **Grounding Responses:** By using tools to fetch real-time or specific local data, Gemini's responses can be more accurate, relevant, and grounded in your actual context. @@ -30,7 +30,7 @@ You will typically see messages in the CLI indicating when a tool is being calle ## Security and Confirmation -Many tools, especially those that can modify your file system or execute commands (`write_file`, `edit`, `execute_bash_command`), are designed with safety in mind. The Gemini CLI will typically: +Many tools, especially those that can modify your file system or execute commands (`write_file`, `edit`, `run_shell_command`), are designed with safety in mind. The Gemini CLI will typically: - **Require Confirmation:** Prompt you before executing potentially sensitive operations, showing you what action is about to be taken. - **Utilize Sandboxing:** All tools are subject to restrictions enforced by sandboxing (see [README](../../README.md#sandboxing)). 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. |