Getting Started

Install Vibecanvas and run your first session.

Vibecanvas is a visual development workspace where you can sketch flows, add project widgets, and iterate in one place. You can also edit canvases through the CLI, which means agents can do canvas mutations too.

Prerequisites

• Bun installed on your machine.
• A local project folder where you want to work.

Install

Pick your preferred package manager:

bun add -g vibecanvas

npm i -g vibecanvas

pnpm add -g vibecanvas

Run

From your project directory:

cd your-project
vibecanvas

vibecanvas starts the local server by default. It is equivalent to vibecanvas serve.

If you want a specific port:

vibecanvas serve --port 3001

Once launched, open the canvas and start creating frames, notes, and task flows.

You can also inspect or mutate canvas state from the CLI:

vibecanvas canvas --help

The Vibecanvas skill for agents lives here:

• https://github.com/vibecanvas/skills

Check the CLI

vibecanvas --help
vibecanvas --version

Short aliases are also available: vibecanvas -h and vibecanvas -v.

Upgrade

vibecanvas upgrade --check
vibecanvas upgrade

Use --check for a dry run, or upgrade to install the latest version.

To install a specific release:

vibecanvas --upgrade 0.2.0-beta.3

What to do first

1. Create one canvas for your feature.
2. Add wireframes or flow boxes.
3. Add terminal and filesystem widgets for the project you are working in.
4. Use the canvas CLI when you want repeatable or agent-driven canvas edits.
5. Keep docs open while implementing.