Skip to content

Getting Started

Step 1

Sign up with GitHub

Click here to sign up for Terrateam

Install the Terrateam GitHub application on any repository with Terraform code.

Step 2

GitHub Actions Workflow

Click here for the Terrateam GitHub Actions workflow file

The Terrateam GitHub Actions workflow file must be stored in the default branch of your Terraform repository. The default branch is usually named main or master.

Terminal window
Expand for detailed workflow file setup instructions
  1. Create a new branch in your repository
git checkout -b terrateam-setup
  1. Create a .github/workflows directory
mkdir -p .github/workflows
  1. Store the Terrateam GitHub Actions workflow file in the .github/workflows directory
curl -L -o .github/workflows/terrateam.yml \
  1. Commit and push .github/workflows/ to your branch
git add .github/workflows/ && \
git commit .github/workflows/ -m "Terrateam GitHub Actions workflow file" && \
git push --set-upstream origin terrateam-setup
  1. Create a pull request to merge your changes into the default branch
gh pr create --fill
  1. Merge your new pull request

Step 3

Cloud Provider Setup

Terrateam needs permission to access your cloud provider in order to make changes with the Terraform CLI.

Next Steps

Pull Request

Create a Pull Request with a Terraform code change
  1. Terrateam will automatically run terraform plan and comment back the output

  2. Comment on the pull request with terrateam apply to apply changes

  3. Merge the pull request


Learn how to fully customize your workflow with our runtime configuration file.


Join our Slack community or email support if you need help on-boarding.

We use cookies and similar technologies to provide certain features, enhance the user experience and deliver content that is relevant to your interests. Depending on their purpose, analysis and marketing cookies may be used in addition to technically necessary cookies. By clicking on "Agree and continue", you declare your consent to the use of the aforementioned cookies. Here you can make detailed settings or revoke your consent (in part if necessary) with effect for the future. For further information, please refer to our Privacy Policy .