@smburrows/terraform-npm v1.5.4

terraform-npm

An NPM executable package for HashiCorp's Terraform.

Preamble

I assembled Terraform into an NPM package in order for me to include it in other projects that depended on the executable. I wanted to be able to publish NPM modules with scripts like this:

{
  "scripts": {
    "plan": "terraform plan -out=my-tfplan"
  }
}

But without having to worry about asking users to download Terraform externally.

Installation

To use Terraform as an NPM package, include it in your package.json dependencies:

# If you're using Yarn (recommended):
yarn add terraform-npm

# If you're using NPM:
npm i terraform-npm

Or, if you want a one-time installation that you can run arbitrarily, install it globally:

# If you're using Yarn (recommended):
yarn global add terraform-npm

# If you're using NPM:
npm i -g terraform-npm

Usage

As a project dependency:

This package cannot currently be used as a typical Node module, as it does not export any entry points; it only symlinks a binary. So, the recommended use case is to use it in your package.json scripts:

{
    "scripts": {
        "plan": "terraform plan -out=my-tfplan",
        "apply": "terraform apply",
        "execute": "terraform apply \"my-tfplan\"",
        "destroy": "terraform destroy"
    }
}

As a globally installed binary:

If you installed this package globally (with npm i -g or yarn global add), you can simply start using it like a regular command-line program:

terraform -v        # show version info
terraform --help    # show usage info