MCPcopy Create free account
hub / github.com/OpenHands/OpenHands

github.com/OpenHands/OpenHands

Chat with this repo
repository ↗ · DeepWiki ↗ · release v1.42.0 ↗ · + Follow · compare 28 versions
8,102 symbols 28,782 edges 2,462 files 588 documented · 7% ● updated 44d agov1.24.0 · 2026-09-25★ 90,009526 open issues

Browse by type

⨍ Functions 6,701◇ Types & classes 1,401
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

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)

[!NOTE] Docker Desktop for Windows handles bind-mount permissions transparently; no Linux chmod commands 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 /alive check 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-stopped instead of --rm, or restart: unless-stopped in 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.

Option 3: With Multiple Docker Sandboxes (WSL 2)

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.

Extension points exported contracts — how you extend this code

browse all types & interfaces →

Core symbols most depended-on inside this repo

browse all functions →

Shape

Function 6,406
Interface 1,224
Method 295
Class 172
Enum 5

Languages

TypeScript100%
Python1%

Modules by API surface

src/components/features/automations/setup/automation-setup-panel.tsx72 symbols
src/api/automation-service/automation-service.api.ts62 symbols
src/api/conversation-service/agent-server-conversation-service.api.ts56 symbols
scripts/dev-with-automation.mjs56 symbols
src/services/telemetry.ts47 symbols
src/api/agent-server-adapter.ts44 symbols
scripts/dev-safe.mjs40 symbols
src/hooks/use-tracking.ts37 symbols
src/manifests/types.ts36 symbols
src/components/features/backends/backend-form-modal.tsx35 symbols
src/api/settings-service/settings-service.api.ts35 symbols
src/api/mars/mars-tunnel-backend.ts35 symbols

Dependencies from manifests, versioned

@eslint/eslintrc3.3.7 · 1×
@eslint/js10.0.1 · 1×
@heroui/react3.2.7 · 1×
@heroui/styles3.2.7 · 1×
@monaco-editor/react4.7.0 · 1×
@openhands/extensions0.43.0 · 1×
@openhands/typescript-client1.62.0 · 1×
@playwright/test1.65.0 · 1×
@react-router/dev8.5.1 · 1×
@react-router/node8.5.1 · 1×
@shadcn/lint0.2.5 · 1×

For agents

$ claude mcp add OpenHands \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page