Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jacobwgillespie/tf
⚡ Fast Terraform version wrapper
https://github.com/jacobwgillespie/tf
terraform
Last synced: 3 months ago
JSON representation
⚡ Fast Terraform version wrapper
- Host: GitHub
- URL: https://github.com/jacobwgillespie/tf
- Owner: jacobwgillespie
- License: mit
- Created: 2021-05-21T14:07:20.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-05T07:14:55.000Z (7 months ago)
- Last Synced: 2024-06-20T17:30:22.999Z (7 months ago)
- Topics: terraform
- Language: Go
- Homepage:
- Size: 55.7 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ⚡ tf
A small, fast `terraform` wrapper which automatically downloads and executes specific Terraform versions.
- Small — create a `.terraform-version` file with your desired version, run `tf`
- Fast — adds only a few milliseconds of delay compared to running `terraform` directly
## Installation
Either download from the [project releases](https://github.com/jacobwgillespie/tf/releases), or install with Homebrew, choosing either the `tf` or `tf-shim` formulae:
- **tf** (installs as `tf`)
```shell
$ brew install jacobwgillespie/tap/tf
```
- **tf-shim** (installs as `terraform`)
```shell
$ brew install jacobwgillespie/tap/tf-shim
```
**NOTE:** it's recommended to install the `tf-shim` or otherwise alias `terraform` to `tf`, as that will enable automated tools like the Terraform VS Code extension to make use of the wrapper.
## Usage
First, create a file named `.terraform-version` containing your desired Terraform version:
```
0.15.0
```
Next, run `tf` instead of `terraform`:
```shell
$ tf [...]
```
`tf` will automatically download the specified Terraform version to `~/.tf` and execute it, passing all command line arguments to the Terraform binary.
**NOTE:** `tf` itself is silent, it will only print output from the proxied `terraform` binary unless there is an error. The first time you run `tf`, it will take time for it to download the Terraform CLI binary to `~/.tf`.
### Default Terraform Version
`tf` will print an error if it is unable to find a `.terraform-version` file. To set the default Terraform version, create a `.terraform-version` file in your home directory, then all directories underneath will default to your specified version.
### How It Works
`tf` is a simple wrapper around Terraform that executes the version of the Terraform CLI specified in the nearest `.terraform-version` file. Specifically, it:
1. Looks for the nearest `.terraform-version` file, starting in the current working directory and scanning up the file tree.
2. Downloads the specified version to `~/.tf/terraform-VERSION`, if not already downloaded, using [hc-install](https://github.com/hashicorp/hc-install)
3. Executes that binary with all passed environment and CLI arguments.
## License
MIT License, see `LICENSE`