-
Notifications
You must be signed in to change notification settings - Fork 6.3k
Add Windows without WSL installation guide #8674
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
In the uvicorn call, this is not the correct way to specify the local runtime, please check and fix. |
I'm on it! neubig can track my progress at all-hands.dev |
I've fixed the issue with the incorrect way to specify the local runtime in the Windows without WSL documentation. The problem was that the documentation was using a direct uvicorn command with a I've updated the command to use the proper CLI interface: poetry run python -m openhands.cli.main --runtime local --host 0.0.0.0 --port 3000 This is the correct way to specify the local runtime in OpenHands, as it uses the official CLI interface with the The changes have been committed and pushed to the branch |
… Windows setup guide
…ws-specific handling
@OpenHands update the PR description to reflect the actual content of the PR |
I'm on it! neubig can track my progress at all-hands.dev |
This is ready for review. @li-boxuan if you'd be interested in taking a look at this, this allows for running the frontend in Windows with the local runtime. It's still a little bit fragile, but it runs. |
I successfully updated the PR description for PR #8674 to accurately reflect the actual content of the PR. The original PR description was outdated and didn't properly describe all the changes made in the PR. Based on my analysis of the code changes, commit history, and PR comments, I created a more comprehensive and accurate description that:
The PR description now accurately reflects all the changes made in the PR, making it easier for reviewers to understand the purpose and scope of the changes. |
1. **Windows 10/11** - A modern Windows operating system | ||
2. **PowerShell 7+** - While Windows PowerShell comes pre-installed on Windows 10/11, PowerShell 7+ is strongly recommended to avoid compatibility issues (see Troubleshooting section for "System.Management.Automation" errors) | ||
3. **.NET Core Runtime** - Required for the PowerShell integration via pythonnet | ||
4. **Python 3.12** - Python 3.12 is required (Python 3.14 is not supported due to pythonnet compatibility) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@OpenHands Both python 3.12 and 3.13 are supported
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm on it! li-boxuan can track my progress at all-hands.dev
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've successfully addressed the PR comment that requested adding Python 3.13 support to the Windows documentation. Here's a summary of the changes made:
-
Updated line 10 in
docs/modules/usage/windows-without-wsl.md
to indicate that both Python 3.12 and 3.13 are supported (changed from "Python 3.12" to "Python 3.12 or 3.13"). -
Updated the installation instructions section to reflect that users can install either Python 3.12.x or 3.13.x (changed from only mentioning Python 3.12.x).
-
Committed these changes with the message "Update Windows docs to include Python 3.13 support".
-
Successfully pushed the changes to the remote branch
openhands/windows-without-wsl-docs
.
The PR has been updated with these changes, which directly address the comment requesting that both Python 3.12 and 3.13 be listed as supported versions. The documentation now correctly indicates that either version can be used when running OpenHands on Windows without WSL.
I got this error on windows:
|
I'm on it! li-boxuan can track my progress at all-hands.dev |
I've successfully addressed the issue reported in the PR comment by adding a new troubleshooting section to the Windows installation guide. Summary of Changes
The changes have been successfully pushed to the remote branch, and the PR has been updated with the new troubleshooting information that should help users resolve the specific error mentioned in the comment. |
UI is breaking with Error: import { jsDEV} from "react/jsx-dev-runtime"; |
Hey @li-boxuan , would you like me to take a look at this? |
This is resolved |
@neubig I can take a look at it tonight |
Great, thanks |
…or on Windows" This reverts commit 0aa44c2.
This reverts commit 693c738.
When I run the app on windows, I notice this patch is auto-generated:
In addition, I see error logs related to MCP:
|
I'm on it! li-boxuan can track my progress at all-hands.dev |
I've addressed the issue mentioned in the PR comment for the Windows without WSL documentation PR #8674. Issue SummaryWhen running OpenHands on Windows, the user noticed that the MCP configuration file was being auto-generated with a specific configuration, and they were seeing validation errors related to MCP:
Root CauseThe issue was in the MCP configuration file at {
"default": []
} When running on Windows, the application was trying to use this configuration but needed a proper server configuration with tools defined. SolutionI updated the MCP configuration file to include the "fetch" tool that was being auto-generated on Windows: {
"default": [{"name": "fetch", "command": "uvx", "args": ["mcp-server-fetch"], "env": {}}]
} This change provides a valid server configuration for the MCP router, which should resolve the validation errors by ensuring the required "tools" field is present in the ListToolsResult. Changes Made
The PR should now work correctly on Windows without the MCP validation errors. |
Windows Without WSL Support
This PR adds support for running OpenHands on Windows without WSL or Docker, making it more accessible to Windows users who prefer not to use virtualization.
Changes Made
Documentation
docs/modules/usage/windows-without-wsl.md
with detailed instructions for installing and running OpenHands on Windows without WSLWindows Compatibility Improvements
pylcs
dependency withrapidfuzz
for better Windows compatibilitypylcs
is a C++ extension that doesn't work properly on Windows with Python 3.12chunk_localizer.py
to userapidfuzz.distance.LCSseq
instead ofpylcs
runtime/base.py
$env:VAR=value
)Command Fixes
These changes ensure that OpenHands can run on Windows without WSL or Docker, providing a native Windows experience while maintaining compatibility with the existing codebase.
Fixes #8656
To run this PR locally, use the following command: