github/OpenHands
1
1
Fork 0
mirror of https://github.com/All-Hands-AI/OpenHands.git synced 2026-01-09 14:57:59 -05:00
Code Issues Packages Projects Releases Wiki Activity

Document native windows support without WSL (#8567)

Browse Source 
Co-authored-by: mamoodi <mamoodiha@gmail.com>
This commit is contained in:
Boxuan Li
2025-05-20 13:54:32 -07:00
committed by GitHub
parent 0deabd5935
commit 005c5d6bde
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/modules/usage/runtimes/local.md
View File

@@ -13,14 +13,16 @@ files on your machine. Only use this runtime in controlled environments or when
Before using the Local Runtime, ensure that:
1. You can run OpenHands using the [Development workflow](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md).
2. tmux is available on your system.
2. For Linux and Mac, tmux is available on your system.
3. For Windows, PowerShell is available on your system.
- Only [CLI mode](../how-to/cli-mode) and [headless mode](../how-to/headless-mode) are supported in Windows with Local Runtime.
## Configuration
To use the Local Runtime, besides required configurations like the LLM provider, model and API key, you'll need to set
the following options via environment variables or the [config.toml file](https://github.com/All-Hands-AI/OpenHands/blob/main/config.template.toml) when starting OpenHands:
Via environment variables:
Via environment variables (please use PowerShell syntax for Windows PowerShell):
```bash
# Required
@@ -65,4 +67,4 @@ The Local Runtime is particularly useful for:
- CI/CD pipelines where Docker is not available.
- Testing and development of OpenHands itself.
- Environments where container usage is restricted.
- Environments where container usage is restricted (e.g. native Windows).