ReferenceCommands⌄
Commands
Every command spool has. Your agent runs most of them itself; spool skill tells it how. spool --help prints the same list, and spool help <command> one command's options.
Projects
- spool
- Open your canvas in the browser.
- spool init [path]
- Create design/, register the project and open its tab.
- spool open [path]
- Register an existing project, found by walking up from here, and open its tab.
- spool remove [path]
- Forget a registered project. Its files stay untouched.
- spool --no-open
- Print the canvas address instead of opening a browser.
Frames
- spool check [paths…]
- Type-check frames without starting anything. Never writes.
- spool shot <frames…>
- Save a headless screenshot of each frame, several at once, with its console errors.
- spool logs <frame>
- Print the frame's boot console output.
- spool url <frame>
- Print a player address for the frame, to drive in a browser.
- spool flows
- Print the link graph between frames, read from their source.
- spool record <frame>
- Render a frame that plays itself into an MP4 clip, its sound included. Needs the record experiment.
Teams
- spool login
- Sign this machine in to spool.page in a browser, here or on any other device.
- spool logout
- Sign this machine out and forget its session.
- spool move [project]
- Move a project into a team, to another team, out of its team, or into a checkout. Asks first.
- spool history <path>
- Print every save to a file of a team project, or the file as it stood at a time.
- spool comments
- Read and answer the team's comments on this project, as your agent.
For your agent
- spool skill [topics…]
- Print the spool skill: how agents author for the canvas. Topics: frames, flows, scenarios, styling, verbs.
- spool selection
- Print what you are pointing at on the canvas right now.
- spool experiments
- List the experimental features, or switch one on or off on this machine.
The daemon
The daemon is the local server behind the canvas. Any spool command starts it, so these are rarely needed.
- spool serve
- Start the daemon if it is not already running.
- spool status
- Report whether the daemon is running, and where.
- spool stop
- Stop the daemon.
- spool autostart [off]
- Start the daemon at login on macOS. off removes it.
- spool upgrade
- Install the latest release and restart the daemon on it.
spool -v prints the version.