tenv

1. About The Project
   • Key Features
2. Table of contents
3. Getting Started
   • Prerequisites
   • Installation
4. Usage
5. Environment variables
6. Version files
7. Technical details
8. Contributing
9. Community
10. Authors
11. Licence

brew install cosign

apk add cosign

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}.x86_64.rpm

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

brew tap tofuutils/tap
brew install tenv

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"

Without a parameter, the version to use is resolved automatically via the relevant <TOOL>_VERSION environment variable or version file (searched in the working directory, user home directory, and <TOOL>_ROOT directory).

Will default to "latest-stable" when no specified version is found.

If a parameter is passed, available options include:

• an exact Semver 2.0.0 version string to install
• a version constraint string (checked against versions available at <TOOL>_REMOTE url)
• latest or latest-stable (checked against versions available at <TOOL>_REMOTE url)
• latest-allowed or min-required to scan your IAC files to detect which version is maximally allowed or minimally required. See required_version docs.

tenv <tool> install
tenv <tool> install 1.6.0-beta5
tenv <tool> install "~> 1.6.0"
tenv <tool> install latest
tenv <tool> install latest-stable
tenv <tool> install latest-allowed
tenv <tool> install min-required

Switch the default OpenTofu version to use (set in version file ).

tenv use has a --working-dir, -w flag to write version file file in working directory.

Available parameter options:

• an exact Semver 2.0.0 version string to install
• a version constraint string (checked against versions available at <TOOL>_REMOTE url)
• latest or latest-stable (checked against versions available at <TOOL>_REMOTE url)
• latest-allowed or min-required to scan your IAC files to detect which version is maximally allowed or minimally required. See required_version docs.

tenv <tool> use min-required
tenv <tool> use v1.6.0-beta5
tenv <tool> use latest
tenv <tool> use latest-allowed

Detect the used version of tool for the working directory.

$ tenv tofu detect
OpenTofu 1.6.0 will be run from this directory.

tenv <tool> reset

tenv <tool> uninstall v1.6.0-alpha4

List installed tool versions (located in <TOOL>_ROOT directory), sorted in ascending version order.

tenv <tool> list has a --descending, -d flag to sort in descending order.

$ tenv <tool> list
  1.6.0-rc1 
* 1.6.0 (set by /home/dvaumoron/.tenv/.opentofu-version)

tenv <tool> list-remote has a --descending, -d flag to sort in descending order.

tenv <tool> list-remote has a --stable, -s flag to display only stable version.

$ tenv <tool> list-remote
1.6.0-alpha1
1.6.0-alpha2
1.6.0-alpha3
1.6.0-alpha4
1.6.0-alpha5
1.6.0-beta1
1.6.0-beta2
1.6.0-beta3
1.6.0-beta4
1.6.0-beta5
1.6.0-rc1 (installed)
1.6.0 (installed)

You can use --help -h flag instead.

$ tenv help tf detect
Display Terraform current version.

Usage:
  tenv tf detect [flags]

Flags:
  -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:
  -r, --root-path string   local path to install versions of OpenTofu and Terraform (default "/home/nonroot/.tenv")
  -v, --verbose            verbose output

$ tenv tofu use -h
Switch the default OpenTofu version to use (set in .opentofu-version file in TOFUENV_ROOT)

