Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aaratn/terraenv
Terraform & Terragrunt Version Manager
https://github.com/aaratn/terraenv
linux osx python rbenv terraform terragrunt tfenv version-manager
Last synced: 9 days ago
JSON representation
Terraform & Terragrunt Version Manager
- Host: GitHub
- URL: https://github.com/aaratn/terraenv
- Owner: aaratn
- License: mit
- Created: 2019-11-14T12:58:13.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-26T21:31:22.000Z (almost 2 years ago)
- Last Synced: 2024-10-07T05:26:27.612Z (about 1 month ago)
- Topics: linux, osx, python, rbenv, terraform, terragrunt, tfenv, version-manager
- Language: Python
- Homepage:
- Size: 46.9 KB
- Stars: 85
- Watchers: 3
- Forks: 12
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/aaratn/terraenv/actions)
# terraenv
[Terraform](https://www.terraform.io/) & [Terragrunt](https://github.com/gruntwork-io/terragrunt) version manager inspired by [rbenv](https://github.com/rbenv/rbenv), [tfenv](https://github.com/tfutils/tfenv), [tgenv](https://github.com/cunymatthieu/tgenv)
## Support
Currently terraenv supports the following Operating System
- Mac OS X (64bit)
- Linux (64bit)
## Installation
### Automatic
Install via Homebrew on OSx
```console
$ brew tap aaratn/terraenv
$ brew install terraenv
```
Install via Python pip
```console
$ pip install terraenv
```
### Upgrade
via Homebrew on OSx
```console
$ brew upgrade terraenv
```
### Manual on Linux And OSX
1. Download terraenv for your operating system
Linux
```console
$ wget https://github.com/aaratn/terraenv/releases/latest/download/terraenv_linux_x64.tar.gz
```
OSX
```console
$ wget https://github.com/aaratn/terraenv/releases/latest/download/terraenv_osx_x64.tar.gz
```
2. Extract Tar Archive
Linux
```console
$ tar -xvzf terraenv_linux_x64.tar.gz
```
OSX
```console
$ tar -xvzf terraenv_osx_x64.tar.gz
```
3. Copy the extracted file to your `/usr/local/bin` directory
```console
$ cp terraenv /usr/local/bin/terraenv
```
On Ubuntu/Debian touching `/usr/local/bin` might require sudo access
## Usage
### terraenv install [version]
Install a specific version of Terraform. Available options for version:
- `1.2.3` exact version to install
- `latest` installs latest version
```console
$ terraenv terraform install 0.12.15
$ terraenv terragrunt install 0.21.6
```
```console
$ terraenv terraform install latest
$ terraenv terragrunt install latest
```
### terraenv < terraform / terragrunt > list remote
#### .terraenv
If you use a [.terraenv](#.terraenv-file), `terraenv install` (no argument) will install the version written in it.
### terraenv <terraform/terragrunt> use <version>
Switch a version to use
```console
$ terraenv terraform use 0.11.14
$ terraenv terragrunt use 0.21.6
```
### terraenv uninstall <terraform/terragrunt> <version>
Uninstall a specific version of Terraform
```console
$ terraenv terraform uninstall 0.12.15
$ terraenv terragrunt uninstall 0.21.5
```
### terraenv <terraform/terragrunt> list local
List installed versions
```console
% terraenv terraform list local
0.12
0.11.13
0.11.14
0.12.11
0.12.0
0.12.12
0.12.13
```
```console
% terraenv terragrunt list local
0.18.7
0.21.6
```
### terraenv <terraform/terragrunt> list remote
List installable versions
```console
% terraenv terraform list remote
...
0.11.3
0.11.4
0.11.5
0.11.6
0.11.7
0.11.8
0.11.9
0.11.10
0.11.11
0.11.12
0.11.13
0.11.14
0.12.0
0.12.1
0.12.2
0.12.3
0.12.4
0.12.5
0.12.6
0.12.7
0.12.8
0.12.9
0.12.10
0.12.11
0.12.12
0.12.13
0.12.14
0.12.15
```
## .terraenv file
If you put a `.terraenv` file on your project root, terraenv detects it and uses the version written in it.
```console
$ cat .terraenv
TERRAFORM=0.12.15
TERRAGRUNT=0.21.6
$ terraenv terraform install
$ terraform -version
Terraform v0.12.15
$ terraenv terragrunt install
$ terragrunt -version
terragrunt version v0.21.6
To use Terraform or Terragrunt version from `.terraenv` file present at your current directory path.
$ terraenv terraform use
$ terraenv terragrunt use
```
## LICENSE
- [terraenv](https://github.com/aaratn/terraenv/blob/master/LICENSE)
- [rbenv](https://github.com/rbenv/rbenv/blob/master/LICENSE)
## Inspiration
- [tfenv](https://github.com/tfutils/tfenv)
- [tgenv](https://github.com/cunymatthieu/tgenv)
- [rbenv](https://github.com/rbenv/rbenv)