Skip to content

Installation

The quickest way to install Runbooks is to download the pre-built binaries from the GitHub repo.

You can also build the binaries yourself:

  1. Clone the repository:

    Terminal window
    git clone https://github.com/gruntwork-io/runbooks.git
    cd runbooks
  2. Build the frontend:

    Terminal window
    cd web
    bun install
    bun run build
  3. Build the binary:

    Terminal window
    go build -o runbooks main.go
  4. Move the binary to your PATH (optional):

    Terminal window
    sudo mv runbooks /usr/local/bin/
  5. Enable execute permissions for your binary

    Terminal window
    chmod u+x /usr/local/bin/runbooks

6.. Verify installation:

Terminal window
runbooks

Once installed, you can verify that runbooks is working by running:

Terminal window
runbooks version

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