Available parameter options:
- an exact Semver 2.0.0 version string to use
- a version constraint string (checked against version available in TOFUENV_ROOT directory)
- latest or latest-stable (checked against version available in TOFUENV_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:
  -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:
  -r, --root-path string   local path to install versions of OpenTofu and Terraform (default "/home/nonroot/.tenv")
  -v, --verbose            verbose output

If set to true tenv will automatically install a missing OpenTofu version needed (fallback to latest-allowed strategy when no .opentofu-version files are found).

tenv subcommands detect and use support a --no-install, -n disabling flag version.

Example:

Use OpenTofu version 1.6.1 that is not installed, and auto installation is disabled. (-v flag is equivalent to TOFUENV_VERBOSE=true):

$ TOFUENV_AUTO_INSTALL=false tenv use -v 1.6.1
Write 1.6.1 in /home/dvaumoron/.tenv/.opentofu-version

Example:

Use OpenTofu version 1.6.0 that is not installed, and auto installation stay enabled.

$ tenv use -v 1.6.0
Installation of OpenTofu 1.6.0
Write 1.6.0 in /home/dvaumoron/.tenv/.opentofu-version

If set to true tenv detection of needed version will skip local check and verify compatibility on remote list.

tenv subcommands detect and use support a --force-remote, -f flag version.

Allow to specify a local file path to OpenTofu PGP public key, if not present download https://get.opentofu.org/opentofu.asc.

tenv subcommands detect, ìnstall and use support a --key-file, -k flag version.

To install OpenTofu from a remote other than the default (must comply with Github REST API).

tenv tf subcommands detect, install, list-remote and use support a --remote-url, -u flag version.

String (Default: ${HOME}/.tenv)

The path to a directory where the local OpenTofu versions, Terraform versions and tenv configuration files exist.

tenv support a --root-path, -r flag version.

Allow to specify a GitHub token to increase GitHub Rate limits for the REST API. Useful because OpenTofu binares are downloaded from the OpenTofu GitHub repository.

tenv subcommands detect, install, list-remote and use support a --github-token, -t flag version.

Active the verbose display of tenv.

tenv support a --verbose, -v flag version.

If not empty string, this variable overrides OpenTofu version, specified in .opentofu-version files. tenv subcommands install and detect also respects this variable.

e.g. with :

$ tofu version
OpenTofu v1.6.0
on linux_amd64

then :

$ TOFUENV_TOFU_VERSION=1.6.0-rc1 tofu version
OpenTofu v1.6.0-rc1
on linux_amd64

If set to true tenv will automatically install a missing Terraform version needed (fallback to latest-allowed strategy when no .terraform-version files are found).

tenv tf subcommands detect and use support a --no-install, -n disabling flag version.

Example: Use Terraform version 1.6.0-rc1 that is not installed, and auto installation is disabled. (-v flag is equivalent to TFENV_VERBOSE=true)

$ TFENV_AUTO_INSTALL=false tenv tf use -v 1.6.0-rc1
Write 1.6.0-rc1 in /home/dvaumoron/.tenv/.terraform-version

Example: Use Terraform version 1.6.0-rc1 that is not installed, and auto installation stay enabled.

$ tenv tf use -v 1.6.0-rc1
Installation of Terraform 1.6.0-rc1
Write 1.6.0-rc1 in /home/dvaumoron/.tenv/.terraform-version

If set to true tenv detection of needed version will skip local check and verify compatibility on remote list.

tenv tf subcommands detect and use support a --force-remote, -f flag version.

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.

To install Terraform from a remote other than the default (must comply with Hashicorp Release API)

tenv tf subcommands detect, install, list-remote and use support a --remote-url, -u flag version.

The path to a directory where the local Terraform versions, OpenTofu versions and tenv configuration files exist.

tenv tf support a --root-path, -r flag version.

Active the verbose display of tenv.

tenv tf support a --verbose, -v flag version.

If not empty string, this variable overrides Terraform version, specified in .terraform-version files. tenv tf subcommands install and detect also respects this variable.

e.g. with :

$ terraform version
Terraform v1.6.0
on linux_amd64

then :

$ TFENV_TERRAFORM_VERSION=1.6.0-rc1 terraform version
Terraform v1.6.0-rc1
on linux_amd64

To install Terragrunt from a remote other than the default (must comply with Github REST API)

tenv tg subcommands detect, install, list-remote and use support a --remote-url, -u flag version.

If not empty string, this variable overrides Terragrunt version, specified in .terragrunt-version files. tenv tg subcommands install and detect also respects this variable.

e.g. with :

$ terragrunt -v
terragrunt version v0.54.22

then :

$ TG_VERSION=0.54.1 terragrunt -v
terragrunt version v0.54.1