Skip to content

Add Windows 11 setup video link to local setup documentation #389

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.

Sign up for GitHub

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

Merged
jamiechicago312 merged 9 commits into from
Mar 10, 2026
Merged

Add Windows 11 setup video link to local setup documentation #389

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
40709be
Add Windows 11 setup video link to local setup documentation
openhands-agent Mar 10, 2026
5223c7e
Apply suggestion from @jamiechicago312
jamiechicago312 Mar 10, 2026
bf21001
Reorganize Windows section: video link at top for easy access
openhands-agent Mar 10, 2026
21e2b7b
Merge branch 'main' into openhands/add-windows-11-video
jamiechicago312 Mar 10, 2026
fb3a73c
Add OS-specific prerequisites to CLI installation docs
openhands-agent Mar 10, 2026
df7ce66
Apply suggestions from code review
jamiechicago312 Mar 10, 2026
3948d09
Update installation.mdx
jamiechicago312 Mar 10, 2026
a80e015
Update installation.mdx
jamiechicago312 Mar 10, 2026
48a2af6
Update openhands/usage/run-openhands/local-setup.mdx
jamiechicago312 Mar 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions openhands/usage/cli/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@ title: Installation
description: Install the OpenHands CLI on your system
---

<Warning>
**Windows Users:** The OpenHands CLI requires WSL (Windows Subsystem for Linux). Native Windows is not officially supported. Please [install WSL](https://learn.microsoft.com/en-us/windows/wsl/install) first, then run all commands inside your WSL terminal.
</Warning>
<Note>
**Windows users:** All commands below should be run inside the WSL terminal (Ubuntu). Use `wsl -d Ubuntu` in PowerShell or search "Ubuntu" in the Start menu to access the Ubuntu terminal. We also have a [step-by-step video tutorial](https://youtu.be/Kp40Qqz4ZPw) available.
</Note>


## Installation Methods

Expand Down
7 changes: 5 additions & 2 deletions openhands/usage/run-openhands/local-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
description: Getting started with running OpenHands on your own.
---

## Recommended Methods for Running Openhands on Your Local System
## Recommended Methods for Running OpenHands on Your Local System

### System Requirements

Expand Down Expand Up @@ -39,10 +39,13 @@

<Accordion title="Windows">

<Note>
Looking for a video guide? Check out this [step-by-step Windows setup tutorial](https://youtu.be/Kp40Qqz4ZPw).
</Note>
**WSL**

1. [Install WSL](https://learn.microsoft.com/en-us/windows/wsl/install).
2. Run `wsl --version` in powershell and confirm `Default Version: 2`.
2. Run `wsl --version` in PowerShell and confirm `Default Version: 2`.

**Ubuntu (Linux Distribution)**

Expand All @@ -68,11 +71,11 @@

### Start the App

#### Option 1: Using the CLI Launcher with uv (Recommended)

Check warning on line 74 in openhands/usage/run-openhands/local-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/run-openhands/local-setup.mdx#L74 

Did you really mean 'uv'?

We recommend using [uv](https://docs.astral.sh/uv/) for the best OpenHands experience. uv provides better isolation from your current project's virtual environment and is required for OpenHands' default MCP servers (like the [fetch MCP server](https://github.com/modelcontextprotocol/servers/tree/main/src/fetch)).

Check warning on line 76 in openhands/usage/run-openhands/local-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/run-openhands/local-setup.mdx#L76 

Did you really mean 'uv'?

**Install uv** (if you haven't already):

Check warning on line 78 in openhands/usage/run-openhands/local-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/run-openhands/local-setup.mdx#L78 

Did you really mean 'uv'?

See the [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/) for the latest installation instructions for your platform.

Expand Down Expand Up @@ -161,7 +164,7 @@
2. Go to the Settings page and navigate to the `API Keys` tab.
3. Copy your `LLM API Key`.

OpenHands provides access to state-of-the-art agentic coding models with competitive pricing. [Learn more about OpenHands LLM provider](/openhands/usage/llms/openhands-llms).

Check warning on line 167 in openhands/usage/run-openhands/local-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/run-openhands/local-setup.mdx#L167 

Did you really mean 'agentic'?

</Accordion>

Expand Down Expand Up @@ -213,8 +216,8 @@

To enable search functionality in OpenHands:

1. Get a Tavily API key from [tavily.com](https://tavily.com/).

Check warning on line 219 in openhands/usage/run-openhands/local-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/run-openhands/local-setup.mdx#L219 

Did you really mean 'Tavily'?
2. Enter the Tavily API key in the Settings page under `LLM` tab > `Search API Key (Tavily)`

Check warning on line 220 in openhands/usage/run-openhands/local-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/run-openhands/local-setup.mdx#L220 

Did you really mean 'Tavily'?

For more details, see the [Search Engine Setup](/openhands/usage/advanced/search-engine-setup) guide.

Expand Down
Loading