Overview

Authoring Runbooks

This section covers everything you need to know to write your own Runbooks.

What’s in a Runbook?

A Runbook combines markdown documentation with interactive blocks that can:

• 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 through a web interface.

Quick start

For an initial walkthrough, see Write Your First Runbook for a complete tutorial.

Section Guide

• Runbook Structure. Learn the file format and folder organization for Runbooks.
• Markdown. Reference for supported markdown elements.
• Inputs & Outputs. How data flows between blocks — collecting user input, wiring it with inputsId, and passing runtime outputs downstream.
• Boilerplate Templates. Guide to template syntax and boilerplate.yml files.
• Blocks. Reference for all interactive block components: