Shell

ShellTools enable an Agent to interact with the shell to run commands.

Example

The following agent will run a shell command and show contents of the current directory.

Note

Mention your OS to the agent to make sure it runs the correct command.

1from kern.agent import Agent
2from kern.tools.shell import ShellTools
3
4agent = Agent(tools=[ShellTools()])
5agent.print_response("Show me the contents of the current directory", markdown=True)

Toolkit Params

Parameter	Type	Default	Description
`base_dir`	`Path	str`	`None`
`enable_run_shell_command`	`bool`	`True`	Enables functionality to run shell commands
`all`	`bool`	`False`	Enables all functionality when set to True

Toolkit Functions

Function	Description
`run_shell_command`	Runs a shell command and returns the output or error.

Developer Resources

View Tools