From 0274f11d96596734770f5f05111ef5405d5632f8 Mon Sep 17 00:00:00 2001 From: Denis Vaumoron Date: Tue, 6 Feb 2024 12:14:35 +0100 Subject: [PATCH] improve README #48 --- README.md | 41 +++++++++-------------------------------- 1 file changed, 9 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 9d93969b..f10cfba2 100644 --- a/README.md +++ b/README.md @@ -518,62 +518,39 @@ Same as TENV_GITHUB_TOKEN (compatibility with [tofuenv](https://github.com/tofuu - -
TOFUENV_VERBOSE
-String (Default: false) - -Active the verbose display of **tenv**. - -`tenv` support a `--verbose`, `-v` flag version. -
-
TOFUENV_TOFU_VERSION
String (Default: "") If not empty string, this variable overrides OpenTofu version, specified in [`.opentofu-version`](#opentofu-version-file) files. -`tenv` subcommands `install` and `detect` also respects this variable. + +`tenv tofu` subcommands `install` and `detect` also respects this variable. e.g. with : ```console -$ tofu version -OpenTofu v1.6.0 +TENV_QUIET=t dist/tofu_linux_amd64_v1/tofu version +OpenTofu v1.6.1 on linux_amd64 ``` then : ```console -$ TOFUENV_TOFU_VERSION=1.6.0-rc1 tofu version -OpenTofu v1.6.0-rc1 +$ TENV_QUIET=t TOFUENV_TOFU_VERSION=1.6.0 dist/tofu_linux_amd64_v1/tofu version +OpenTofu v1.6.0 on linux_amd64 ``` +
### Terraform environment variables -
TFENV_AUTO_INSTALL
-String (Default: true) - -If set to true tenv will automatically install a missing Terraform version needed (fallback to latest-allowed strategy when no [`.terraform-version`](#terraform-version-file) 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`) -```console -$ TFENV_AUTO_INSTALL=false tenv tf use -v 1.6.0-rc1 -Write 1.6.0-rc1 in /home/dvaumoron/.tenv/.terraform-version -``` +
TFENV_AUTO_INSTALL
-Example: Use Terraform version 1.6.0-rc1 that is not installed, and auto installation stay enabled. +Same as TENV_AUTO_INSTALL (compatibility with [tfenv](https://github.com/tfutils/tfenv)). -```console -$ 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 -```