mirror of
https://github.com/All-Hands-AI/OpenHands.git
synced 2026-04-29 03:00:45 -04:00
dc91cb263b
Co-authored-by: openhands <openhands@all-hands.dev> Co-authored-by: Ray Myers <ray.myers@gmail.com> Co-authored-by: Xingyao Wang <xingyao@all-hands.dev>
59 lines
3.9 KiB
Python
59 lines
3.9 KiB
Python
from litellm import ChatCompletionToolParam, ChatCompletionToolParamFunctionChunk
|
|
|
|
_DETAILED_BASH_DESCRIPTION = """Execute a bash command in the terminal within a persistent shell session.
|
|
|
|
### Command Execution
|
|
* One command at a time: You can only execute one bash command at a time. If you need to run multiple commands sequentially, use `&&` or `;` to chain them together.
|
|
* Persistent session: Commands execute in a persistent shell session where environment variables, virtual environments, and working directory persist between commands.
|
|
* Timeout: Commands have a soft timeout of 120 seconds, once that's reached, you have the option to continue or interrupt the command (see section below for details)
|
|
|
|
### Running and Interacting with Processes
|
|
* Long running commands: For commands that may run indefinitely, run them in the background and redirect output to a file, e.g. `python3 app.py > server.log 2>&1 &`.
|
|
* Interact with running process: If a bash command returns exit code `-1`, this means the process is not yet finished. By setting `is_input` to `true`, you can:
|
|
- Send empty `command` to retrieve additional logs
|
|
- Send text (set `command` to the text) to STDIN of the running process
|
|
- Send control commands like `C-c` (Ctrl+C), `C-d` (Ctrl+D), or `C-z` (Ctrl+Z) to interrupt the process
|
|
|
|
### Best Practices
|
|
* Directory verification: Before creating new directories or files, first verify the parent directory exists and is the correct location.
|
|
* Directory management: Try to maintain working directory by using absolute paths and avoiding excessive use of `cd`.
|
|
|
|
### Output Handling
|
|
* Output truncation: If the output exceeds a maximum length, it will be truncated before being returned.
|
|
"""
|
|
|
|
_SHORT_BASH_DESCRIPTION = """Execute a bash command in the terminal.
|
|
* Long running commands: For commands that may run indefinitely, it should be run in the background and the output should be redirected to a file, e.g. command = `python3 app.py > server.log 2>&1 &`.
|
|
* Interact with running process: If a bash command returns exit code `-1`, this means the process is not yet finished. By setting `is_input` to `true`, the assistant can interact with the running process and send empty `command` to retrieve any additional logs, or send additional text (set `command` to the text) to STDIN of the running process, or send command like `C-c` (Ctrl+C), `C-d` (Ctrl+D), `C-z` (Ctrl+Z) to interrupt the process.
|
|
* One command at a time: You can only execute one bash command at a time. If you need to run multiple commands sequentially, you can use `&&` or `;` to chain them together."""
|
|
|
|
|
|
def create_cmd_run_tool(
|
|
use_short_description: bool = False,
|
|
) -> ChatCompletionToolParam:
|
|
description = (
|
|
_SHORT_BASH_DESCRIPTION if use_short_description else _DETAILED_BASH_DESCRIPTION
|
|
)
|
|
return ChatCompletionToolParam(
|
|
type='function',
|
|
function=ChatCompletionToolParamFunctionChunk(
|
|
name='execute_bash',
|
|
description=description,
|
|
parameters={
|
|
'type': 'object',
|
|
'properties': {
|
|
'command': {
|
|
'type': 'string',
|
|
'description': 'The bash command to execute. Can be empty string to view additional logs when previous exit code is `-1`. Can be `C-c` (Ctrl+C) to interrupt the currently running process. Note: You can only execute one bash command at a time. If you need to run multiple commands sequentially, you can use `&&` or `;` to chain them together.',
|
|
},
|
|
'is_input': {
|
|
'type': 'string',
|
|
'description': 'If True, the command is an input to the running process. If False, the command is a bash command to be executed in the terminal. Default is False.',
|
|
'enum': ['true', 'false'],
|
|
},
|
|
},
|
|
'required': ['command'],
|
|
},
|
|
),
|
|
)
|