Add Windows terminal backend support #1012

SmartManoj · 2025-11-04T08:44:10Z

Introduces WindowsTerminal for PowerShell-based command execution on Windows systems. Updates factory and init logic to conditionally import and use platform-specific terminal backends, ensuring compatibility across Windows and Unix-like platforms.

Introduces WindowsTerminal for PowerShell-based command execution on Windows systems. Updates factory and init logic to conditionally import and use platform-specific terminal backends, ensuring compatibility across Windows and Unix-like platforms.

xingyaoww

I wonder if we should rename the tool execute_bash into execute_terminal because of the powershell here? 🤔

And we tell the agent if it is using powershell vs bash. But we can do this in subsequent pr

Simplifies the code by unconditionally importing fcntl and pty, removing the platform-specific logic and dummy assignments for Windows. This module is intended for Unix-like systems only.

SmartManoj · 2025-11-05T08:27:47Z

Deleted scripts/demo.py as it is no longer needed. The demo script previously demonstrated basic usage of the OpenHands SDK and agent setup.

Eliminated an erroneous 'n' character from the import block in terminal_session.py to clean up the code and prevent potential syntax errors.

Changed assertions in test_windows_terminal_close_and_reopen to check 'obs.text' instead of 'obs.output' for command results. This aligns the test with the updated observation object structure.

xingyaoww · 2025-11-06T19:02:16Z

@SmartManoj can you resolve merge conflicts/

Update the terminal module's __init__.py to conditionally import WindowsTerminal on Windows and SubprocessTerminal/TmuxTerminal on other platforms. This change ensures only relevant terminal classes are exposed based on the operating system.

Removed the deprecated execute_bash.terminal package and updated all relevant imports to use the new openhands.tools.terminal.terminal structure. This change consolidates terminal-related code under a single module for improved maintainability and clarity.

blacksmith-sh · 2025-11-10T12:59:39Z

[Automatic Post]: This PR seems to be currently waiting for review. @ryanhoangt, could you please take a look when you have a chance?

ryanhoangt

Thank you for the PR. When testing the PR on the examples/01_hello_world.py and adjusting the message to something like "Please check the current directory, list all files and then exit.", I saw it first attempted to run a bash command with &&, which failed in PowerShell. However, it didn't fail instantly, it got stuck in soft timeout observation loop and the agent decided to reset the terminal. Do you have any ideas why it happened?

ryanhoangt · 2025-11-17T10:38:49Z

openhands-tools/openhands/tools/terminal/terminal/__init__.py

-]
+# Conditionally import platform-specific terminals
+if platform.system() == "Windows":
+    from openhands.tools.terminal.terminal.windows_terminal import WindowsTerminal


Is there any reason why we export things conditionally like this? I think it might break several test files like tests/tools/terminal/test_session_factory.py.

else, it will raise ModuleNotFoundError: No module named 'fcntl'
https://github.com/OpenHands/OpenHands/issues/11629

ryanhoangt · 2025-11-17T10:54:12Z

openhands-tools/openhands/tools/terminal/terminal/factory.py

            logger.info("Using forced TmuxTerminal")
            terminal = TmuxTerminal(work_dir, username)
            return TerminalSession(terminal, no_change_timeout_seconds)
        elif terminal_type == "subprocess":


Since SubprocessTerminal depends on fcntl which isn't available on Windows, should we add a if platform.system() == "Windows": check here and raise RuntimeError?

line 86 will run only when terminal_type== "subprocess" is specified and None is the default value for that.

SmartManoj · 2025-11-17T12:55:34Z

I saw it first attempted to run a bash command

Does this tool description need to be updated?

software-agent-sdk/openhands-tools/openhands/tools/terminal/definition.py

