Shell Tool

class ShellTool(BaseTool):
    name = "shell_tool"
    description = "Execute shell commands"
    
    def __init__(
        self,
        executor: Callable[[ShellCommandRequest], str] = None,
        verbose: bool = False,
        *args,
        **kwargs,
    )

@capability
def run(self, request: ShellCommandRequest)

class ShellCommandRequest(BaseModel):
    command: str
    working_directory: str | None = None
    env: dict | None = None
    timeout_ms: int | None = None

from agentor.tools import ShellTool
from agentor.tools.shell import ShellCommandRequest

# Initialize the tool
shell = ShellTool(verbose=True)

# Execute a simple command
request = ShellCommandRequest(command="ls -la")
result = shell.run(request)
print(result)

# Execute with custom working directory
request = ShellCommandRequest(
    command="git status",
    working_directory="/path/to/repo"
)
result = shell.run(request)

# Execute with environment variables and timeout
request = ShellCommandRequest(
    command="npm install",
    working_directory="/path/to/project",
    env={"NODE_ENV": "production"},
    timeout_ms=30000  # 30 second timeout
)
result = shell.run(request)

from agentor import Agentor
from agentor.tools import ShellTool

agent = Agentor(
    name="DevOps Assistant",
    model="gpt-4",
    tools=[ShellTool()],
    instructions="Help with system administration tasks using shell commands.",
)

result = agent.run("List all files in the current directory")
print(result.final_output)

from agentor.tools import ShellTool
from agentor.tools.shell import ShellCommandRequest

def custom_executor(request: ShellCommandRequest) -> str:
    # Custom validation
    if "rm -rf" in request.command:
        return "Error: Dangerous command blocked"
    
    # Custom execution logic
    # ... your implementation ...
    return "Command executed"

shell = ShellTool(executor=custom_executor)

from agentor.tools.shell import LocalShellTool

shell = LocalShellTool()