Browse by type
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.
Prerequisites:
PROJECTS_PATH containing the project folders you want the agent to access (create it before starting the container)[!NOTE] Docker Desktop for Windows handles bind-mount permissions transparently; no Linux
chmodcommands are needed for this PowerShell quickstart.
docker pull ghcr.io/openhands/agent-canvas:1.42.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.42.0 # x-release-please-version
Open http://localhost:8000/canvas in your browser.
[!NOTE] The entrypoint stops the container with exit code 1 when the Agent Server stops answering its
/alivecheck for about 30 seconds, so a crash or hang fails visibly instead of leaving a container that returns 502 for every request. Automatic recovery needs a restart policy: use--restart unless-stoppedinstead of--rm, orrestart: unless-stoppedin Docker Compose.
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.
For per-conversation containers, run Canvas inside a Linux distribution under WSL 2, with Docker Desktop's WSL integration enabled for that distribution. Install Node.js 24 or later and uv inside WSL, and confirm that docker info succeeds there.
Run the multiple-sandbox quickstart in the WSL shell, using workspace paths inside that Linux environment. The native Windows host is not supported by this runtime, which uses POSIX user/group IDs.
browse all types & interfaces →
$ claude mcp add OpenHands \
-- python -m otcore.mcp_server <graph>