Files
OpenHands/README.windows.md
T
dbc3abfed3 docs: clarify README install option requirements (#945)
* Clarify README install option requirements
* docs: add Windows PowerShell syntax for Docker sandbox option

Split Option 2 into Linux/Mac and Windows (PowerShell) code blocks to address
cross-platform shell syntax differences. The original Unix-style export syntax
doesn't work on Windows CMD or PowerShell.

* docs: refine install commands across platforms
* docs: move Windows PowerShell instructions to separate README

---------

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: chuckbutkus <chuck@openhands.dev>
Co-authored-by: enyst <engel.nyst@gmail.com>
2026-06-02 20:01:25 +02:00

1012 B

Windows quickstart (PowerShell)

This doc contains Windows-specific command syntax for running Agent Canvas with the Docker sandbox.

For the main install options and overall context, see README.md.

Option 2: With a Docker Sandbox (Windows)

Prerequisites:

  • Docker Desktop for Windows
  • A host directory for PROJECTS_PATH containing the project folders you want the agent to access (create it before starting the container)
docker pull ghcr.io/openhands/agent-canvas:1.0.0-alpha.10

$env:PROJECTS_PATH = Join-Path $HOME "projects"  # directory containing your project folders
New-Item -ItemType Directory -Force -Path $env:PROJECTS_PATH, (Join-Path $env:USERPROFILE ".openhands") | Out-Null

docker run -it --rm `
  -p 8000:8000 `
  -v "$($env:USERPROFILE)\.openhands:/home/openhands/.openhands" `
  -v "$($env:PROJECTS_PATH):/projects" `
  ghcr.io/openhands/agent-canvas:1.0.0-alpha.10

The agent will be able to access any project under PROJECTS_PATH.