Overview

A runbook combines markdown with interactive blocks that:

• Validate the user’s current state with automated checks
• Execute shell commands and scripts
• Collect user input through forms
• Generate files from templates

All of this runs locally on the user’s machine in the Runbooks desktop app.

Quick start

For a complete tutorial, see Write your first runbook.

Section guide

• Runbook structure covers the file format and folder layout.
• Markdown is the reference for supported markdown elements.
• Inputs and outputs explains how data flows between blocks: collecting user input, wiring it with inputsId, and passing runtime outputs to later blocks.
• Boilerplate templates covers template syntax and boilerplate.yml files.
• Blocks is the reference for every interactive block.
• Opening runbooks covers the ways to open a runbook, locally or from a remote URL.
• Testing covers runbook_test.yml and the test CLI.