Skip to content
Gruntwork Runbooks

Write Your First Runbook

Let’s create a simple runbook from scratch!

Create the runbook file

Section titled “Create the runbook file”
  1. Create a new folder called my-first-runbook.
  2. Inside that folder, create a file called runbook.mdx.
  3. Create subfolders called scripts and templates/project.
  4. Copy/paste the following content into each file:

You can also download the complete example as a zip file.

runbook.mdx

⚠️ Could not read file: testdata/my-first-runbook/runbook.mdx

scripts/setup.sh

⚠️ Could not read file: testdata/my-first-runbook/scripts/setup.sh

Make the script executable:

Terminal window
chmod +x my-first-runbook/scripts/setup.sh

templates/project/boilerplate.yml

⚠️ Could not read file: testdata/my-first-runbook/templates/project/boilerplate.yml

templates/project/README.md

⚠️ Could not read file: testdata/my-first-runbook/templates/project/README.md

templates/project/.gitignore

⚠️ Could not read file: testdata/my-first-runbook/templates/project/.gitignore

Open your runbook

Section titled “Open your runbook”

Save the files and open the runbook:

Terminal window
runbooks open my-first-runbook/

Your browser will open showing the runbook interface. Follow the steps to execute each block!

Next

Section titled “Next”

This Runbook generates some files. Let’s learn more about the files workspace — where generated files and cloned repositories show up in the Runbooks UI.