Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions sdk/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,9 @@ Here's a complete example that creates an agent and asks it to perform a simple
import os

from openhands.sdk import LLM, Agent, Conversation, Tool
from openhands.tools.execute_bash import BashTool
from openhands.tools.file_editor import FileEditorTool
from openhands.tools.task_tracker import TaskTrackerTool
from openhands.tools.terminal import TerminalTool


llm = LLM(
Expand All @@ -88,7 +88,7 @@ llm = LLM(
agent = Agent(
llm=llm,
tools=[
Tool(name=BashTool.name),
Tool(name=TerminalTool.name),
Tool(name=FileEditorTool.name),
Tool(name=TaskTrackerTool.name),
],
Expand Down
4 changes: 2 additions & 2 deletions sdk/guides/agent-browser-use.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ from openhands.sdk import (
)
from openhands.sdk.tool import Tool
from openhands.tools.browser_use import BrowserToolSet
from openhands.tools.execute_bash import BashTool
from openhands.tools.file_editor import FileEditorTool
from openhands.tools.terminal import TerminalTool


logger = get_logger(__name__)
Expand All @@ -46,7 +46,7 @@ llm = LLM(
cwd = os.getcwd()
tools = [
Tool(
name=BashTool.name,
name=TerminalTool.name,
),
Tool(name=FileEditorTool.name),
Tool(name=BrowserToolSet.name),
Expand Down
4 changes: 2 additions & 2 deletions sdk/guides/agent-interactive-terminal.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ from openhands.sdk import (
get_logger,
)
from openhands.sdk.tool import Tool
from openhands.tools.execute_bash import BashTool
from openhands.tools.terminal import TerminalTool


logger = get_logger(__name__)
Expand All @@ -45,7 +45,7 @@ llm = LLM(
cwd = os.getcwd()
tools = [
Tool(
name=BashTool.name,
name=TerminalTool.name,
params={"no_change_timeout_seconds": 3},
)
]
Expand Down
4 changes: 2 additions & 2 deletions sdk/guides/context-condenser.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@ from openhands.sdk import (
)
from openhands.sdk.context.condenser import LLMSummarizingCondenser
from openhands.sdk.tool import Tool
from openhands.tools.execute_bash import BashTool
from openhands.tools.file_editor import FileEditorTool
from openhands.tools.task_tracker import TaskTrackerTool
from openhands.tools.terminal import TerminalTool


logger = get_logger(__name__)
Expand All @@ -100,7 +100,7 @@ llm = LLM(
cwd = os.getcwd()
tools = [
Tool(
name=BashTool.name,
name=TerminalTool.name,
),
Tool(name=FileEditorTool.name),
Tool(name=TaskTrackerTool.name),
Expand Down
4 changes: 2 additions & 2 deletions sdk/guides/convo-async.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ from openhands.sdk import (
from openhands.sdk.conversation.types import ConversationCallbackType
from openhands.sdk.tool import Tool
from openhands.sdk.utils.async_utils import AsyncCallbackWrapper
from openhands.tools.execute_bash import BashTool
from openhands.tools.file_editor import FileEditorTool
from openhands.tools.task_tracker import TaskTrackerTool
from openhands.tools.terminal import TerminalTool


logger = get_logger(__name__)
Expand All @@ -55,7 +55,7 @@ llm = LLM(
cwd = os.getcwd()
tools = [
Tool(
name=BashTool.name,
name=TerminalTool.name,
),
Tool(name=FileEditorTool.name),
Tool(name=TaskTrackerTool.name),
Expand Down
4 changes: 2 additions & 2 deletions sdk/guides/convo-pause-and-resume.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ from openhands.sdk import (
Conversation,
)
from openhands.sdk.tool import Tool
from openhands.tools.execute_bash import BashTool
from openhands.tools.file_editor import FileEditorTool
from openhands.tools.terminal import TerminalTool


# Configure LLM
Expand All @@ -42,7 +42,7 @@ llm = LLM(
# Tools
tools = [
Tool(
name=BashTool.name,
name=TerminalTool.name,
),
Tool(name=FileEditorTool.name),
]
Expand Down
4 changes: 2 additions & 2 deletions sdk/guides/convo-persistence.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ from openhands.sdk import (
get_logger,
)
from openhands.sdk.tool import Tool
from openhands.tools.execute_bash import BashTool
from openhands.tools.file_editor import FileEditorTool
from openhands.tools.terminal import TerminalTool


logger = get_logger(__name__)
Expand All @@ -45,7 +45,7 @@ llm = LLM(
# Tools
cwd = os.getcwd()
tools = [
Tool(name=BashTool.name),
Tool(name=TerminalTool.name),
Tool(name=FileEditorTool.name),
]

Expand Down
4 changes: 2 additions & 2 deletions sdk/guides/convo-send-message-while-running.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ from openhands.sdk import (
Conversation,
)
from openhands.sdk.tool import Tool
from openhands.tools.execute_bash import BashTool
from openhands.tools.file_editor import FileEditorTool
from openhands.tools.terminal import TerminalTool


# Configure LLM
Expand All @@ -83,7 +83,7 @@ llm = LLM(
cwd = os.getcwd()
tools = [
Tool(
name=BashTool.name,
name=TerminalTool.name,
),
Tool(name=FileEditorTool.name),
]
Expand Down
12 changes: 6 additions & 6 deletions sdk/guides/custom-tools.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,12 @@ from openhands.sdk.tool import (
ToolExecutor,
register_tool,
)
from openhands.tools.execute_bash import (
from openhands.tools.file_editor import FileEditorTool
from openhands.tools.terminal import (
BashExecutor,
BashTool,
ExecuteBashAction,
TerminalTool,
)
from openhands.tools.file_editor import FileEditorTool


logger = get_logger(__name__)
Expand Down Expand Up @@ -210,11 +210,11 @@ cwd = os.getcwd()


def _make_bash_and_grep_tools(conv_state) -> list[ToolDefinition]:
"""Create execute_bash and custom grep tools sharing one executor."""
"""Create terminal and custom grep tools sharing one executor."""

bash_executor = BashExecutor(working_dir=conv_state.workspace.working_dir)
# bash_tool = execute_bash_tool.set_executor(executor=bash_executor)
bash_tool = BashTool.create(conv_state, executor=bash_executor)[0]
# bash_tool = terminal_tool.set_executor(executor=bash_executor)
bash_tool = TerminalTool.create(conv_state, executor=bash_executor)[0]

# Use the GrepTool.create() method with shared bash_executor
grep_tool = GrepTool.create(conv_state, bash_executor=bash_executor)[0]
Expand Down
4 changes: 2 additions & 2 deletions sdk/guides/hello-world.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ This is the most basic example showing how to set up and run an OpenHands agent:
import os

from openhands.sdk import LLM, Agent, Conversation, Tool
from openhands.tools.execute_bash import BashTool
from openhands.tools.file_editor import FileEditorTool
from openhands.tools.task_tracker import TaskTrackerTool
from openhands.tools.terminal import TerminalTool


llm = LLM(
Expand All @@ -26,7 +26,7 @@ llm = LLM(
agent = Agent(
llm=llm,
tools=[
Tool(name=BashTool.name),
Tool(name=TerminalTool.name),
Tool(name=FileEditorTool.name),
Tool(name=TaskTrackerTool.name),
],
Expand Down
4 changes: 2 additions & 2 deletions sdk/guides/llm-image-input.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ from openhands.sdk import (
get_logger,
)
from openhands.sdk.tool.spec import Tool
from openhands.tools.execute_bash import BashTool
from openhands.tools.file_editor import FileEditorTool
from openhands.tools.task_tracker import TaskTrackerTool
from openhands.tools.terminal import TerminalTool


logger = get_logger(__name__)
Expand All @@ -58,7 +58,7 @@ agent = Agent(
llm=llm,
tools=[
Tool(
name=BashTool.name,
name=TerminalTool.name,
),
Tool(name=FileEditorTool.name),
Tool(name=TaskTrackerTool.name),
Expand Down
4 changes: 2 additions & 2 deletions sdk/guides/llm-reasoning.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ from openhands.sdk import (
ThinkingBlock,
)
from openhands.sdk.tool import Tool
from openhands.tools.execute_bash import BashTool
from openhands.tools.terminal import TerminalTool


# Configure LLM for Anthropic Claude with extended thinking
Expand All @@ -50,7 +50,7 @@ llm = LLM(
)

# Setup agent with bash tool
agent = Agent(llm=llm, tools=[Tool(name=BashTool.name)])
agent = Agent(llm=llm, tools=[Tool(name=TerminalTool.name)])


# Callback to display thinking blocks
Expand Down
4 changes: 2 additions & 2 deletions sdk/guides/llm-registry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ from openhands.sdk import (
get_logger,
)
from openhands.sdk.tool import Tool
from openhands.tools.execute_bash import BashTool
from openhands.tools.terminal import TerminalTool


logger = get_logger(__name__)
Expand Down Expand Up @@ -54,7 +54,7 @@ llm = llm_registry.get("agent")

# Tools
cwd = os.getcwd()
tools = [Tool(name=BashTool.name)]
tools = [Tool(name=TerminalTool.name)]

# Agent
agent = Agent(llm=llm, tools=tools)
Expand Down
8 changes: 4 additions & 4 deletions sdk/guides/mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ from openhands.sdk import (
)
from openhands.sdk.security.llm_analyzer import LLMSecurityAnalyzer
from openhands.sdk.tool import Tool
from openhands.tools.execute_bash import BashTool
from openhands.tools.file_editor import FileEditorTool
from openhands.tools.terminal import TerminalTool


logger = get_logger(__name__)
Expand All @@ -49,7 +49,7 @@ llm = LLM(

cwd = os.getcwd()
tools = [
Tool(name=BashTool.name),
Tool(name=TerminalTool.name),
Tool(name=FileEditorTool.name),
]

Expand Down Expand Up @@ -161,8 +161,8 @@ from openhands.sdk import (
get_logger,
)
from openhands.sdk.tool import Tool
from openhands.tools.execute_bash import BashTool
from openhands.tools.file_editor import FileEditorTool
from openhands.tools.terminal import TerminalTool


logger = get_logger(__name__)
Expand All @@ -182,7 +182,7 @@ llm = LLM(
cwd = os.getcwd()
tools = [
Tool(
name=BashTool.name,
name=TerminalTool.name,
),
Tool(name=FileEditorTool.name),
]
Expand Down
12 changes: 6 additions & 6 deletions sdk/guides/metrics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ from openhands.sdk import (
get_logger,
)
from openhands.sdk.tool import Tool
from openhands.tools.execute_bash import BashTool
from openhands.tools.file_editor import FileEditorTool
from openhands.tools.terminal import TerminalTool


logger = get_logger(__name__)
Expand All @@ -51,7 +51,7 @@ llm = LLM(

cwd = os.getcwd()
tools = [
Tool(name=BashTool.name),
Tool(name=TerminalTool.name),
Tool(name=FileEditorTool.name),
]

Expand Down Expand Up @@ -159,7 +159,7 @@ from openhands.sdk import (
get_logger,
)
from openhands.sdk.tool import Tool
from openhands.tools.execute_bash import BashTool
from openhands.tools.terminal import TerminalTool


logger = get_logger(__name__)
Expand Down Expand Up @@ -187,7 +187,7 @@ llm = llm_registry.get("agent")

# Tools
cwd = os.getcwd()
tools = [Tool(name=BashTool.name)]
tools = [Tool(name=TerminalTool.name)]

# Agent
agent = Agent(llm=llm, tools=tools)
Expand Down Expand Up @@ -276,7 +276,7 @@ from openhands.sdk import (
get_logger,
)
from openhands.sdk.tool.spec import Tool
from openhands.tools.execute_bash import BashTool
from openhands.tools.terminal import TerminalTool


logger = get_logger(__name__)
Expand Down Expand Up @@ -310,7 +310,7 @@ agent = Agent(
llm=llm,
tools=[
Tool(
name=BashTool.name,
name=TerminalTool.name,
),
],
condenser=condenser,
Expand Down
4 changes: 2 additions & 2 deletions sdk/guides/secrets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ from openhands.sdk import (
)
from openhands.sdk.conversation.secret_source import SecretSource
from openhands.sdk.tool import Tool
from openhands.tools.execute_bash import BashTool
from openhands.tools.file_editor import FileEditorTool
from openhands.tools.terminal import TerminalTool


# Configure LLM
Expand All @@ -39,7 +39,7 @@ llm = LLM(

# Tools
tools = [
Tool(name=BashTool.name),
Tool(name=TerminalTool.name),
Tool(name=FileEditorTool.name),
]

Expand Down
4 changes: 2 additions & 2 deletions sdk/guides/security.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -249,8 +249,8 @@ from openhands.sdk.conversation.state import (
from openhands.sdk.security.confirmation_policy import ConfirmRisky
from openhands.sdk.security.llm_analyzer import LLMSecurityAnalyzer
from openhands.sdk.tool import Tool
from openhands.tools.execute_bash import BashTool
from openhands.tools.file_editor import FileEditorTool
from openhands.tools.terminal import TerminalTool


# Clean ^C exit: no stack trace noise
Expand Down Expand Up @@ -337,7 +337,7 @@ llm = LLM(
# Tools
tools = [
Tool(
name=BashTool.name,
name=TerminalTool.name,
),
Tool(name=FileEditorTool.name),
]
Expand Down
Loading