Skip to main content
Version: Next

Install Terrabuild

Install Terrabuild on a developer machine first. The terrabuild command should then be available on your PATH.

Homebrew on macOS or Linux​

brew install magnusopera/tap/terrabuild

Upgrade it later with:

brew upgrade magnusopera/tap/terrabuild

.NET global tool​

If the .NET CLI is already installed:

dotnet tool install --global Terrabuild

Upgrade it with:

dotnet tool update --global Terrabuild

Download a release​

Download an archive from GitHub Releases for:

  • macOS on Apple silicon;
  • Linux on x64 or ARM64;
  • Windows on x64 or ARM64;
  • the platform-independent .NET tool.

Extract the executable into a directory on your PATH.

GitHub Actions​

CI needs the same Terrabuild version used by developers. One installation option is the GitHub release action:

- name: Install Terrabuild
  uses: jaxxstorm/action-install-gh-release
  with:
    repo: magnusopera/terrabuild
    tag: 0.200.1
    platform: linux

Pin the version used by the repository instead of silently selecting a new release during every workflow.

Check the installation​

terrabuild --version
terrabuild --help

Terrabuild needs a WORKSPACE file before it can run repository targets. The playground already contains a complete configuration, so it is the easiest next step.

For your own repository, scaffolding can create an initial WORKSPACE and PROJECT files.

Local execution and caching require no account. Connect Insights later if you want a shared delivery record and encrypted artifact reuse across machines.