Getting Started
Install Vibecanvas and generate your first live widget.
Vibecanvas is a generative app on an infinite canvas. Use it to create many small live widgets, each with backend behavior, then arrange them spatially into dashboards, tools, forms, and workflows.
Prerequisites
- Node.js 18 or newer for guest widget package installs.
- Bun installed on your machine.
- A browser where you can open the local Vibecanvas app.
Install
Pick your preferred package manager:
bun add -g vibecanvas
npm i -g vibecanvas
pnpm add -g vibecanvas
Run
Start the local app:
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 generating widgets. A widget can be a chart, booking form, queue, gallery, table, chat surface, control panel, or any other focused app surface with live state behind it.
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 a canvas for the app idea or workflow.
- Generate one focused widget with clear behavior.
- Add more widgets as separate live app surfaces.
- Arrange related widgets near each other on the infinite canvas.
- Iterate by regenerating, replacing, or composing widgets as the workflow changes.