- Create a class inheriting the
phi.tools.Toolkitclass. - Add your functions to the class.
- Important: Register the functions using
self.register(function_name)
shell_toolkit.py
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
phi.tools.Toolkit class.self.register(function_name)from typing import List
from phi.tools import Toolkit
from phi.utils.log import logger
class ShellTools(Toolkit):
def __init__(self):
super().__init__(name="shell_tools")
self.register(self.run_shell_command)
def run_shell_command(self, args: List[str], tail: int = 100) -> str:
"""Runs a shell command and returns the output or error.
Args:
args (List[str]): The command to run as a list of strings.
tail (int): The number of lines to return from the output.
Returns:
str: The output of the command.
"""
import subprocess
logger.info(f"Running shell command: {args}")
try:
logger.info(f"Running shell command: {args}")
result = subprocess.run(args, capture_output=True, text=True)
logger.debug(f"Result: {result}")
logger.debug(f"Return code: {result.returncode}")
if result.returncode != 0:
return f"Error: {result.stderr}"
# return only the last n lines of the output
return "\n".join(result.stdout.split("\n")[-tail:])
except Exception as e:
logger.warning(f"Failed to run shell command: {e}")
return f"Error: {e}"
Was this page helpful?