Camel.toolkits.terminal toolkit.terminal toolkit

​

_to_plain

def _to_plain(text: str):

​

TerminalToolkit

class TerminalToolkit(BaseToolkit):

• timeout (Optional[float]): The default timeout in seconds for blocking commands. Defaults to 20.0.
• working_directory (Optional[str]): The base directory for operations. For the local backend, this acts as a security sandbox. For the Docker backend, this sets the working directory inside the container. If not specified, defaults to ”./workspace” for local and “/workspace” for Docker.
• use_docker_backend (bool): If True, all commands are executed in a Docker container. Defaults to False.
• docker_container_name (Optional[str]): The name of the Docker container to use. Required if use_docker_backend is True.
• session_logs_dir (Optional[str]): The directory to store session logs. Defaults to a ‘terminal_logs’ subfolder in the working directory.
• safe_mode (bool): Whether to apply security checks to commands. Defaults to True.
• allowed_commands (Optional[List[str]]): List of allowed commands when safe_mode is True. If None, uses default safety rules.
• clone_current_env (bool): Whether to clone the current Python environment for local execution. Defaults to False.
• install_dependencies (List): A list of user specified libraries to install.

​

init

def __init__(
    self,
    timeout: Optional[float] = 20.0,
    working_directory: Optional[str] = None,
    use_docker_backend: bool = False,
    docker_container_name: Optional[str] = None,
    session_logs_dir: Optional[str] = None,
    safe_mode: bool = True,
    allowed_commands: Optional[List[str]] = None,
    clone_current_env: bool = False,
    install_dependencies: Optional[List[str]] = None
):

​

_setup_cloned_environment

def _setup_cloned_environment(self):

​

_install_dependencies

def _install_dependencies(self):

​

_setup_initial_environment

def _setup_initial_environment(self):

​

_get_venv_path

def _get_venv_path(self):

​

_write_to_log

def _write_to_log(self, log_file: str, content: str):

• log_file (str): Path to the log file
• content (str): Content to write

​

_sanitize_command

def _sanitize_command(self, command: str):

​

_start_output_reader_thread

def _start_output_reader_thread(self, session_id: str):

​

_collect_output_until_idle

def _collect_output_until_idle(
    self,
    id: str,
    idle_duration: float = 0.5,
    max_wait: float = 5.0
):

• id (str): The session ID.
• idle_duration (float): How long the stream must be empty to be considered idle.(default: 0.5)
• max_wait (float): The maximum total time to wait for the process to go idle. (default: 5.0)

​

shell_exec

def shell_exec(
    self,
    id: str,
    command: str,
    block: bool = True,
    timeout: float = 20.0
):

• id (str): A unique identifier for the command’s session. This ID is used to interact with non-blocking processes.
• command (str): The shell command to execute.
• block (bool, optional): Determines the execution mode. Defaults to True. If True (blocking mode), the function waits for the command to complete and returns the full output. Use this for most commands. If False (non-blocking mode), the function starts the command in the background. Use this only for interactive sessions or long-running tasks, or servers.
• timeout (float, optional): The maximum time in seconds to wait for the command to complete in blocking mode. If the command does not complete within the timeout, it will be restarted automatically as a non-blocking background session. You can then use shell_view(id) to check output, or shell_kill_process(id) to terminate it. This parameter is ignored in non-blocking mode. (default: :obj:20)

​

shell_write_to_process

def shell_write_to_process(self, id: str, command: str):

• id (str): The unique session ID of the non-blocking process.
• command (str): The text to write to the process’s standard input.

​

shell_view

def shell_view(self, id: str):

• id (str): The unique session ID of the non-blocking process.

​

shell_kill_process

def shell_kill_process(self, id: str):

• id (str): The unique session ID of the process to kill.

​

shell_ask_user_for_help

def shell_ask_user_for_help(self, id: str, prompt: str):

1. If session exists: Shows session output and allows interaction
2. If session doesn’t exist: Creates a temporary session for help

• id (str): The session ID of the interactive process needing help. Can be empty string for general help without session context.
• prompt (str): The question or instruction from the LLM to show the human user (e.g., “The program is asking for a filename. Please enter ‘config.json’.”).

​

enter

def __enter__(self):

​

exit

def __exit__(
    self,
    exc_type,
    exc_val,
    exc_tb
):

​

cleanup

def cleanup(self):

​

del

def __del__(self):

​

get_tools

def get_tools(self):