Skip to content
Platform Runbooks

How to use a runbook

Every runbook has the same parts. Try them on this page.

1. Fill in your values

Section titled “1. Fill in your values”

Commands contain placeholders like <YOUR_NAME>. Type your value once in the Your values box and every command on the page updates — including what the copy button copies. Values stay in your browser and are shared between runbooks, so you type your email once.

Your values — fill these in and every command on this page updates; copy buttons copy your version.
Terminal
echo "Hello, <YOUR_NAME>"

2. Tick off steps as you go

Section titled “2. Tick off steps as you go”
Tick the checkboxes as you go — progress is saved in this browser.

Each numbered step has a box on the right; the bar shows how far you are. Progress is saved per page in your browser, so you can close the tab and continue tomorrow.

  • Fill in a value above
  • Copy the command and run it

3. Compare with my run

Section titled “3. Compare with my run”
What I got · my run, 2026-10-22
Hello, jane

Collapsed boxes like this show what I actually got — output, error messages, timings. IDs and addresses are replaced with examples.

4. Read the warnings

Section titled “4. Read the warnings”

5. Finish with Done when and Clean-up

Section titled “5. Finish with Done when and Clean-up”

A runbook isn’t done when the last command succeeds, but when every Done when box is ticked. Then do the clean-up — or keep the resources if the next runbook builds on them; each page says which.

Search everything with Ctrl + K (⌘ + K on a Mac).