Installation

Download the latest version of Runbooks from the GitHub releases page.

macOS

Download the .dmg file for your Mac from the latest GitHub release:

• Apple Silicon (M1/M2/M3/M4): Runbooks-x.y.z-arm64.dmg
• Intel: Runbooks-x.y.z-x64.dmg

Open the .dmg file and drag Runbooks into your Applications folder.

Tip

Not sure which chip you have? Click the Apple menu and select About This Mac. If you see “Apple M1” or similar, download the Apple Silicon version. If you see “Intel”, download the Intel version.

Note

On first launch, macOS may show a security warning because the app is not signed with an Apple Developer certificate. To open it, go to System Settings > Privacy & Security and click Open Anyway.

Linux

Download one of the following from the latest GitHub release:

• AppImage: Runbooks-x.y.z.AppImage — works on most Linux distributions without installation. Mark it as executable and run it directly:

  chmod +x Runbooks-x.y.z.AppImage
  ./Runbooks-x.y.z.AppImage

• Debian/Ubuntu (.deb): runbooks_x.y.z_amd64.deb — install with:

  sudo dpkg -i runbooks_x.y.z_amd64.deb

After installation, launch Runbooks from your application menu or by running runbooks in a terminal.

Windows

Download the .exe installer from the latest GitHub release:

• Runbooks-x.y.z-setup.exe

Run the installer and follow the on-screen prompts. Once installation is complete, launch Runbooks from the Start menu or desktop shortcut.

Building from source

If you prefer to build the app yourself, you will need mise and just installed as prerequisites.

1. Clone the repository:

   git clone https://github.com/gruntwork-io/runbooks.git
   cd runbooks

2. Install tool versions and dependencies:

   mise install
   bun install

3. Build the application:

   just build

4. Package the application for your platform:

   just package

   The packaged application will be available in the build output directory.

Verifying installation

Open the Runbooks application. If everything is installed correctly, you should see the welcome screen.

Next

Now that you have Runbooks installed, let’s write your first runbook!