Install

CLI

Use this reference for launcher commands, installer options, and local port settings. On Windows the launcher is open-canvas.cmd, and you run it as open-canvas once its folder is on your PATH.

Launcher commands

Use open-canvas from a terminal after installation.

Command or flagWhat it does
open-canvasStart the local editor and open its browser URL.
open-canvas --no-openStart without opening a browser.
open-canvas --versionPrint the installed editor version.
open-canvas --helpShow launcher help.
open-canvas mcp-configPrint the MCP server configuration entry. On Windows the entry starts the command through cmd /c.
open-canvas mcpStart the MCP server over stdio. Use it in the client entry generated by mcp-config.
open-canvas updateInstall the latest available release, using the installer in the installed bundle (install.ps1 on Windows).
open-canvas update --checkCheck for an available update without installing it.
open-canvas changelogShow release history.
open-canvas changelog --latestShow the newest release notes.

Installer options

Installer commandWhat it does
bash open-canvas-install.sh --version vX.Y.ZInstall a specific version tag.
bash open-canvas-install.sh --archive FILE.tar.gzInstall a local archive with an adjacent FILE.tar.gz.sha256 checksum.
bash open-canvas-install.sh --helpShow installer usage.

Use a version that has matching archives and checksums for your platform.

On Windows, the PowerShell installer takes these options:

Installer commandWhat it does
powershell -NoProfile -ExecutionPolicy Bypass -File .\open-canvas-install.ps1 -Version vX.Y.ZInstall a specific version tag.
powershell -NoProfile -ExecutionPolicy Bypass -File .\open-canvas-install.ps1 -Archive FILE.tar.gzInstall a local archive with an adjacent FILE.tar.gz.sha256 checksum.

-Version and -Archive cannot be combined.

Port environment variables

VariablePurpose
CAVAS_APP_PORTSelect the local editor's HTTP port.
CAVAS_MCP_PORTSelect the local MCP broker port.

Set unused port values consistently for the editor and MCP client configuration.

Written for Open Canvas 0.8.0