Skip to content

Hyperspool docs

Hyperspool is a durable workflow engine with a CI layer on top. Runs sleep for days, wait for approvals and external signals, and spawn child runs. The same engine checks out your repo, runs your build, and reports your commit status. A run resumes where it left off across agent restarts, server restarts, and weeks of waiting.

  • Quickstart - install the spool binary and get a first run green in two commands, entirely on your machine.
  • Concepts - the mental model, one page.

Then pick one of three ways to write workflows. They run on one engine and compose with each other:

  • YAML pipelines - the pipeline dialect: jobs, steps, durable waits, approval gates, child workflows.
  • Polyglot scripts - the same workflows in bash, Python, TypeScript, or anything that can spawn a process.
  • Authoring on the canvas - build a graph of nodes and edges in the browser, with live validation and expression autocomplete.

Sign in at hyperspool.dev (sign-in is by invitation) and create an org if you don’t have one. Then point the CLI at the service and submit:

Terminal window
spool login https://api.hyperspool.dev # paste a token from Settings > Tokens
spool submit pipeline.yaml --follow

Steps run on managed environments the service starts on demand, so no machine of your own is needed. Getting started has the details, and Agents covers what the managed environments have and when to run your own agent.

From there:

  • The CLI - spool ls, spool logs and every other command work against the service.
  • Console - the same in a browser.
  • Teams and projects - inviting people.
  • Support - where to turn when something is wrong.