Rename execute_bash to terminal & rename BashTool to TerminalTool (#1033)

Co-authored-by: Xingyao Wang <xingyao@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>

Author: 3 people

.github/prompts/update-documentation.md

@@ -36,7 +36,7 @@ Review these key files for accuracy:
 
 - Keep mermaid diagrams SIMPLE and READABLE across all docs/architecture/ files
 - Focus on core components and relationships, not every possible class
-- Include all current runtime tools: BashTool, FileEditorTool, TaskTrackerTool, etc.
+- Include all current runtime tools: TerminalTool, FileEditorTool, TaskTrackerTool, etc.
 - Verify component interactions and inheritance reflect actual codebase structure
 
 #### Tool Documentation
@@ -56,7 +56,7 @@ Verify documentation across docs/architecture/ files for:
 - `LLM`, message types, provider support (docs/architecture/llm.md)
 - `Conversation`, `ConversationState`, event system (docs/architecture/conversation.md)
 - All built-in tools: `FinishTool`, `ThinkTool`
-- All runtime tools: `BashTool`, `FileEditorTool`, `TaskTrackerTool`
+- All runtime tools: `TerminalTool`, `FileEditorTool`, `TaskTrackerTool`
 
 ### 4. Verification Steps
 

examples/01_standalone_sdk/01_hello_world.py

@@ -1,9 +1,9 @@
 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(
@@ -14,7 +14,7 @@
 agent = Agent(
     llm=llm,
     tools=[
-        Tool(name=BashTool.name),
+        Tool(name=TerminalTool.name),
         Tool(name=FileEditorTool.name),
         Tool(name=TaskTrackerTool.name),
     ],

examples/01_standalone_sdk/02_custom_tools.py

@@ -24,12 +24,12 @@
     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__)
@@ -168,11 +168,11 @@ def create(
 
 
 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]

examples/01_standalone_sdk/03_activate_skill.py

@@ -16,8 +16,8 @@
     Skill,
 )
 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__)
@@ -38,7 +38,7 @@
 cwd = os.getcwd()
 tools = [
     Tool(
-        name=BashTool.name,
+        name=TerminalTool.name,
     ),
     Tool(name=FileEditorTool.name),
 ]

examples/01_standalone_sdk/05_use_llm_registry.py

@@ -14,7 +14,7 @@
     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__)
@@ -42,7 +42,7 @@
 
 # Tools
 cwd = os.getcwd()
-tools = [Tool(name=BashTool.name)]
+tools = [Tool(name=TerminalTool.name)]
 
 # Agent
 agent = Agent(llm=llm, tools=tools)

examples/01_standalone_sdk/06_interactive_terminal_w_reasoning.py

@@ -11,7 +11,7 @@
     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__)
@@ -32,7 +32,7 @@
 cwd = os.getcwd()
 tools = [
     Tool(
-        name=BashTool.name,
+        name=TerminalTool.name,
         params={"no_change_timeout_seconds": 3},
     )
 ]

examples/01_standalone_sdk/07_mcp_integration.py

@@ -12,8 +12,8 @@
 )
 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__)
@@ -32,7 +32,7 @@
 
 cwd = os.getcwd()
 tools = [
-    Tool(name=BashTool.name),
+    Tool(name=TerminalTool.name),
     Tool(name=FileEditorTool.name),
 ]
 

examples/01_standalone_sdk/08_mcp_with_oauth.py

@@ -11,8 +11,8 @@
     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__)
@@ -32,7 +32,7 @@
 cwd = os.getcwd()
 tools = [
     Tool(
-        name=BashTool.name,
+        name=TerminalTool.name,
     ),
     Tool(name=FileEditorTool.name),
 ]

examples/01_standalone_sdk/09_pause_example.py

@@ -10,8 +10,8 @@
     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
@@ -29,7 +29,7 @@
 # Tools
 tools = [
     Tool(
-        name=BashTool.name,
+        name=TerminalTool.name,
     ),
     Tool(name=FileEditorTool.name),
 ]

examples/01_standalone_sdk/10_persistence.py

@@ -12,8 +12,8 @@
     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__)
@@ -33,7 +33,7 @@
 # Tools
 cwd = os.getcwd()
 tools = [
-    Tool(name=BashTool.name),
+    Tool(name=TerminalTool.name),
     Tool(name=FileEditorTool.name),
 ]