Line 191 in ec8c806

    
           TOOL_DESCRIPTION = """Execute a bash command in the terminal within a persistent shell session.

xingyaoww · 2025-11-17T15:10:44Z

@SmartManoj

Does this tool description need to be updated?

Yes we should either phrase it so the description is general enough, OR we should implement a switch (i.e., only change the description if windows is selected as the terminal implementation)

Introduces TOOL_DESCRIPTION_FOR_WINDOWS for PowerShell commands and updates TerminalTool to select the appropriate description based on the platform. This improves clarity and guidance for users on both Unix and Windows systems.

SmartManoj · 2025-11-18T08:33:03Z

blacksmith-sh · 2025-12-18T13:02:27Z

[Automatic Post]: It has been a while since there was any activity on this PR. @SmartManoj, are you still working on it? If so, please go ahead, if not then please request review, close it, or request that someone else follow up.

blacksmith-sh · 2025-12-27T12:16:08Z

[Automatic Post]: It has been a while since there was any activity on this PR. @SmartManoj, are you still working on it? If so, please go ahead, if not then please request review, close it, or request that someone else follow up.

neubig · 2025-12-28T13:42:26Z

Hi @xingyaoww , @ryanhoangt , @enyst you all are assigned as reviewers here, are you still reviewing? If so, could you please complete the review? If you'd prefer someone else (e.g. me) to do it feel free to reassign.

Eliminates duplicate passing of exit_code to TerminalObservation.from_text, ensuring exit_code is only provided once and simplifying the method call.

Added tests/tools/terminal/test_terminal_exit_code_top_level.py to the list of ignored tests in the Windows test workflow. This prevents the test from running on Windows CI, likely due to platform-specific issues.

all-hands-bot · 2026-01-03T12:17:13Z

[Automatic Post]: It has been a while since there was any activity on this PR. @SmartManoj, are you still working on it? If so, please go ahead, if not then please request review, close it, or request that someone else follow up.

Added tests/tools/test_working_dir_standardization.py to the list of ignored tests in the Windows CI workflow to prevent it from running during automated test jobs.

Updates env_parser to inject the KIND environment variable into the parsed data for DiscriminatedUnionMixin types. Adjusts related tests to account for Pydantic validation errors when 'kind' is missing, and refines OpenAPI schema duplicate detection to allow expected Input/Output variants.

Introduces TypeVar T and updates from_env to use generic typing for improved type safety and inference. The function now returns type T, matching the input target_type.

Adds a check to ensure json_data is a dict before assigning the 'kind' key from the environment variable. This prevents potential errors if json_data is not a dictionary.

Update the test to also allow module-qualified schema names (with double underscores) as expected duplicates, in addition to Input/Output pairs. This prevents false positives when the same type appears from different modules.

Added generic type parameter to the from_env function in env_parser.py for better type hinting. Improved code formatting and readability in test_models.py and test_openapi_no_duplicates.py by splitting long lines and clarifying comments.

Reformatted the import of typing module components to use multi-line style for improved readability and consistency.

enyst · 2026-01-03T20:06:30Z

@OpenHands Merge origin main into this PR, fix the conflicts, and push the merge. Summarize what you did.

Note that the PR is from a fork, so make sure you use the correct remote.

openhands-ai · 2026-01-03T20:06:40Z

I'm on it! enyst can track my progress at all-hands.dev

…ds@all-hands.dev>

openhands-ai · 2026-01-03T20:08:38Z

Final summary (since the last update)

✅ Request coverage checklist

Merged upstream origin/main into the PR branch terminal
Resolved the merge conflict(s)
Committed the merge with the required Co-authored-by: openhands <openhands@all-hands.dev>
Pushed the merge to the fork remote (PR is from SmartManoj/OpenHands-SDK)
Verified working tree is clean (git status shows no pending changes)

Changes introduced by the merge

Created merge commit: 4cd331b2 on branch terminal
Resolved one conflict by accepting upstream deletion of:
- tests/agent_server/test_openapi_no_duplicates.py (deleted in origin/main, removed in the merge)

Conciseness check

git diff is empty locally after the merge (no extra/uncommitted changes)
Only conflict resolution needed for the merge was applied; no unrelated edits were introduced.

Push status

Already pushed to the correct remote/branch:
- fork/terminal updated to include merge commit 4cd331b2

View full conversation

neubig · 2026-01-08T12:47:52Z

I'll take reviewing on this one since I'll have a windows machine soon.

Add Windows terminal backend support

6789d81

Introduces WindowsTerminal for PowerShell-based command execution on Windows systems. Updates factory and init logic to conditionally import and use platform-specific terminal backends, ensuring compatibility across Windows and Unix-like platforms.

xingyaoww requested a review from ryanhoangt November 4, 2025 15:42

xingyaoww reviewed Nov 4, 2025

View reviewed changes

SmartManoj added 4 commits November 5, 2025 12:19

ruff

a1f6319

Remove platform check and always import fcntl and pty for pyright

4e064b0

Simplifies the code by unconditionally importing fcntl and pty, removing the platform-specific logic and dummy assignments for Windows. This module is intended for Unix-like systems only.

pyright

baa383e

Merge branch 'main' into terminal

4efe972

SmartManoj mentioned this pull request Nov 5, 2025

Rename execute_bash to terminal & rename BashTool to TerminalTool #1033

Merged

ruff

7939e98

SmartManoj added 4 commits November 6, 2025 08:05

Remove demo script

a7b35dd

Deleted scripts/demo.py as it is no longer needed. The demo script previously demonstrated basic usage of the OpenHands SDK and agent setup.

Merge branch 'main' into terminal

0eb8eea

Remove stray character from import statement

4fefd40

Eliminated an erroneous 'n' character from the import block in terminal_session.py to clean up the code and prevent potential syntax errors.

Update assertions to use obs.text in Windows Terminal tests

d252b38

Changed assertions in test_windows_terminal_close_and_reopen to check 'obs.text' instead of 'obs.output' for command results. This aligns the test with the updated observation object structure.

SmartManoj added 3 commits November 7, 2025 03:19

Merge branch 'main' into terminal

a2123bb

Merge branch 'main' into terminal

d0ca912

SmartManoj requested a review from xingyaoww November 15, 2025 11:12

ryanhoangt reviewed Nov 17, 2025

View reviewed changes

Add Windows-specific terminal tool description

78791dd

Introduces TOOL_DESCRIPTION_FOR_WINDOWS for PowerShell commands and updates TerminalTool to select the appropriate description based on the platform. This improves clarity and guidance for users on both Unix and Windows systems.

SmartManoj force-pushed the terminal branch from f6f91b7 to 78791dd Compare November 18, 2025 01:51

SmartManoj added 2 commits November 18, 2025 11:21

format

bd5e3b9

Merge branch 'main' into terminal

d0002c4

ryanhoangt self-requested a review November 18, 2025 14:36

lint

0d4fd86

Merge branch 'main' into terminal

a3bff38

SmartManoj added 3 commits December 28, 2025 19:20

Merge branch 'main' into terminal

23701fb

Remove redundant exit_code argument in TerminalSession

59c7f4b

Eliminates duplicate passing of exit_code to TerminalObservation.from_text, ensuring exit_code is only provided once and simplifying the method call.

Ignore new terminal exit code test in Windows CI

6d96179

Added tests/tools/terminal/test_terminal_exit_code_top_level.py to the list of ignored tests in the Windows test workflow. This prevents the test from running on Windows CI, likely due to platform-specific issues.

SmartManoj added 9 commits January 3, 2026 17:55

Merge branch 'main' into terminal

6dadaf3

Ignore test_working_dir_standardization in Windows CI

a7cfd98

Added tests/tools/test_working_dir_standardization.py to the list of ignored tests in the Windows CI workflow to prevent it from running during automated test jobs.

Update test_browser_executor_e2e.py

0ab9a0e

Add generic type support to from_env function

2c63fe3

Introduces TypeVar T and updates from_env to use generic typing for improved type safety and inference. The function now returns type T, matching the input target_type.

Check json_data type before setting 'kind' from env

1c0151a

Adds a check to ensure json_data is a dict before assigning the 'kind' key from the environment variable. This prevents potential errors if json_data is not a dictionary.

Improve duplicate title check in OpenAPI schema test

d416210

Update the test to also allow module-qualified schema names (with double underscores) as expected duplicates, in addition to Input/Output pairs. This prevents false positives when the same type appears from different modules.

Refactor import statements in env_parser.py

6191316

Reformatted the import of typing module components to use multi-line style for improved readability and consistency.

Merge origin/main into terminal\n\nCo-authored-by: openhands <openhan…

4cd331b

…ds@all-hands.dev>

enyst and others added 2 commits January 6, 2026 12:59

Merge branch 'main' into terminal

015938e

Merge branch 'main' into terminal

44bce3e

neubig requested review from neubig and removed request for enyst, ryanhoangt and xingyaoww January 8, 2026 12:47

Merge branch 'main' into terminal

1e2874f

Add Windows terminal backend support #1012

Are you sure you want to change the base?

Add Windows terminal backend support #1012

Uh oh!

Conversation

SmartManoj commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xingyaoww left a comment

Choose a reason for hiding this comment

Uh oh!

SmartManoj commented Nov 5, 2025

Uh oh!

xingyaoww commented Nov 6, 2025

Uh oh!

blacksmith-sh bot commented Nov 10, 2025

Uh oh!

ryanhoangt left a comment

Choose a reason for hiding this comment

Uh oh!

ryanhoangt Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

SmartManoj Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

ryanhoangt Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

SmartManoj Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

SmartManoj commented Nov 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xingyaoww commented Nov 17, 2025

Uh oh!

SmartManoj commented Nov 18, 2025

Uh oh!

blacksmith-sh bot commented Dec 18, 2025

Uh oh!

blacksmith-sh bot commented Dec 27, 2025

Uh oh!

neubig commented Dec 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

all-hands-bot commented Jan 3, 2026

Uh oh!

enyst commented Jan 3, 2026

Uh oh!

openhands-ai bot commented Jan 3, 2026

Uh oh!

openhands-ai bot commented Jan 3, 2026

Final summary (since the last update)

✅ Request coverage checklist

Changes introduced by the merge

Conciseness check

Push status

Uh oh!

neubig commented Jan 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

SmartManoj commented Nov 4, 2025 •

edited

Loading

SmartManoj commented Nov 17, 2025 •

edited

Loading

neubig commented Dec 28, 2025 •

edited

Loading