Install

Install

Check your platform, inspect the installer, and start Open Canvas in your browser.

Requirements

macOS and Linux: x64 or ARM64. On Linux, it requires glibc. You need Bash, curl, tar, and either sha256sum or shasum.

Windows: Windows 10 version 1803 or later, or Windows 11, on x64 or ARM64. You need Windows PowerShell 5.1 or PowerShell 7, and the tar.exe that ships with Windows. No administrator rights are needed.

You also need a browser on the same machine. Node.js and the editor runtime come in the archive. Alpine Linux and native desktop installers are not included.

The Windows package and installer have been run in CI on Windows Server 2025 (x64) and Windows 11 (ARM64) only. They have not been verified on other Windows machines.

Run the installer

On macOS and Linux, the installer downloads a platform archive from GitHub Releases, checks its SHA-256 checksum, installs the release under ~/.open-canvas/install/releases, and creates the ~/.local/bin/open-canvas command. The Windows installer does the same under %USERPROFILE%\.open-canvas\install. The checksum detects corruption; it is not a signature and does not prove who published the archive. The installer does not edit agent settings.

bash
curl -fsSL https://open-canvas.xyz/install.sh | bash

To inspect the script before running it:

bash
curl -fsSL https://open-canvas.xyz/install.sh -o open-canvas-install.sh
less open-canvas-install.sh

After you inspect the script and confirm the matching downloads are available, run it:

bash
bash open-canvas-install.sh

Windows

In PowerShell, run:

powershell
irm https://raw.githubusercontent.com/utpalsinghdev/open-canvas/main/scripts/install.ps1 | iex

The PowerShell installer downloads only over HTTPS, verifies the checksum, extracts into a staging directory, runs the bundle once, and only then switches the command. It adds %USERPROFILE%\.open-canvas\install\bin to your user PATH and edits nothing machine-wide. Reopen any terminal that was open before the install.

To inspect the installer first, or to pass options:

powershell
irm https://raw.githubusercontent.com/utpalsinghdev/open-canvas/main/scripts/install.ps1 -OutFile open-canvas-install.ps1
notepad open-canvas-install.ps1
powershell -NoProfile -ExecutionPolicy Bypass -File .\open-canvas-install.ps1

The execution-policy flag applies only to that one process. The site also serves a copy of the script at /install.ps1 for reading.

Install a specific version

Replace vX.Y.Z with a release tag that has an archive and checksum for your platform:

bash
curl -fsSL https://open-canvas.xyz/install.sh | bash -s -- --version vX.Y.Z

On Windows, pass -Version vX.Y.Z to the downloaded script:

powershell
powershell -NoProfile -ExecutionPolicy Bypass -File .\open-canvas-install.ps1 -Version vX.Y.Z

Install from a local archive

Keep the matching .sha256 file next to the archive. The installer requires both files and checks the archive before replacing the launcher link.

bash
bash open-canvas-install.sh --archive ./open-canvas-linux-x64.tar.gz

On Windows, pass -Archive with the matching archive, for example open-canvas-win32-x64.tar.gz or open-canvas-win32-arm64.tar.gz:

powershell
powershell -NoProfile -ExecutionPolicy Bypass -File .\open-canvas-install.ps1 -Archive C:\path\open-canvas-win32-x64.tar.gz

Start Open Canvas

Start the local editor:

bash
open-canvas

By default it opens http://127.0.0.1:5190 in your browser. Use --no-open to leave the browser closed. If the command is not on your PATH, run ~/.local/bin/open-canvas directly or add ~/.local/bin to your PATH. On Windows, run %USERPROFILE%\.open-canvas\install\bin\open-canvas.cmd.

Keep the terminal running while you edit, and press Ctrl+C to stop the editor. In Windows Command Prompt, Ctrl+C may ask Terminate batch job (Y/N)?; either answer leaves the editor stopped.

Troubleshooting

macOS and Linux messages

Installer messageWhat to check
Use --version vX.Y.Z.Pass one version tag in the vX.Y.Z form after --version.
Provide the archive and its adjacent .sha256 file.Pass an existing archive path and make sure its checksum file is named <archive>.sha256.
Unexpected empty argument.Remove the empty argument and run the installer without arguments or with one supported option.
This installer supports macOS and Linux.Run it on macOS or Linux.
This installer supports x64 and arm64.Use an x64 or ARM64 machine.
Will not replace …/open-canvas.The destination is an unrelated file or symlink. Move it aside only if you recognize it, then retry.
Release archive unavailable. Check the GitHub Releases page.That release may not contain an archive for your platform. Choose a release with matching assets.
Release checksum unavailable.The release is missing the adjacent .sha256 asset. Use a complete release.
Could not read release checksum.Check that the checksum file exists and is readable.
Malformed release checksum.The checksum must begin with 64 lowercase hexadecimal characters. Use the matching release checksum.
Install sha256sum or shasum to verify the archive.Install one of those checksum utilities and retry.
SHA-256 mismatch; existing installation was not changed.The archive and checksum do not match. Obtain both from the same release again.
Bundle cannot run on this machine.The archive may be damaged or built for an incompatible system. Use the matching platform archive.
Archive version does not match the requested tag.The archive does not contain the requested version. Use the archive belonging to that tag.
Could not store the verified archive.Check permissions and free space under ~/.open-canvas/install, then retry.
Existing bundle cannot run on this machine.The already-installed bundle cannot start on this system. Reinstall a compatible archive.

Windows messages

PowerShell installer messages begin with Open Canvas:.

Installer messageWhat to check
Use either -Version or -Archive, not both.Pass only one of the two options.
Use -Version vX.Y.Z.Pass one version tag in the vX.Y.Z form after -Version.
Provide the archive and its adjacent .sha256 file.Pass an existing archive path and make sure its checksum file is named <archive>.sha256.
This installer supports Windows. Use install.sh on macOS and Linux.Run install.ps1 only on Windows.
This installer supports x64 and arm64.Use an x64 or ARM64 machine.
Windows 10 version 1803 or later is required (tar.exe).Update Windows so that tar.exe is available.
USERPROFILE is not set.Run the installer in a normal user session.
Refusing a non-HTTPS download from …The installer follows redirects only over HTTPS. Retry later or install from a local archive.
Will not replace …\open-canvas.cmd.The destination is an unrelated file. Move it aside only if you recognize it, then retry.
Release archive unavailable. Check the GitHub Releases page.That release may not contain an archive for your platform. Choose a release with matching assets.
Release checksum unavailable.The release is missing the adjacent .sha256 asset. Use a complete release.
Malformed release checksum.The checksum must begin with 64 lowercase hexadecimal characters. Use the matching release checksum.
SHA-256 mismatch; existing installation was not changed.The archive and checksum do not match. Obtain both from the same release again.
Could not extract the archive.The archive may be damaged. Download it again.
Bundle cannot run on this machine.The archive may be damaged or built for an incompatible system. Use the matching platform archive.
Archive version does not match the requested tag.The archive does not contain the requested version. Use the archive belonging to that tag.
Could not store the verified archive.Check permissions and free space under %USERPROFILE%\.open-canvas\install, then retry.

Ports

If the default ports are occupied, set CAVAS_APP_PORT for the editor and CAVAS_MCP_PORT for its local agent broker, then restart the command with those values. A different port pair opens a separate browser origin and data directory. Restart with the original pair to return to your existing work.

For example, choose unused ports and run:

bash
CAVAS_APP_PORT=5191 CAVAS_MCP_PORT=4791 open-canvas

That line uses macOS and Linux shell syntax. On Windows, set the same two variables in your terminal environment before starting open-canvas.

Written for Open Canvas 0.8.0