tenv
tenv
OpenTofu, Terraform, Terragrunt, and Atmos version manager, written in Go.
·
Report Bug
·
Request Feature
About The Project
Welcome to tenv, a versatile version manager for OpenTofu, Terraform, Terragrunt and Atmos, written in Go. Our tool simplifies the complexity of handling different versions of these powerful tools, ensuring developers and DevOps professionals can focus on what matters most - building and deploying efficiently.
tenv is a successor of tofuenv and tfenv.
Key Features
- Versatile version management: Easily switch between different versions of OpenTofu, Terraform, Terragrunt and Atmos.
- Semver 2.0.0 Compatibility: Utilizes go-version for semantic versioning and use the HCL parser to extract required version constraint from OpenTofu/Terraform/Terragrunt files (see required_version and Terragrunt hcl).
- Signature verification: Supports cosign (if present on your machine) and PGP (via gopenpgp), see signature support.
- Intuitive installation: Simple installation process with Homebrew and manual options.
- Callable as Go module, with a Semver compatibility promise on tenvlib wrapper package (get more information in TENV_AS_LIB.md).
Difference with asdf
asdf-vm share the same goals than tenv : simplify the usage of several version of tools.
asdf-vm is generic and extensible with a plugin system, key tenv differences :
- tenv is more specific and has features dedicated to OpenTofu, Terraform, Terragrunt and Atmos, like HCL parsing based detection (see Key Features).
- tenv is distributed as independent binaries and does not rely on any shell or other CLI executable.
- tenv does better in terms of performance and platform compatibility. It works uniformly across all modern operating systems, including Linux, MacOS, Windows, BSD, and Solaris, whereas asdf-vm natively supports only Linux and MacOS.
- tenv checks the sha256 checksum and the signature of the checksum file with cosign. Check Signature support section for getting more information about it.
- tenv command compatibility: In nearly all places you can use the exact syntax that works in tfenv / tofuenv. If you’re coming from tfenv/tofuenv and comfortable with that way of working you can almost always use the same syntax with tenv.
- tenv performance: It sounds incredibly useful, though it might be tough to get a real apples to apples comparison since the tools work differently in a lot of ways. The author of asdf did a great writeup of performance problems. asdf-vm is written in bash which certainly makes it challenging to be performant, whereas tenv is written in Golang and works much faster.
Table of Contents
Table of Contents
Getting Started
Prerequisites
If you need to enable cosign checks, install cosign (v.2.0+) tool via one of the following commands:
MacOS (Homebrew)
```sh brew install cosign ```
Windows (go install)
```sh go install github.com/sigstore/cosign/v2/cmd/cosign@latest ```
Alpine Linux
```sh apk add cosign ```
Arch Linux
```sh sudo pacman -S cosign ```
Linux: RPM
```sh LATEST_VERSION=$(curl https://api.github.com/repos/sigstore/cosign/releases/latest | jq -r .tag_name | tr -d "v") curl -O -L "https://github.com/sigstore/cosign/releases/latest/download/cosign-${LATEST_VERSION}-1.x86_64.rpm" sudo rpm -ivh cosign-${LATEST_VERSION}-1.x86_64.rpm ```
Linux: dkpg
```sh LATEST_VERSION=$(curl https://api.github.com/repos/sigstore/cosign/releases/latest | jq -r .tag_name | tr -d "v") curl -O -L "https://github.com/sigstore/cosign/releases/latest/download/cosign_${LATEST_VERSION}_amd64.deb" sudo dpkg -i cosign_${LATEST_VERSION}_amd64.deb ```
Installation
Automatic Installation
Arch Linux (AUR, Nix)
This package is available on the Arch Linux User Repository. It can be installed using the yay AUR helper: ```sh yay tenv-bin ``` Installation via Nix package manager: ```sh nix-env -i tenv ```
MacOS (Homebrew, Nix)
```console brew install tenv ``` Installation via Nix package manager: ```console nix-env -i tenv ```
Windows (Chocolatey, Scoop, Nix)
Installation via Chocolatey: ```console choco install tenv ``` Installation via Scoop: ```console scoop install tenv ``` Installation via Nix package manager: ```console nix-env -i tenv ```
Linux: Snapcraft
```sh snap install tenv ```
Alpine
```sh apk add tenv --repository=http://dl-cdn.alpinelinux.org/alpine/edge/testing/ ```
Ubuntu
#### Install via dpkg ```sh LATEST_VERSION=$(curl --silent https://api.github.com/repos/tofuutils/tenv/releases/latest | jq -r .tag_name) curl -O -L "https://github.com/tofuutils/tenv/releases/latest/download/tenv_${LATEST_VERSION}_amd64.deb" sudo dpkg -i "tenv_${LATEST_VERSION}_amd64.deb" ``` #### Install via Nix Installation via Nix package manager: ```console nix-env -i tenv ```
Manual Installation
Get the most recent packaged binaries (.deb, .rpm, .apk, pkg.tar.zst , .zip or .tar.gz format) by visiting the release page. After downloading, unzip the folder and seamlessly integrate it into your system’s PATH.
Docker Installation
You can use dockerized version of tenv via the following command:
docker run -it --rm tofuutils/tenv:latest help
The docker container is not meant as a way to run tenv for CI pipelines, for local use, you should use one of the packaged binaries.
Install shell completion
[!NOTE] If you install tenv via Brew or Nix, completion will be installed automatically.
zsh
```console tenv completion zsh > ~/.tenv.completion.zsh echo "source \$HOME/.tenv.completion.zsh" >> ~/.zshrc ```
Oh My Zsh
```console tenv completion zsh > ~/.oh-my-zsh/completions/_tenv ``` Make sure the completions folder `~/.oh-my-zsh/completions` is listed under `$fpath`: ```console print -l $fpath ```
powershell
```console tenv completion powershell | Out-String | Invoke-Expression ```
bash
```console tenv completion bash > ~/.tenv.completion.bash echo "source \$HOME/.tenv.completion.bash" >> ~/.bashrc ```
fish
```console tenv completion fish > ~/.tenv.completion.fish echo "source \$HOME/.tenv.completion.fish" >> ~/.config/fish/config.fish ```
Usage
tenv supports OpenTofu,
Terragrunt, Terraform and
Atmos. To manage each binary you can use tenv <tool> <command>. Below is a list of tools and commands that use actual subcommands:
| tool (alias) | env vars | description |
|---|---|---|
tofu (opentofu) |
TOFUENV_ | OpenTofu |
tf (terraform) |
TFENV_ | Terraform |
tg (terragrunt) |
TG_ | Terragrunt |
at (atmos) |
ATMOS_ | Atmos |
Without subcommand tenv display interactive menus to manage tools and their versions.
tenv <tool> install [version]
Install a requested version of the tool (into `TENV_ROOT` directory from `
tenv <tool> use <version>
Switch the default tool version to use (set in `TENV_ROOT/
tenv <tool> detect
Detect the used version of tool for the working directory. ```console $ tenv tofu detect No version files found for OpenTofu, fallback to latest-allowed strategy Scan project to find .tf files No OpenTofu version requirement found in project files, fallback to latest strategy Found compatible version installed locally : 1.6.1 OpenTofu 1.6.1 will be run from this directory. $ tenv tg detect -q Terragrunt 0.55.1 will be run from this directory. $ tenv atmos detect -q Atmos 1.72.0 will be run from this directory. ```
tenv <tool> reset
Reset used version of tool (remove `TENV_ROOT/
tenv <tool> uninstall [version]
Uninstall versions of the tool (remove it from `TENV_ROOT` directory). Without parameter, display an interactive list to select several versions. If a parameter is passed, available parameter options: - an exact [Semver 2.0.0](https://semver.org/) version string to remove (no confirmation required) - a [version constraint](https://opentofu.org/docs/language/expressions/version-constraints) string - `all` - `but-last` (all versions except the highest installed) - `not-used-for:
tenv <tool> list
List installed tool versions (located in `TENV_ROOT` directory), sorted in ascending version order. `tenv
tenv <tool> list-remote
List installable tool versions (from `
tenv <tool> constraint [expression]
Set or reset a default constraint expression for the tool. ```console $ tenv tf constraint "<= 1.5.7" Written <= 1.5.7 in /home/dvaumoron/.tenv/Terraform/constraint ``` Or without expression : ```console $ tenv tg constraint Removed /home/dvaumoron/.tenv/Terragrunt/constraint ```
tenv help [command]
Help about any command. You can use `--help` `-h` flag instead. ```console $ tenv help tf detect Display Terraform current version. Usage: tenv tf detect [flags] Flags: -a, --arch string specify arch for binaries downloading (default "amd64") -f, --force-remote force search on versions available at TFENV_REMOTE url -h, --help help for detect -k, --key-file string local path to PGP public key file (replace check against remote one) -n, --no-install disable installation of missing version -c, --remote-conf string path to remote configuration file (advanced settings) -u, --remote-url string remote url to install from Global Flags: -q, --quiet no unnecessary output (and no log) -r, --root-path string local path to install versions of OpenTofu, Terraform and Terragrunt (default "/home/dvaumoron/.tenv") -v, --verbose verbose output (and set log level to Trace) ``` ```console $ tenv tofu use -h Switch the default OpenTofu version to use (set in TENV_ROOT/OpenTofu/version file) Available parameter options: - an exact Semver 2.0.0 version string to use - a version constraint expression (checked against version available in TENV_ROOT directory) - latest, latest-stable or latest-pre (checked against version available in TENV_ROOT directory) - latest-allowed or min-required to scan your OpenTofu files to detect which version is maximally allowed or minimally required. Usage: tenv tofu use version [flags] Flags: -a, --arch string specify arch for binaries downloading (default "amd64") -f, --force-remote force search on versions available at TOFUENV_REMOTE url -t, --github-token string GitHub token (increases GitHub REST API rate limits) -h, --help help for use -k, --key-file string local path to PGP public key file (replace check against remote one) -n, --no-install disable installation of missing version -c, --remote-conf string path to remote configuration file (advanced settings) -u, --remote-url string remote url to install from -w, --working-dir create .opentofu-version file in working directory Global Flags: -q, --quiet no unnecessary output (and no log) -r, --root-path string local path to install versions of OpenTofu, Terraform and Terragrunt (default "/home/dvaumoron/.tenv") -v, --verbose verbose output (and set log level to Trace) ```
tenv update-path
Display PATH updated with tenv directory location first. With GITHUB_ACTIONS set to true, write tenv directory location to GITHUB_PATH. This command can be used when one of the managed tool is already installed on your system and hide the corresponding proxy (in that case `which tenv` and `which
tenv version
Display tenv current version. ```console $ tenv version tenv version v1.7.0 ```
TENV_ARCH
String (Default: current tenv binaries architecture) Allow to override the default architecture for binaries downloading during installation. `tenv
TENV_AUTO_INSTALL
String (Default: false) If set to true **tenv** will automatically install missing tool versions needed. `tenv
TENV_DETACHED_PROXY
String (Default: false) Enable **tenv** proxies detached behaviour (use a new process group id when launching tool command, allow to avoid killing proxied tool process earlier than expected when proxies redirect interrupt signal already sended to whole process group (issue occurrences known on macOS)).
TENV_FORCE_REMOTE
String (Default: false) If set to true **tenv** detection of needed version will skip local check and verify compatibility on remote list. `tenv
TENV_GITHUB_TOKEN
String (Default: "") Allow to specify a GitHub token to increase [GitHub Rate limits for the REST API](https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api). Useful because OpenTofu, Terragrunt and Atmos binaries are downloaded from GitHub repository. `tenv tofu` and `tenv tg` subcommands `detect`, `install`, `list-remote` and `use` support a `--github-token`, `-t` flag version.
TENV_QUIET
String (Default: false) If set to true **tenv** disable unnecessary output (including log level forced to off). `tenv` subcommands support a `--quiet`, `-q` flag version.
TENV_LOG
String (Default: "warn") Set **tenv** log level (possibilities sorted by decreasing verbosity : "trace", "debug", "info", "warn", "error", "off"). `tenv` support a `--verbose`, `-v` flag which set log level to "trace".
TENV_REMOTE_CONF
String (Default: `${TENV_ROOT}/remote.yaml`) The path to a yaml file for [advanced remote configuration](#advanced-remote-configuration) (can be used to call artifact mirror). `tenv
TENV_ROOT
String (Default: `${HOME}/.tenv`) The path to a directory where the local OpenTofu versions, Terraform versions, Terragrunt versions and tenv configuration files exist. `tenv` support a `--root-path`, `-r` flag version.
GITHUB_ACTIONS
String (Default: false) If set to true **tenv** proxies exposes proxied output `stdout`, `stderr`, and `exitcode` by writing them into GITHUB_OUTPUT in [multiline format](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#multiline-strings). GitHub Actions set it (see [default environment variables](https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables)).
GITHUB_OUTPUT
String (Default: "") Needed when GITHUB_ACTIONS is set to true, path to a file to write proxied output.
GITHUB_PATH
String (Default: "") Used by `tenv update-path` when GITHUB_ACTIONS is set to true, path to a file to write tenv directory location.
TOFUENV_ARCH
Same as TENV_ARCH (compatibility with [tofuenv](https://github.com/tofuutils/tofuenv)).
TOFUENV_AUTO_INSTALL
Same as TENV_AUTO_INSTALL (compatibility with [tofuenv](https://github.com/tofuutils/tofuenv)). #### Example 1 Use OpenTofu version 1.6.1 that is not installed, and auto installation stay disabled : ```console $ tenv use 1.6.1 Written 1.6.1 in /home/dvaumoron/.tenv/OpenTofu/version ``` #### Example 2 Use OpenTofu version 1.6.0 that is not installed, and auto installation is enabled : ```console $ TOFUENV_AUTO_INSTALL=true tenv tofu use 1.6.0 Installing OpenTofu 1.6.0 Fetching release information from https://api.github.com/repos/opentofu/opentofu/releases/tags/v1.6.0 Downloading https://github.com/opentofu/opentofu/releases/download/v1.6.0/tofu_1.6.0_linux_amd64.zip Downloading https://github.com/opentofu/opentofu/releases/download/v1.6.0/tofu_1.6.0_SHA256SUMS Downloading https://github.com/opentofu/opentofu/releases/download/v1.6.0/tofu_1.6.0_SHA256SUMS.sig Downloading https://github.com/opentofu/opentofu/releases/download/v1.6.0/tofu_1.6.0_SHA256SUMS.pem Installation of OpenTofu 1.6.0 successful Written 1.6.0 in /home/dvaumoron/.tenv/OpenTofu/version ```
TOFUENV_FORCE_REMOTE
Same as TENV_FORCE_REMOTE.
TOFUENV_INSTALL_MODE
String (the default depend on TOFUENV_REMOTE, without change on it, it is "api" else it is "direct") - "api" install mode retrieve download url of OpenTofu from [Github REST API](https://docs.github.com/en/rest?apiVersion=2022-11-28) (TOFUENV_REMOTE must comply with it). - "direct" install mode generate download url of OpenTofu based on TOFUENV_REMOTE. - "mirror" install mode generate download url with TOFUENV_URL_TEMPLATE (as specified in [TofuDL mirror specification](https://github.com/opentofu/tofudl/blob/mirror-spec/MIRROR-SPECIFICATION.md)) See [advanced remote configuration](#advanced-remote-configuration) for more details.
TOFUENV_LIST_MODE
String (the default depend on TOFUENV_LIST_URL, without change on it, it is "api" else it is "html") - "api" list mode retrieve information of OpenTofu releases from [Github REST API](https://docs.github.com/en/rest?apiVersion=2022-11-28) (TOFUENV_LIST_URL must comply with it). - "html" list mode extract information of OpenTofu releases from parsing an html page at TOFUENV_LIST_URL. - "mirror" list mode retrieve information of OpenTofu releases at TOFUENV_LIST_URL as [TofuDL Mirroring format](https://get.opentofu.org/tofu/api.json) See [advanced remote configuration](#advanced-remote-configuration) for more details.
TOFUENV_LIST_URL
String (Default: copy TOFUENV_REMOTE, default is overloaded by "https://get.opentofu.org/tofu/api.json" when TOFUENV_LIST_MODE is "mirror") Allow to override the remote url only for the releases listing. See [advanced remote configuration](#advanced-remote-configuration) for more details.
TOFUENV_OPENTOFU_PGP_KEY
String (Default: "") Allow to specify a local file path to OpenTofu PGP public key, if not present download https://get.opentofu.org/opentofu.asc. `tenv tofu` subcommands `detect`, `ìnstall` and `use` support a `--key-file`, `-k` flag version.
TOFUENV_REMOTE
String (Default: https://api.github.com/repos/opentofu/opentofu/releases) URL to install OpenTofu, when TOFUENV_REMOTE differ from its default value, TOFUENV_INSTALL_MODE is set to "direct" and TOFUENV_LIST_MODE is set to "html" (assume an artifact proxy usage). `tenv tofu` subcommands `detect`, `install`, `list-remote` and `use` support a `--remote-url`, `-u` flag version. See [advanced remote configuration](#advanced-remote-configuration) for more details.
TOFUENV_REMOTE_PASSWORD
String (Default: "") Could be used with TOFUENV_REMOTE_USER to specify HTTP basic auth when same credential are used with TOFUENV_REMOTE and TOFUENV_LIST_URL (instead of `https://user:password@host.org` URL format).
TOFUENV_REMOTE_USER
String (Default: "") Could be used with TOFUENV_REMOTE_PASSWORD to specify HTTP basic auth when same credential are used with TOFUENV_REMOTE and TOFUENV_LIST_URL (instead of `https://user:password@host.org` URL format).
TOFUENV_ROOT
Same as TENV_ROOT (compatibility with [tofuenv](https://github.com/tofuutils/tofuenv)).
TOFUENV_URL_TEMPLATE
String (Default: `https://github.com/opentofu/opentofu/releases/download/v/`) Used when TOFUENV_INSTALL_MODE is "mirror" (see [TofuDL mirror specification](https://github.com/opentofu/tofudl/blob/mirror-spec/MIRROR-SPECIFICATION.md)).
TOFUENV_GITHUB_TOKEN
Same as TENV_GITHUB_TOKEN (compatibility with [tofuenv](https://github.com/tofuutils/tofuenv)).
TOFUENV_TOFU_DEFAULT_CONSTRAINT
String (Default: "") If not empty string, this variable overrides OpenTofu default constraint, specified in ${TENV_ROOT}/OpenTofu/constraint file.
TOFUENV_TOFU_DEFAULT_VERSION
String (Default: "") If not empty string, this variable overrides OpenTofu fallback version, specified in ${TENV_ROOT}/OpenTofu/version file.
TOFUENV_TOFU_VERSION
String (Default: "") If not empty string, this variable overrides OpenTofu version, specified in [`.opentofu-version`](#opentofu-version-files) files. `tenv tofu` subcommands `install` and `detect` also respects this variable. e.g. with : ```console $ tofu version OpenTofu v1.6.1 on linux_amd64 ``` then : ```console $ TOFUENV_TOFU_VERSION=1.6.0 tofu version OpenTofu v1.6.0 on linux_amd64 ```
TFENV_ARCH
Same as TENV_ARCH (compatibility with [tfenv](https://github.com/tfutils/tfenv)).
TFENV_AUTO_INSTALL
Same as TENV_AUTO_INSTALL (compatibility with [tfenv](https://github.com/tfutils/tfenv)).
TFENV_FORCE_REMOTE
Same as TENV_FORCE_REMOTE.
TFENV_HASHICORP_PGP_KEY
String (Default: "") Allow to specify a local file path to Hashicorp PGP public key, if not present download https://www.hashicorp.com/.well-known/pgp-key.txt. `tenv tf` subcommands `detect`, `ìnstall` and `use` support a `--key-file`, `-k` flag version.
TFENV_INSTALL_MODE
String (Default: "api") - "api" install mode retrieve download url of Terraform from [Hashicorp Release API](https://releases.hashicorp.com/docs/api/v1) (TFENV_REMOTE must comply with it). - "direct" install mode generate download url of Terraform based on TFENV_REMOTE. See [advanced remote configuration](#advanced-remote-configuration) for more details.
TFENV_LIST_MODE
String (the default depend on TFENV_LIST_URL, without change on it, it is "api" else it is "html") - "api" list mode retrieve information of Terraform releases from [Hashicorp Release API](https://releases.hashicorp.com/docs/api/v1) (TFENV_LIST_URL must comply with it). - "html" list mode extract information of Terraform releases from parsing an html page in TFENV_LIST_URL. See [advanced remote configuration](#advanced-remote-configuration) for more details.
TFENV_LIST_URL
String (Default: copy TFENV_REMOTE) Allow to override the remote url only for the releases listing. See [advanced remote configuration](#advanced-remote-configuration) for more details.
TFENV_REMOTE
String (Default: https://releases.hashicorp.com) URL to install Terraform, changing it assume an artifact proxy use (TFENV_LIST_URL copy it, and if it differ from its default value, TFENV_LIST_MODE is set to "html", because an artifact proxy usage will not disturb the retrieving of index.json for a release, but will freeze the json list of releases). `tenv tf` subcommands `detect`, `install`, `list-remote` and `use` support a `--remote-url`, `-u` flag version. See [advanced remote configuration](#advanced-remote-configuration) for more details.
TFENV_REMOTE_PASSWORD
String (Default: "") Could be used with TFENV_REMOTE_USER to specify HTTP basic auth when same credential are used with TFENV_REMOTE and TFENV_LIST_URL (instead of `https://user:password@host.org` URL format).
TFENV_REMOTE_USER
String (Default: "") Could be used with TFENV_REMOTE_PASSWORD to specify HTTP basic auth when same credential are used with TFENV_REMOTE and TFENV_LIST_URL (instead of `https://user:password@host.org` URL format).
TFENV_ROOT
Same as TENV_ROOT (compatibility with [tfenv](https://github.com/tfutils/tfenv)).
TFENV_TERRAFORM_DEFAULT_CONSTRAINT
String (Default: "") If not empty string, this variable overrides Terraform default constraint, specified in ${TENV_ROOT}/Terraform/constraint file.
TFENV_TERRAFORM_DEFAULT_VERSION
String (Default: "") If not empty string, this variable overrides Terraform fallback version, specified in ${TENV_ROOT}/Terraform/version file.
TFENV_TERRAFORM_VERSION
String (Default: "") If not empty string, this variable overrides Terraform version, specified in [`.terraform-version`](#terraform-version-files) files. `tenv tf` subcommands `install` and `detect` also respects this variable. e.g. with : ```console $ terraform version Terraform v1.7.2 on linux_amd64 ``` then : ```console $ TFENV_TERRAFORM_VERSION=1.7.0 terraform version Terraform v1.7.0 on linux_amd64 Your version of Terraform is out of date! The latest version is 1.7.2. You can update by downloading from https://www.terraform.io/downloads.html ```
TG_INSTALL_MODE
String (the default depend on TG_REMOTE, without change on it, it is "api" else it is "direct") - "api" install mode retrieve download url of Terragrunt from [Github REST API](https://docs.github.com/en/rest?apiVersion=2022-11-28) (TG_REMOTE must comply with it). - "direct" install mode generate download url of Terragrunt based on TG_REMOTE. See [advanced remote configuration](#advanced-remote-configuration) for more details.
TG_LIST_MODE
String (the default depend on TG_LIST_URL, without change on it, it is "api" else it is "html") - "api" list mode retrieve information of Terragrunt releases from [Github REST API](https://docs.github.com/en/rest?apiVersion=2022-11-28) (TG_LIST_URL must comply with it). - "html" list mode extract information of Terragrunt releases from parsing an html page in TG_LIST_URL. See [advanced remote configuration](#advanced-remote-configuration) for more details.
TG_LIST_URL
String (Default: copy TG_REMOTE) Allow to override the remote url only for the releases listing. See [advanced remote configuration](#advanced-remote-configuration) for more details.
TG_REMOTE
String (Default: https://api.github.com/repos/gruntwork-io/terragrunt/releases) URL to install Terragrunt, when TG_REMOTE differ from its default value, TG_INSTALL_MODE is set to "direct" and TG_LIST_MODE is set to "html" (assume an artifact proxy usage). `tenv tg` subcommands `detect`, `install`, `list-remote` and `use` support a `--remote-url`, `-u` flag version. See [advanced remote configuration](#advanced-remote-configuration) for more details.
TG_REMOTE_PASSWORD
String (Default: "") Could be used with TG_REMOTE_USER to specify HTTP basic auth when same credential are used with TG_REMOTE and TG_LIST_URL (instead of `https://user:password@host.org` URL format).
TG_REMOTE_USER
String (Default: "") Could be used with TG_REMOTE_PASSWORD to specify HTTP basic auth when same credential are used with TG_REMOTE and TG_LIST_URL (instead of `https://user:password@host.org` URL format).
TG_DEFAULT_CONSTRAINT
String (Default: "") If not empty string, this variable overrides Terragrunt default constraint, specified in ${TENV_ROOT}/Terragrunt/constraint file.
TG_DEFAULT_VERSION
String (Default: "") If not empty string, this variable overrides Terragrunt fallback version, specified in ${TENV_ROOT}/Terragrunt/version file.
TG_VERSION
String (Default: "") If not empty string, this variable overrides Terragrunt version, specified in [`.terragrunt-version`](#terragrunt-version-files) files. `tenv tg` subcommands `install` and `detect` also respects this variable. e.g. with : ```console $ terragrunt -v terragrunt version v0.55.1 ``` then : ```console $ TG_VERSION=0.54.1 terragrunt -v terragrunt version v0.54.1 ```
ATMOS_INSTALL_MODE
String (the default depend on ATMOS_REMOTE, without change on it, it is "api" else it is "direct") - "api" install mode retrieve download url of Atmos from [Github REST API](https://docs.github.com/en/rest?apiVersion=2022-11-28) (ATMOS_REMOTE must comply with it). - "direct" install mode generate download url of Atmos based on ATMOS_REMOTE. See [advanced remote configuration](#advanced-remote-configuration) for more details.
ATMOS_LIST_MODE
String (the default depend on ATMOS_LIST_URL, without change on it, it is "api" else it is "html") - "api" list mode retrieve information of Atmos releases from [Github REST API](https://docs.github.com/en/rest?apiVersion=2022-11-28) (ATMOS_LIST_URL must comply with it). - "html" list mode extract information of Atmos releases from parsing an html page in ATMOS_LIST_URL. See [advanced remote configuration](#advanced-remote-configuration) for more details.
ATMOS_LIST_URL
String (Default: copy ATMOS_REMOTE) Allow to override the remote url only for the releases listing. See [advanced remote configuration](#advanced-remote-configuration) for more details.
ATMOS_REMOTE
String (Default: https://api.github.com/repos/cloudposse/atmos/releases) URL to install Atmos when ATMOS_REMOTE differ from its default value, ATMOS_INSTALL_MODE is set to "direct" and ATMOS_LIST_MODE is set to "html" (assume an artifact proxy usage). `tenv atmos` subcommands `detect`, `install`, `list-remote` and `use` support a `--remote-url`, `-u` flag version. See [advanced remote configuration](#advanced-remote-configuration) for more details.
ATMOS_REMOTE_PASSWORD
String (Default: "") Could be used with ATMOS_REMOTE_USER to specify HTTP basic auth when same credential are used with ATMOS_REMOTE and ATMOS_LIST_URL (instead of `https://user:password@host.org` URL format).
ATMOS_REMOTE_USER
String (Default: "") Could be used with ATMOS_REMOTE_PASSWORD to specify HTTP basic auth when same credential are used with ATMOS_REMOTE and ATMOS_LIST_URL (instead of `https://user:password@host.org` URL format).
ATMOS_DEFAULT_CONSTRAINT
String (Default: "") If not empty string, this variable overrides Atmos default constraint, specified in ${TENV_ROOT}/Atmos/constraint file.
ATMOS_DEFAULT_VERSION
String (Default: "") If not empty string, this variable overrides Atmos fallback version, specified in ${TENV_ROOT}/Atmos/version file.
ATMOS_VERSION
String (Default: "") If not empty string, this variable overrides Atmos version, specified in [`.atmos-version`](#atmos-version-files) files. `tenv atmos` subcommands `install` and `detect` also respects this variable. e.g. with : ```console $ atmos version 👽 Atmos v1.72.0 on linux/amd64 ``` then : ```console $ ATMOS_VERSION=1.70 atmos version 👽 Atmos v1.70.0 on linux/amd64 ```
default version file
The `TENV_ROOT/
opentofu version files
If you put a `.opentofu-version` file in the working directory, one of its parent directory, or user home directory, **tenv** detects it and uses the version written in it. Note, that TOFUENV_TOFU_VERSION can be used to override version specified by `.opentofu-version` file. Recognize same values as `tenv tofu use` command. See [required_version](https://opentofu.org/docs/language/settings#specifying-a-required-opentofu-version) docs.
terraform version files
If you put a `.terraform-version` or `.tfswitchrc` file in the working directory, one of its parent directory, or user home directory, **tenv** detects it and uses the version written in it. Note, that TFENV_TERRAFORM_VERSION can be used to override version specified by those files. Recognize same values as `tenv tf use` command. See [required_version](https://developer.hashicorp.com/terraform/language/settings#specifying-a-required-terraform-version) docs.
terragrunt version files
If you put a `.terragrunt-version` or a `.tgswitchrc` file in the working directory, one of its parent directory, or user home directory, **tenv** detects it and uses the version written in it. **tenv** also detect a `version` field in a `.tgswitch.toml` in same places. Note, that TG_VERSION can be used to override version specified by those files. Recognize same values as `tenv tg use` command.
terragrunt.hcl file
If you have a terragrunt.hcl or terragrunt.hcl.json in the working directory, one of its parent directory, or user home directory, **tenv** will read constraint from `terraform_version_constraint` or `terragrunt_version_constraint` field in it (depending on proxy or subcommand used).
atmos version files
If you put a `.atmos-version` file in the working directory, one of its parent directory, or user home directory, **tenv** detects it and uses the version written in it. Note, that ATMOS_VERSION can be used to override version specified by those files. Recognize same values as `tenv atmos use` command.
required_version
the `latest-allowed` or `min-required` strategies scan through your IAC files (see list in [project binaries](#project-binaries)) and identify a version conforming to the constraint in the relevant files. They fallback to `latest` when no IAC files and no default constraint are found, and can optionally be used with a default constraint as detailed in [project binaries](#project-binaries). Currently the format for [Terraform required_version](https://developer.hashicorp.com/terraform/language/settings#specifying-a-required-terraform-version) and [OpenTofu required_version](https://opentofu.org/docs/language/settings#specifying-a-required-opentofu-version) are very similar, however this may change over time, always refer to docs for the latest format specification. example: ```HCL version = ">= 1.2.0, < 2.0.0" ``` This would identify the latest version at or above 1.2.0 and below 2.0.0
tofu
The `tofu` command in this project is a proxy to OpenTofu's `tofu` command managed by **tenv**. The version resolution order is : - TOFUENV_TOFU_VERSION environment variable - `.opentofu-version` file - `terraform_version_constraint` from `terragrunt.hcl` file - `terraform_version_constraint` from `terragrunt.hcl.json` file - TOFUENV_TOFU_DEFAULT_VERSION environment variable - `${TENV_ROOT}/OpenTofu/version` file (can be written with `tenv tofu use`) - `latest-allowed` The `latest-allowed` strategy rely on [required_version](#required_version) from .tofu, .tofu.json, .tf or .tf.json files with a fallback to `latest` when no constraint are found. Moreover it is possible to add a default constraint with TOFUENV_TOFU_DEFAULT_CONSTRAINT environment variable or `${TENV_ROOT}/OpenTofu/constraint` file (can be written with `tenv tofu constraint`). The default constraint is added while using `latest-allowed`, `min-required` or custom constraint. A default constraint with `latest-allowed` or `min-required` will avoid the fallback to `latest` when there is no .tf or .tf.json files.
terraform
The `terraform` command in this project is a proxy to HashiCorp's `terraform` command managed by **tenv**. The version resolution order is : - TFENV_TERRAFORM_VERSION environment variable - `.terraform-version` file - `.tfswitchrc` file - `terraform_version_constraint` from `terragrunt.hcl` file - `terraform_version_constraint` from `terragrunt.hcl.json` file - TFENV_TERRAFORM_DEFAULT_VERSION environment variable - `${TENV_ROOT}/Terraform/version` file (can be written with `tenv tf use`) - `latest-allowed` The `latest-allowed` strategy rely on [required_version](#required_version) from .tf or .tf.json files with a fallback to `latest` when no constraint are found. Moreover it is possible to add a default constraint with TFENV_TERRAFORM_DEFAULT_CONSTRAINT environment variable or `${TENV_ROOT}/Terraform/constraint` file (can be written with `tenv tf constraint`). The default constraint is added while using `latest-allowed`, `min-required` or custom constraint. A default constraint with `latest-allowed` or `min-required` will avoid the fallback to `latest` when there is no .tf or .tf.json files.
terragrunt
The `terragrunt` command in this project is a proxy to Gruntwork's `terragrunt` command managed by **tenv**. The version resolution order is : - TG_VERSION environment variable - `.terragrunt-version` file - `.tgswitchrc` file - `version` from `tgswitch.toml` file - `terragrunt_version_constraint` from `terragrunt.hcl` file - `terragrunt_version_constraint` from `terragrunt.hcl.json` file - TG_DEFAULT_VERSION environment variable - `${TENV_ROOT}/Terragrunt/version` file (can be written with `tenv tg use`) - `latest-allowed` The `latest-allowed` strategy has no information for Terragrunt and will fallback to `latest` unless there is default constraint. Adding a default constraint could be done with TG_DEFAULT_CONSTRAINT environment variable or `${TENV_ROOT}/Terragrunt/constraint` file (can be written with `tenv tg constraint`). The default constraint is added while using `latest-allowed`, `min-required` or custom constraint. A default constraint with `latest-allowed` or `min-required` will avoid there fallback to `latest`.
atmos
The `atmos` command in this project is a proxy to Cloudposse's `atmos` command managed by **tenv**. The version resolution order is : - ATMOS_VERSION environment variable - `.atmos-version` file - ATMOS_DEFAULT_VERSION environment variable - `${TENV_ROOT}/Atmos/version` file (can be written with `tenv atmos use`) - `latest-allowed` The `latest-allowed` strategy has no information for Atmos and will fallback to `latest` unless there is default constraint. Adding a default constraint could be done with ATMOS_DEFAULT_CONSTRAINT environment variable or `${TENV_ROOT}/Atmos/constraint` file (can be written with `tenv atmos constraint`). The default constraint is added while using `latest-allowed`, `min-required` or custom constraint. A default constraint with `latest-allowed` or `min-required` will avoid there fallback to `latest`.
tf
The `tf` command is a proxy to `tofu` or `terraform` depending on the version files present in project. The version resolution order is : - `.opentofu-version` file (launch `tofu`) - `terraform_version_constraint` from `terragrunt.hcl` file (launch `tofu`) - `terraform_version_constraint` from `terragrunt.hcl.json` file (launch `tofu`) - `.terraform-version` file (launch `terraform`) - `.tfswitchrc` file (launch `terraform`) - fail with a message
yaml fields description
Each part can have the following string field : `install_mode`, `list_mode`, `list_url`, `url`, `new_base_url`, `old_base_url`, `selector` and `part` With `install_mode` set to "direct", **tenv** skip the release information fetching and generate download url instead of reading them from API (overridden by `
Examples
Those examples assume that a GitHub proxy at https://artifactory.example.com/artifactory/github have the same behavior than [JFrog Artifactory](https://jfrog.com/artifactory) : - mirror https://github.com/opentofu/opentofu/releases/download/v1.6.0/tofu_1.6.0_linux_amd64.zip at https://artifactory.example.com/artifactory/github/opentofu/opentofu/releases/download/v1.6.0/tofu_1.6.0_linux_amd64.zip. - have at https://artifactory.example.com/artifactory/github/opentofu/opentofu/releases/download an html page with links on existing sub folder like "v1.6.0/" Example 1 : Retrieve Terraform binaries and list available releases from the mirror (TFENV_LIST_MODE is optional because TFENV_LIST_URL differ from its default(when TFENV_LIST_URL is not set, it copy TFENV_REMOTE)). ```console TFENV_REMOTE=https://artifactory.example.com/artifactory/hashicorp TFENV_LIST_MODE=html ``` Example 2 : Retrieve Terraform binaries from the mirror and list available releases from the Hashicorp releases API. ```console TFENV_REMOTE=https://artifactory.example.com/artifactory/hashicorp TFENV_LIST_URL=https://releases.hashicorp.com ``` Example 1 & 2, does not need install mode (by release index.json is figed in mirror without problem), however create a rewrite rule from "https://releases.hashicorp.com" to "https://artifactory.example.com/artifactory/hashicorp" to obtains correct download URLs. Example 3 : Retrieve OpenTofu binaries and list available releases from the mirror (TOFUENV_INSTALL_MODE and TOFUENV_LIST_MODE are optional because overloading TOFUENV_REMOTE already change them). ```console TOFUENV_REMOTE=https://artifactory.example.com/artifactory/github TOFUENV_INSTALL_MODE=direct TOFUENV_LIST_MODE=html ``` Example 4 : Retrieve OpenTofu binaries from the mirror and list available releases from the GitHub API (TOFUENV_INSTALL_MODE is optional because overloading TOFUENV_REMOTE already set it to "direct"). ```console TOFUENV_REMOTE=https://artifactory.example.com/artifactory/github TOFUENV_INSTALL_MODE=direct TOFUENV_LIST_URL=https://api.github.com/repos/opentofu/opentofu/releases ``` Example 3 & 4, does not create a rewrite rule (the direct install mode build correct download URLs). Example 1 & 4 can be merged in a remote.yaml : ```yaml tofu: url: "https://artifactory.example.com/artifactory/github" install_mode: "direct" list_url: "https://api.github.com/repos/opentofu/opentofu/releases" terraform: url: "https://artifactory.example.com/artifactory/hashicorp" list_mode: "html" ```
OpenTofu signature support
**tenv** checks the sha256 checksum and the signature of the checksum file with [cosign](https://github.com/sigstore/cosign) (if present on your machine) or PGP (via [gopenpgp](https://github.com/ProtonMail/gopenpgp)). However, unstable OpenTofu versions are signed only with cosign (in this case, if cosign is not found tenv will display a warning).
Terraform signature support
**tenv** checks the sha256 checksum and the PGP signature of the checksum file (via [gopenpgp](https://github.com/ProtonMail/gopenpgp), there is no cosign signature available).
Terragrunt signature support
**tenv** checks the sha256 checksum (there is no signature available).
Atmos signature support
**tenv** checks the sha256 checksum (there is no signature available).