Skip to main content
Version: Next

Get started

You can understand Terrabuild and run a representative example without first learning its graph internals or every configuration option.

1. Understand the model​

How Terrabuild works explains desired-state delivery using projects, outcomes, dependencies, and reusable results. It deliberately avoids the scheduler and cache implementation details.

2. Run the playground​

Install Terrabuild, then follow the quick start. The playground contains shared libraries, applications, container images, and Terraform, so one small repository can show the path from a source change to an environment.

3. Bring the model to your repository​

Scaffold an existing monorepo to generate an initial WORKSPACE and PROJECT files. Review the result and begin with one useful outcome, usually build, before adding packaging or deployment.

4. Add delivery and history when useful​

  • Model a deployment when application artifacts should feed an environment-specific plan or deployment.
  • Connect Insights when developer machines and CI should share encrypted artifacts and a delivery record.

The Deep dive section is there when you need to tune reuse, understand an unexpected selection, introduce phases or batching, or inspect the complete graph model.