| """ | |
| Tools supporting the execution of (external) commands | |
| """ | |
| from serena.tools import Tool, ToolMarkerCanEdit | |
| from serena.util.shell import execute_shell_command | |
| class ExecuteShellCommandTool(Tool, ToolMarkerCanEdit): | |
| """ | |
| Executes a shell command. | |
| """ | |
| def apply( | |
| self, | |
| command: str, | |
| cwd: str | None = None, | |
| capture_stderr: bool = True, | |
| max_answer_chars: int = -1, | |
| ) -> str: | |
| """ | |
| Execute a shell command and return its output. If there is a memory about suggested commands, read that first. | |
| Never execute unsafe shell commands like `rm -rf /` or similar! | |
| :param command: the shell command to execute | |
| :param cwd: the working directory to execute the command in. If None, the project root will be used. | |
| :param capture_stderr: whether to capture and return stderr output | |
| :param max_answer_chars: if the output is longer than this number of characters, | |
| no content will be returned. -1 means using the default value, don't adjust unless there is no other way to get the content | |
| required for the task. | |
| :return: a JSON object containing the command's stdout and optionally stderr output | |
| """ | |
| _cwd = cwd or self.get_project_root() | |
| result = execute_shell_command(command, cwd=_cwd, capture_stderr=capture_stderr) | |
| result = result.json() | |
| return self._limit_length(result, max_answer_chars) | |