# `boilerplate`

`boilerplate` is used for generating all Terraform stacks from Golden Path.

Save the following script and run it to install or update `boilerplate` — there are no Homebrew packages available:

```sh
MY_BIN_DIR="$HOME/bin"
PLATFORM=$(uname | tr '[:upper:]' '[:lower:]')

gh release download \
  --repo "gruntwork-io/boilerplate" \
  --clobber \
  --pattern "boilerplate_${PLATFORM}_amd64" \
  --output "$MY_BIN_DIR/boilerplate"

chmod +x "$MY_BIN_DIR/boilerplate"
```

Add the location of the Boilerplate binary to your PATH:

```bash
export PATH=$PATH:$HOME/bin
```

Verify that the correct version of Boilerplate is installed:

```bash
boilerplate -v
```

Persist the location of Boilerplate:

=== "macOS"

    ```bash
    echo 'export PATH=$PATH:$HOME/bin' >> ~/.zshrc
    ```

=== "Linux"

    ```bash
    echo 'export PATH=$PATH:$HOME/bin' >> ~/.bash_profile
    ```

You can also refer to the [`boilerplate` install documentation on GitHub](https://github.com/gruntwork-io/boilerplate?tab=readme-ov-file#install){:target="_blank"}