OpenHands icon indicating copy to clipboard operation
OpenHands copied to clipboard

Get OpenHands UI working on Windows w/o WSL and Docker

Open neubig opened this issue 7 months ago • 3 comments

What problem or use case are you trying to solve?

Get the OpenHands UI working without WSL and docker on Windows, for use by users who want it to work in that environment.

Describe the UX or technical implementation you have in mind

It is possible to run the CLI and headless mode on Windows without WSL and Docker thanks to this PR: https://github.com/All-Hands-AI/OpenHands/pull/7410

However, there are no directions for running it with the UI. We should add some. Below is a draft created by OpenHands, and we can iterate on it.

windows-running.md

If you find this feature request or enhancement useful, make sure to add a 👍 to the issue

neubig avatar May 23 '25 12:05 neubig

@openhands

Open a draft PR with the current "windows-running.md" attached to this issue renamed to "windows-without-wsl.md" added to the appropriate place in the docs directory. In doing so, fix the following things:

  1. remove the mention of installing pre-commit hooks
  2. remove "Step 3: Configure OpenHands for Windows", since this shouldn't be necessary (it's not necessary in other setup directions)
  3. The poetry run python -m openhands.cli.main --local-runtime command is obviously wrong because we want to run the backend, not the CLI. Check the makefile to see how the backend is run. Do, however, make sure it runs with the local runtime.
  4. We probably need directions for installing npm, given that it's a requirement
  5. Remove the "Troubleshooting" part

neubig avatar May 23 '25 19:05 neubig

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

openhands-ai[bot] avatar May 23 '25 19:05 openhands-ai[bot]

I've successfully addressed issue #8656 by creating a draft PR with the requested changes. Here's a summary of what I did:

  1. Created a new file windows-without-wsl.md in the docs/modules/usage directory based on the attached file in the issue
  2. Made the following changes to the content as requested:
    • Removed the mention of installing pre-commit hooks
    • Removed "Step 3: Configure OpenHands for Windows" section
    • Updated the backend command to use the correct command from the Makefile with the local runtime flag: poetry run uvicorn openhands.server.listen:app --host 0.0.0.0 --port 3000 --reload --reload-exclude "./workspace" --local-runtime
    • Added directions for installing npm in the prerequisites section
    • Removed the "Troubleshooting" section
  3. Updated the main installation.mdx file to reference the new guide in two places:
    • Added a bullet point in the System Requirements section
    • Added an "Alternative: Windows without WSL" note in the Windows section
  4. Created a branch, committed the changes, and pushed them to the remote
  5. Created a draft PR (#8674) that fixes issue #8656

The PR is available at: https://github.com/All-Hands-AI/OpenHands/pull/8674

openhands-ai[bot] avatar May 23 '25 19:05 openhands-ai[bot]