Appearance

On this page

Installation ​

The Terramate project distributes two binaries:

  • terramate: The CLI tool that we love.
  • terramate-ls: The Terramate Language Server.

The Language Server is only needed if you want to integrate some linting in your editor/IDE.

Using Go ​

For installing versions greater than v0.2.18, please run:

sh
go install github.com/terramate-io/terramate/cmd/...@<version>

For older versions, the command below is required (see this issue for the reason):

sh
go install github.com/mineiros-io/terramate/cmd/...@<version>

Where <version> is any terramate version tag, or you can just install the latest release:

sh
go install github.com/terramate-io/terramate/cmd/...@latest

The commands above install both terramate and terramate-ls into your Go binary folder (usually $HOME/go/bin).

Using a package manager ​

Brew ​

You can install Terramate on macOS using Homebrew:

brew install terramate

Asdf ​

You can install Terramate using asdf:

asdf plugin add terramate
asdf install terramate latest

Using Release Binaries ​

To install Terramate using a release binary, follow these steps:

  1. Visit the Terramate download page or locate the suitable package for your system on the Terramate Releases page.

  2. Download the Terramate package.

  3. Unzip the downloaded package to extract the Terramate binary, which is named terramate. You can safely remove any other files in the package without affecting Terramate's functionality.

  4. Ensure that the terramate binary is available on your PATH. The process for this will vary based on your operating system.

Using Docker ​

If you prefer not to install Terramate directly on your host system, you can use either Docker or Podman to run Terramate within a container.

To do so, execute the following command:

sh
docker run ghcr.io/terramate-io/terramate

We also provide container images tagged with specific release versions. To view a list of available container image tags, visit this link.

Note: Our image doesn't come with additional dependencies such as Terraform. We recommend building your own image by using our image as the base image to install additional dependencies required.

We recommend mounting your Terramate project as a Docker mount volume to use it inside the container. Depending on your setup, you should set the correct permissions when running the container.

sh
docker run -it -u $(id -u ${USER}):$(id -g ${USER}) \
  -v /some/repo:/some/repo \
  ghcr.io/terramate-io/terramate:latest -C /some/repo --changed run -- cmd

Auto Completion ​

Terramate supports autocompletion of commands for bash, zsh and fish. To install the completion just run the command below and open a new shell session:

sh
terramate install-completions