Skip to main content
Version: 0.200.3

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. On a runner with a compatible .NET SDK already installed:

- name: Install Terrabuild
  run: dotnet tool install --global Terrabuild --version 0.200.1

Use the version chosen by your repository and ensure the .NET global tools directory is on PATH. Install the native tools used by your targets too, or provide them through extension containers.

Check the installation​

terrabuild version
terrabuild --help

Terrabuild needs a WORKSPACE file before it can run repository targets. The first workflow tutorial walks you through creating one, along with two small projects. It needs Git and a POSIX shell.

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.