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 flag | What it does |
|---|---|
open-canvas | Start the local editor and open its browser URL. |
open-canvas --no-open | Start without opening a browser. |
open-canvas --version | Print the installed editor version. |
open-canvas --help | Show launcher help. |
open-canvas mcp-config | Print the MCP server configuration entry. On Windows the entry starts the command through cmd /c. |
open-canvas mcp | Start the MCP server over stdio. Use it in the client entry generated by mcp-config. |
open-canvas update | Install the latest available release, using the installer in the installed bundle (install.ps1 on Windows). |
open-canvas update --check | Check for an available update without installing it. |
open-canvas changelog | Show release history. |
open-canvas changelog --latest | Show the newest release notes. |
Installer options
| Installer command | What it does |
|---|---|
bash open-canvas-install.sh --version vX.Y.Z | Install a specific version tag. |
bash open-canvas-install.sh --archive FILE.tar.gz | Install a local archive with an adjacent FILE.tar.gz.sha256 checksum. |
bash open-canvas-install.sh --help | Show installer usage. |
Use a version that has matching archives and checksums for your platform.
On Windows, the PowerShell installer takes these options:
| Installer command | What it does |
|---|---|
powershell -NoProfile -ExecutionPolicy Bypass -File .\open-canvas-install.ps1 -Version vX.Y.Z | Install a specific version tag. |
powershell -NoProfile -ExecutionPolicy Bypass -File .\open-canvas-install.ps1 -Archive FILE.tar.gz | Install a local archive with an adjacent FILE.tar.gz.sha256 checksum. |
-Version and -Archive cannot be combined.
Port environment variables
| Variable | Purpose |
|---|---|
CAVAS_APP_PORT | Select the local editor's HTTP port. |
CAVAS_MCP_PORT | Select the local MCP broker port. |
Set unused port values consistently for the editor and MCP client configuration.
Written for Open Canvas 0.8.0