From e4e778f1bb2c612b78425700dfa6c7cf7886215c Mon Sep 17 00:00:00 2001 From: Devin Date: Tue, 3 Nov 2026 10:30:38 -0500 Subject: [PATCH] Link install methods and put quick npm install in header --- openhands/usage/agent-canvas/setup.mdx | 30 +++++++++++++++++--------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/openhands/usage/agent-canvas/setup.mdx b/openhands/usage/agent-canvas/setup.mdx index 10c160e50..d79fd1a17 100644 --- a/openhands/usage/agent-canvas/setup.mdx +++ b/openhands/usage/agent-canvas/setup.mdx @@ -3,7 +3,17 @@ title: Install Agent Canvas description: Install, run, update, or uninstall Agent Canvas. --- -Install the desktop preview for macOS, Windows, or Linux to use Agent Canvas without setting up npm or a source checkout. +## Quick Start + +With [Node.js 24 or later and `uv`](#verify-prerequisites) installed, run: + +```bash +npm install -g @openhands/agent-canvas && agent-canvas +``` + +Open `http://localhost:8000` if your browser does not open automatically, then follow [First Time Setup](/openhands/usage/agent-canvas/first-time-setup) to configure a model and open a workspace. Keep the terminal running while you use Agent Canvas. + +Prefer an installer? Use the [desktop preview](#desktop-app-preview-build) for macOS, Windows, or Linux without setting up npm or a source checkout. The `agent-canvas` launcher can run the Canvas client with Agent Server, Automation Server, and ingress as an all-in-one local stack. Use npm or npx for direct local execution, or Docker for a containerized stack with explicit project mounts. You can also run the client separately and connect it to an existing backend. @@ -16,11 +26,11 @@ The `agent-canvas` launcher can run the Canvas client with Agent Server, Automat | Method | Use It When | What The Agent Can Access | |--------|-------------|---------------------------| | **[Desktop app (preview)](#desktop-app-preview-build)** | You want an installer with bundled Node.js and `uv`. Go to [macOS](#macos), [Windows](#windows), or [Linux](#linux) instructions. | The default local backend runs directly on your machine and can work in local workspaces you open. | -| **npm local install** | You want the quickest local browser setup. | Runs directly on your machine and can work in local workspaces you open. | -| **Docker** | You want a local sandbox with clearer file boundaries. | Runs inside a container and can access mounted project directories. | -| **npx** | You want to try Agent Canvas without installing the package globally. | Runs directly on your machine and can work in local workspaces you open. | -| **VM / self-hosted** | You want an always-on backend, stronger hardware, or a team-accessible server. | Runs on the VM or dedicated host you configure. | -| **From source** | You are contributing to Agent Canvas or changing the frontend/backend stack. | Runs your local development checkout. | +| **[npm local install](#install-npm)** | You want the quickest local browser setup. | Runs directly on your machine and can work in local workspaces you open. | +| **[Docker](#install-docker)** | You want a local sandbox with clearer file boundaries. | Runs inside a container and can access mounted project directories. | +| **[npx](#install-npx)** | You want to try Agent Canvas without installing the package globally. | Runs directly on your machine and can work in local workspaces you open. | +| **[VM / self-hosted](/openhands/usage/agent-canvas/backend-setup/vm)** | You want an always-on backend, stronger hardware, or a team-accessible server. | Runs on the VM or dedicated host you configure. | +| **[From source](#install-from-source)** | You are contributing to Agent Canvas or changing the frontend/backend stack. | Runs your local development checkout. | For an installer, choose the desktop preview below. For a browser setup, use `npx` for a quick first run or npm for a reusable `agent-canvas` command. Use Docker when you specifically want sandboxing. @@ -126,7 +136,7 @@ These prerequisites apply to the npm, npx, and Docker methods. Desktop installer - + Install the published package globally: ```bash @@ -142,7 +152,7 @@ These prerequisites apply to the npm, npx, and Docker methods. Desktop installer Agent Canvas starts on `http://localhost:8000` by default. If your browser does not open automatically, open that URL manually. - + Use a named Docker volume for persistent settings and a host directory for project files, then start the container. **macOS / Linux:** @@ -201,7 +211,7 @@ These prerequisites apply to the npm, npx, and Docker methods. Desktop installer PowerShell uses backticks (`` ` ``) for line continuation. If Docker reports that it cannot connect to the daemon, start Docker Desktop and run the command again. - + Run the latest published package without installing it globally: ```bash @@ -214,7 +224,7 @@ These prerequisites apply to the npm, npx, and Docker methods. Desktop installer - + Use the source workflow only when you want to modify Agent Canvas itself: ```bash