Skip to content
hyperspool

Quickstart

Everything here runs on your machine - no server, no account.

Install

Section titled “Install”
Terminal window
curl -fsSL https://hyperspool.com/install.sh | sh

One static binary, spool: the CLI, a local dev server, and the agent.

First run

Section titled “First run”
Terminal window
spool init && spool run pipeline.yaml

spool init writes three starter workflows. spool run starts an ephemeral in-process instance, runs the pipeline, streams the output, and tears everything down. The exit code mirrors the run.

pipeline.yaml is a build-and-ship pipeline with a durable timer between the two jobs. Under spool run the timer lasts as long as the command, because the instance takes its runs with it when it exits. For a 30-day wait, use spool dev below: the run sleeps without holding a machine and wakes on time.

A script that survives a sleep

Section titled “A script that survives a sleep”
Terminal window
spool run durable.sh

durable.sh is plain bash. Without its comments, it is:

Terminal window
n="$(spool step "pick" -- bash -c 'echo $(( RANDOM % 100 ))')"
echo "picked $n"


spool sleep 5s


m="$(spool step "add" -- expr "$n" + 1)"
echo "$n + 1 = $m"

Watch the output: picked prints twice, with the same number both times. spool sleep ends the process and the wake-up runs the script again from the top, but pick replays what it recorded the first time. Replay explains how.

Waiting for the outside world

Section titled “Waiting for the outside world”
Terminal window
spool run signals.sh

This one waits for a signal with spool wait signal. While it waits, it prints the command to send the signal from a second terminal. When the signal arrives, spool wait signal prints its payload and the run completes.

A persistent local instance

Section titled “A persistent local instance”
Terminal window
spool dev

Starts a single-process Hyperspool (server, agent, sqlite and the console) on http://127.0.0.1:18753. Runs and secrets persist across restarts, and the console shows runs waiting for an answer. Other spool commands reach it through the local context (local and the server).

Next

Section titled “Next”
  • Getting started - the longer walk, including a crash test and running on hyperspool.dev.
  • Concepts - workflows, runs, steps, agents, events.
  • YAML pipelines - the full pipeline dialect.
  • Polyglot scripts - workflows in your language.
  • Agents - the managed environments, and running your own agents when they don’t fit.