Getting startedAlpha

Setup Scaffold in your development environment

Scaffold is a framework for IAC build on top of Terraform and the CDKTF.

It is coupled with a catalog that you could use to create a complete AWS infrastructure, defined as code, in seconds.

All infrastructures are open sourced and defined as Terraform Typescript code using the CDK for Terraform.

The CDK (Cloud Development Kit) for Terraform allows developers to use familiar programming languages to define cloud infrastructure and provision it through HashiCorp Terraform.

Scaffold enhances Terraform and the CDKTF with many features like environments and sandboxes without using any configuration files, black box or lock-in.

You are free to go back to raw Terraform at any time.


In order to use Scaffold, you'll need Node.js, Yarn and the AWS CLI:

Node.js publishes a graphical installer that will install Node.js and NPM on your platform.

Yarn is an alternate JavaScript package manager required by the CDK for Terraform.

To install the AWS CLI on your operating system, you could read the AWS documentation.

Install Scaffold

To install the most recent stable release of Scaffold, use npm:

$ npm install --global

Verify the installation

You could verify that the installation worked by opening a new terminal session and running the scaffold command to show available subcommands:

$ scaffold

The CLI for

VERSION darwin-x64 node-v14.7.0

  $ scaffold [COMMAND]

  aws        download AWS infrastructures
  cdktf      forward commands to CDKTF binary
  env        manage environments
  sandbox    manage sandboxes
  terraform  forward commands to Terraform binary

  apply    update infrastructure for passed environment
  destroy  destroy infrastructure for passed environment
  help     display help for scaffold
  init     initialize an infrastructure
  plan     plan infrastructure modifications for passed environment

You could add the --help flag to any subcommand to learn more about what it does and available options:

$ scaffold apply --help