Get startedInstall⌄

Install spool

spool runs on your machine: the Mac app, or the npm package on macOS, Linux and WSL. Either way your frames stay files in your repo.

Mac app

Apple silicon, macOS 14 or later. It includes its own Node runtime and updates itself, but not an agent: install one of those as Work with your agent says.

Download for Mac

Command line

Node 22.19 or later, on macOS or Linux. On Windows, run it inside WSL. Open the canvas in Chrome.

~ $ npm i -g spool.page
~ $ cd kaffe
~/kaffe $ spool init

If your npm setup blocks dependency install scripts, use npm i -g spool.page --allow-scripts=esbuild to permit esbuild's install script.

Open the canvas

spool opens your canvas in the browser, and any spool command starts the daemon that serves it. spool --no-open prints the canvas address instead. The daemon listens on http://localhost:7766, and local.spool.page finds it on your machine and takes you there.

spool open registers a repo that already has design/ and opens its tab. spool remove forgets it again and leaves its files alone.

Start at login

On macOS, the daemon can start when you log in, so the canvas is always there.

~ $ spool autostart

spool autostart off removes it.

Upgrade

The Mac app updates itself. On the command line, one command installs the latest release and restarts the daemon on it.

~ $ spool upgrade