OpenHands/README.windows.md

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.16.0 # x-release-please-version

$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 127.0.0.1:8000:8000 `
  -e AGENT_CANVAS_ALLOW_LAN_SESSION_KEY=true `
  -v "$($env:USERPROFILE)\.openhands:/home/openhands/.openhands" `
  -v "$($env:PROJECTS_PATH):/projects" `
  ghcr.io/openhands/agent-canvas:1.16.0 # x-release-please-version

Open http://localhost:8000/canvas in your browser.

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

The quickstart restricts the published port to host loopback before explicitly enabling session-key injection. If you publish the port on a LAN or public interface, omit AGENT_CANVAS_ALLOW_LAN_SESSION_KEY, set LOCAL_BACKEND_API_KEY to a strong value, and enter that value in the UI.