Get started

Want the shortest path to a working plan? Start with the Quickstart.

This page is the slightly wider local-dev companion.

Prerequisites

Go (see go.mod in the repo)
Docker
A GitHub deploy key for agents (for cloning repos)

Local development

git clone https://github.com/terraplane-org/terraplane.git
cd terraplane
cp .env-example .env   # fill in GitHub secrets, agent key path, etc.
docker compose up --build

Compose brings up Postgres, runs migrations, starts the orchestrator on :8080, and boots agent containers.

Useful Make targets

Target	Description
`make build`	Build `./bin/terraplane`
`make unit-test`	Vet + unit tests
`make generate`	`go generate` (mocks, etc.)
`make run-orchestrator` / `make run-agent`	Run binaries locally

Repo config and commands

See the Quickstart for terraplane.yaml and the plan / apply / unlock comments.

Next