building.md

Building TFLint

Go 1.20 or higher is required to build TFLint from source code. Clone the source code and run the make command. Built binary will be placed in dist directory.

$ git clone https://github.com/terraform-linters/tflint.git
$ cd tflint
$ make
mkdir -p dist
go build -v -o dist/tflint

Run tests

If you change code, make sure that the tests you add and existing tests will be passed:

$ make test

Run E2E tests

You can check the actual CLI behavior by running the E2E tests. Since the E2E tests uses the installed tflint command, it is necessary to add the path into $PATH environment so that the binary built by go install can be referenced.

$ make e2e