Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cunymatthieu/tgenv
Terragrunt version manager
https://github.com/cunymatthieu/tgenv
Last synced: 3 months ago
JSON representation
Terragrunt version manager
- Host: GitHub
- URL: https://github.com/cunymatthieu/tgenv
- Owner: cunymatthieu
- License: mit
- Created: 2017-05-03T15:52:51.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-08T16:38:28.000Z (about 1 year ago)
- Last Synced: 2024-07-21T01:42:13.153Z (4 months ago)
- Language: Shell
- Homepage:
- Size: 20.5 KB
- Stars: 215
- Watchers: 11
- Forks: 68
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-env - tgenv
README
[](https://travis-ci.org/cunymatthieu/tgenv)
# tgenv
[Terragrunt](https://github.com/gruntwork-io/terragrunt) version manager inspired by [tfenv](https://github.com/kamatama41/tfenv)
## Support
Currently tgenv supports the following OSes
- Mac OS X (64bit)
- Linux (64bit)
## Installation
1. Check out tgenv into any path (here is `${HOME}/.tgenv`)
```bash
$ git clone https://github.com/cunymatthieu/tgenv.git ~/.tgenv
```
2. Add `~/.tgenv/bin` to your `$PATH` any way you like
```bash
$ echo 'export PATH="$HOME/.tgenv/bin:$PATH"' >> ~/.bash_profile
```
OR you can make symlinks for `tgenv/bin/*` scripts into a path that is already added to your `$PATH` (e.g. `/usr/local/bin`) `OSX/Linux Only!`
```bash
$ ln -s ~/.tgenv/bin/* /usr/local/bin
```
## Usage
### tgenv install
Install a specific version of terragrunt
`latest` is a syntax to install latest version
`latest:` is a syntax to install latest version matching regex (used by grep -e)
```bash
$ tgenv install 0.12.12
$ tgenv install latest
$ tgenv install latest:^0.9
```
If you use [.terragrunt-version](#terragrunt-version), `tgenv install` (no argument) will install the version written in it.
### tgenv use
Switch a version to use
`latest` is a syntax to use the latest installed version
`latest:` is a syntax to use latest installed version matching regex (used by grep -e)
```bash
$ tgenv use 0.12.1
$ tgenv use latest
$ tgenv use latest:^0.10
```
### tgenv uninstall
Uninstall a specific version of terragrunt
`latest` is a syntax to uninstall latest version
`latest:` is a syntax to uninstall latest version matching regex (used by grep -e)
```bash
$ tgenv uninstall 0.12.1
$ tgenv uninstall latest
$ tgenv uninstall latest:^0.9
```
### tgenv list
List installed versions
```bash
% tgenv list
0.12.15
0.12.8
0.10.0
0.9.9
```
### tgenv list-remote
List installable versions
```bash
% tgenv list-remote
0.12.15
0.12.14
0.12.13
0.12.12
0.12.11
0.12.10
0.12.9
0.12.8
0.12.7
0.12.6
0.12.5
0.12.4
0.12.3
0.12.2
0.12.1
0.12.0
0.11.1
0.11.0
0.10.3
0.10.2
0.10.1
0.10.0
0.9.9
...
```
## .terragrunt-version
If you put `.terragrunt-version` file on your project root, tgenv detects it and use the version written in it. If the version is `latest` or `latest:`, the latest matching version currently installed will be selected.
```bash
$ cat .terragrunt-version
0.9.9
$ terragrunt --version
terragrunt version v0.9.9
Your version of terragrunt is out of date! The latest version
is 0.7.3. You can update by downloading from www.terragrunt.io
$ echo 0.9.9 > .terragrunt-version
$ terragrunt --version
terragrunt v0.12.15
$ echo latest:^0.10 > .terragrunt-version
$ terragrunt --version
terragrunt v0.10.3
```
### Environment Variables
#### TGENV
##### `TGENV_AUTO_INSTALL`
String (Default: true)
Should tgenv automatically install terragrunt if the version specified by defaults or a .terragrunt-version file is not currently installed.
```console
TGENV_AUTO_INSTALL=false terragrunt plan
```
##### `TGENV_DEBUG`
Integer (Default: "")
Set the debug level for TGENV.
* unset/empty-string: No debug output
* set: Bash execution tracing
## Upgrading
```bash
$ git --git-dir=~/.tgenv/.git pull
```
## Uninstalling
```bash
$ rm -rf /some/path/to/tgenv
```
## LICENSE
- [tgenv itself](https://github.com/cunymatthieu/tgenv/blob/master/LICENSE)
- [tfenv ](https://github.com/kamatama41/tgenv/blob/master/LICENSE) : tfenv mainly uses tfenv's source code