VIBECANVAS

Installation and Setup

Prepare your environment and launch Vibecanvas locally.

This guide helps you get Vibecanvas running reliably on a new machine.

1) Install Node.js

Install Node.js 18 or newer, then verify:

node --version
npm --version

Vibecanvas uses Node package tooling when generated guest widget code installs its package dependencies.

2) Install Bun

Follow the Bun install guide, then verify:

bun --version

3) Install Vibecanvas globally

Choose the package manager you already use:

bun add -g vibecanvas
npm i -g vibecanvas
pnpm add -g vibecanvas

4) Verify the CLI is available

vibecanvas --version

5) Launch the local app

vibecanvas

Running vibecanvas starts the serve command by default.

To choose a port explicitly:

vibecanvas serve --port 3001

The default port is 3000 in development and 7496 in compiled builds.

6) Verify core behavior

  • App opens with canvas and side panels.
  • Chat can start a new conversation.
  • Generated widgets can be added to the canvas.
  • Live widget state updates through the local backend.

7) Keep Vibecanvas updated

vibecanvas upgrade --check
vibecanvas upgrade

To install a specific release:

vibecanvas --upgrade 0.2.0-beta.3

If you need the full command list:

vibecanvas --help

8) Uninstall

To remove the curl-installed binary and local Vibecanvas config/data/state/cache:

vibecanvas uninstall --dry-run
vibecanvas uninstall --yes

If one of these fails, ask in Discussions: