Terragrunt Switcher
The tgswitch
command line tool lets you switch between different versions of terragrunt.
If you do not have a particular version of terragrunt installed, tgswitch
will download the version you desire.
The installation is minimal and easy.
Once installed, simply select the version you require from the dropdown and start using terragrunt.
Installation
tgswitch
is available for MacOS and Linux based operating systems.
Homebrew
Installation for MacOS is the easiest with Homebrew. If you do not have homebrew installed, click here.
brew install warrensbox/tap/tgswitch
Linux
Installation for Linux operation systems.
curl -L https://raw.githubusercontent.com/warrensbox/tgswitch/release/install.sh | bash
Install from source
Alternatively, you can install the binary from the source here.
How to use:
Use dropdown menu to select version
- You can switch between different versions of terragrunt by typing the command
tgswitch
on your terminal. - Select the version of terragrunt you require by using the up and down arrow.
- Hit Enter to select the desired version.
The most recently selected versions are presented at the top of the dropdown.
Supply version on command line
- You can also supply the desired version as an argument on the command line.
- For example,
tgswitch 0.37.1
for version 0.37.1 of terragrunt. - Hit Enter to switch.
Use environment variables
- You can also set the
TG_VERSION
environment variable to your desired terragrunt version. For example:
export TG_VERSION=0.37.0
tgswitch #will automatically switch to terragrunt version 0.37.0
Use .tgswitch.toml file (For non-admin AND Apple M1 users with limited privilege on their computers)
Specify a custom binary path for your terragrunt installation
- Create a custom binary path. Ex:
mkdir /Users/uveerum/bin
(replace uveerum with your username) - Add the path to your PATH. Ex:
export PATH=$PATH:/Users/uveerum/bin
(add this to your bash profile or zsh profile) - Pass -b or --bin parameter with your custom path to install terragrunt. Ex:
tgswitch -b /Users/uveerum/bin/terragrunt 0.34.0
- Optionally, you can create a
.tgswitch.toml
file in your terragrunt directory(current directory) OR in your home directory(~/.tgswitch.toml). The toml file in the current directory has a higher precedence than toml file in the home directory - Your
.tgswitch.toml
file should look like this:
bin = "/usr/local/bin/terragrunt"
version = "0.34.0"
- Run
tgswitch
and it should automatically install the required terragrunt version in the specified binary path
NOTE
- For linux users that do not have write permission to
/usr/local/bin/
,tgswitch
will attempt to install terragrunt at$HOME/bin
. Runexport PATH=$PATH:$HOME/bin
to append bin to PATH - For windows host,
tgswitch
need to be run underAdministrator
mode, and$HOME/.tgswitch.toml
withbin
must be defined (with a valid path) as minimum, below is an example for$HOME/.tgswitch.toml
on windows
bin = "C:\\Users\\<%USRNAME%>\\bin\\terragrunt.exe"
Use .tgswitchrc file
- Create a
.tgswitchrc
file containing the desired version - For example,
echo "0.33.0" >> .tgswitchrc
for version 0.33.0 of terragrunt - Run the command
tgswitch
in the same directory as your.tgswitchrc
Instead of a .tgswitchrc
file, a .terragrunt-version
file may be used as well
Use terragrunt.hcl file
If a terragrunt.hcl file with the terragrunt constrain is included in the current directory, it should automatically download or switch to that terragrunt version. For example, the following should automatically switch terragrunt to version 0.36.0:
terragrunt_version_constraint = ">= 0.36, < 0.36.1"
...
Get the version from a subdirectory
tgswitch --chdir terragrunt_dir
tgswitch -c terragrunt_dir
Automatically switch with bash
Add the following to the end of your ~/.bashrc
file:
(Use either .tgswitchrc
or .tgswitch.toml
or .terragrunt-version
)
cdtgswitch(){
builtin cd "$@";
cdir=$PWD;
if [ -e "$cdir/.tgswitchrc" ]; then
tgswitch
fi
}
alias cd='cdtgswitch'
Automatically switch with zsh
Add the following to the end of your ~/.zshrc
file:
load-tgswitch() {
local tgswitchrc_path=".tgswitchrc"
if [ -f "$tgswitchrc_path" ]; then
tgswitch
fi
}
add-zsh-hook chpwd load-tgswitch
load-tgswitch
NOTE: if you see an error like this:
command not found: add-zsh-hook
, then you might be on an older version of zsh (see below), or you simply need to loadadd-zsh-hook
by adding this to your.zshrc
:autoload -U add-zsh-hook
older version of zsh
cd(){
builtin cd "$@";
cdir=$PWD;
if [ -e "$cdir/.tgswitchrc" ]; then
tgswitch
fi
}
Issues
Please open issues here: New Issue
Upcoming Features
N/A