README
¶
This is an experimental project still undergoing active development and breaking changes.
terraform-exec
A Go module for constructing and running Terraform CLI commands. Structured return values use the data types defined in terraform-json.
The Terraform Plugin SDK is the canonical Go interface for Terraform plugins using the gRPC protocol. This library is intended for use in Go programs that make use of Terraform's other interface, the CLI. Importing this library is preferable to importing github.com/hashicorp/terraform/command, because the latter is not intended for use outside Terraform Core.
Usage
The Terraform struct must be initialised with NewTerraform(workingDir, execPath).
Top-level Terraform commands each have their own function, which will return either error or (T, error), where T is a terraform-json type.
Example
package main
import (
"github.com/kmoe/terraform-exec/tfexec"
func main() {
workingDir := "/path/to/working/dir"
tf, err := tfexec.NewTerraform(workingDir, "")
if err != nil {
panic(err)
}
err := tf.Init(Upgrade(true), LockTimeout("60s"))
if err != nil {
panic(err)
}
state, err := tf.StateShow()
if err != nil {
panic(err)
}
fmt.Println(state.FormatVersion) // "0.1"
)
Directories