https://docs.all-hands.dev/ logo
Join Slack
Powered by
<@U07TE39J96U> or anybody else -- I have a custome...
# proj-cli
c
@quick-window-91705 or anybody else -- I have a customer that recently attempted to install on windows via:
Copy code
uv tool install openhands --python 3.12
Customer indicates:
Copy code
That is what I used...but the executable size of openhands.exe in .local/bin is only 46KB
And windows says, it can't run the file
Any Windows users out there have seen this or have advice about next steps? I can get a Windows VM spun up to try it myself but thought I'd check if there is a quick fix.
q
Haven't seen this exact issue before I know we don't support running on native windows today because of our agent sdk We do support windows wsl
ty 1
c
@elegant-branch-54423 FYI this also means that WSL is required for Windows users that want to run our IDE integrations. May have been obvious to you but I am just now learning this.
e
Sorry, this is not a part of the product I am greatly familiar with.
Do we have a docs gap on this? If so maybe someone can create a PR?
@nutritious-balloon-65098 please investigate the OpenHands docs. Do we document that WSL is required for OpenHands CLI, and thus by extension, any integrations using OpenHands ACP
q
regarding windows support in sdk
n
I'm on it! Joe Pelletier can track my progress here.
## Summary: Documentation Gap Investigation I investigated the OpenHands documentation to determine if WSL is documented as a requirement for Windows users running the OpenHands CLI and IDE integrations (ACP). ### Answer: There is a documentation gap Yes, there is a documentation gap. While WSL requirements are mentioned in some places, the CLI installation and IDE integration pages are missing this critical information. ### Where WSL IS documented: - ✅ Troubleshooting page - Has a tip stating "OpenHands only supports Windows via WSL" - ✅ Local Setup (GUI) page - Lists WSL as a Windows requirement with setup instructions - ✅ Windows Without WSL page - Exists as a community-maintained guide, but is not in the navigation (orphan page) ### Where WSL is NOT documented (gaps): - ❌ CLI Installation page (
/openhands/usage/cli/installation.mdx
) - No mention of WSL requirement - ❌ CLI Quick Start page - No Windows guidance - ❌ IDE Integration Overview (
/openhands/usage/cli/ide/overview.mdx
) - No WSL requirement mentioned - ❌ Individual IDE pages (VS Code, JetBrains, Zed) - No Windows guidance ### Impact on Customer Issue: The customer who tried 
uv tool install openhands --python 3.12
on native Windows would not have found any warning in the CLI installation docs that this won't work. The 46KB non-functional executable they received is consistent with this gap. ### Recommended Fix: Add WSL requirement notices to: 1. CLI Installation page (highest priority) 2. IDE Integration Overview page 3. Consider adding 
windows-without-wsl.mdx
to the navigation as an alternative path --- No code changes were made - this was an investigation only. Would you like me to create a PR to address these documentation gaps?
e
@nutritious-balloon-65098 can you make a PR with your recommendations
n
I'm on it! Joe Pelletier can continue tracking my progress here.
e
JM, I realize this isn't a "fix" but trying to correct for the knowledge gap.
🙏 1
👌 1
n
## Summary I investigated the OpenHands documentation for WSL requirements and found a significant documentation gap. I then created and pushed a PR to address it. ### Investigation Findings - Documented in some places: The troubleshooting page and local GUI setup page mention WSL, but... - Missing from CLI docs: The CLI installation, quick-start, and IDE integration pages had no mention that WSL is required for Windows users - Orphaned page: The 
windows-without-wsl.mdx
community guide existed but wasn't in the navigation ### Changes Made (PR #356) | File | Change | |------|--------| | 
openhands/usage/cli/installation.mdx
| Added 
<Warning>
about WSL requirement with links to install WSL and to the community alternative | | 
openhands/usage/cli/ide/overview.mdx
| Added 
<Warning>
that IDE integrations require CLI which requires WSL | | 
openhands/usage/cli/quick-start.mdx
| Added brief 
<Note>
pointing to installation page | | 
docs.json
| Added 
windows-without-wsl
page to navigation | ### Checklist - ✅ Addressed the documentation gap for CLI installation - ✅ Addressed the documentation gap for IDE integrations (which use 
openhands acp
) - ✅ Made the community Windows guide discoverable in navigation - ✅ Changes are concise (13 lines added across 4 files) - ✅ Already pushed to 
docs/windows-wsl-requirements
branch - ✅ PR created: https://github.com/OpenHands/docs/pull/356 The PR directly addresses the customer issue where they tried 
uv tool install openhands --python 3.12
on native Windows and got a non-functional 46KB executable. With these changes, Windows users will see clear warnings before attempting installation.
c
I looked at this in staging and approved the PR. Thanks!
🙏 1
e
Haha thanks! Was just gonna ask for a review
c
Once you are happy and merge I'll let the customer know we have addressed the gap in the docs. Thanks for jumping on that!
e
Merged
c
The native windows page is from V0, and then too, I’m not sure it worked except on a single runtime or so
It's great to see us document WSL as requirement, thank you! I think it’s better until we actually have native working and tested
c
@calm-artist-7206 should we remove the reference to Windows Without WSL from the docs page?
c
2 Views
Open in Slack
PreviousNext
Powered by