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.
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.
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
- Create one canvas for your feature.
- Add wireframes or flow boxes.
- Add terminal and filesystem widgets for the project you are working in.
- Keep docs open while implementing.