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.
tgswitch is available for MacOS and Linux based operating systems.
Installation for MacOS is the easiest with Homebrew. If you do not have homebrew installed, click here.
brew install warrensbox/tap/tgswitchInstallation for Linux operation systems.
curl -L https://raw.githubusercontent.com/warrensbox/tgswitch/release/install.sh | bashAlternatively, you can install the binary from the source here.
- You can switch between different versions of terragrunt by typing the command
tgswitchon 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.
- You can also supply the desired version as an argument on the command line.
- For example,
tgswitch 0.37.1for version 0.37.1 of terragrunt. - Hit Enter to switch.
- You can also set the
TG_VERSIONenvironment variable to your desired terragrunt version. For example:
export TG_VERSION=0.37.0
tgswitch #will automatically switch to terragrunt version 0.37.0Use .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.tomlfile 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.tomlfile should look like this:
bin = "/usr/local/bin/terragrunt"
version = "0.34.0"- Run
tgswitchand 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/,tgswitchwill attempt to install terragrunt at$HOME/bin. Runexport PATH=$PATH:$HOME/binto append bin to PATH - For windows host,
tgswitchneed to be run underAdministratormode, and$HOME/.tgswitch.tomlwithbinmust be defined (with a valid path) as minimum, below is an example for$HOME/.tgswitch.tomlon windows
bin = "C:\\Users\\<%USRNAME%>\\bin\\terragrunt.exe"
- Create a
.tgswitchrcfile containing the desired version - For example,
echo "0.33.0" >> .tgswitchrcfor version 0.33.0 of terragrunt - Run the command
tgswitchin the same directory as your.tgswitchrc
Instead of a .tgswitchrc file, a .terragrunt-version file may be used as well
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"
...tgswitch --chdir terragrunt_dir
tgswitch -c terragrunt_dirAutomatically 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-tgswitchNOTE: 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-hookby 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
}Please open issues here: New Issue
N/A
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent