tfv 5.0.1 → 6.1.0

package/demo.tape

@@ -0,0 +1,230 @@
+# tfv — demo tape
+# Run with: vhs demo.tape
+
+Output demo.gif
+
+# ── Terminal settings ──────────────────────────────────────────────────────────
+Set FontSize 14
+Set Width 1000
+Set Height 580
+Set Theme "Catppuccin Mocha"
+Set Shell "zsh"
+Set Padding 24
+Set TypingSpeed 40ms
+Set PlaybackSpeed 1
+
+# ══════════════════════════════════════════════════════════════════════════════
+# 1. HELP
+# ══════════════════════════════════════════════════════════════════════════════
+Sleep 500ms
+Type "tfv --help"
+Enter
+Sleep 3s
+
+# ══════════════════════════════════════════════════════════════════════════════
+# 2. INSTALL MULTIPLE VERSIONS
+# ══════════════════════════════════════════════════════════════════════════════
+
+# Install latest stable
+Type "tfv install latest"
+Enter
+Sleep 5s
+
+# Install a specific version
+Type "tfv install 1.8.5"
+Enter
+Sleep 5s
+
+# Install an older version using ^ (latest patch in series)
+Type "tfv install 1.7.^"
+Enter
+Sleep 5s
+
+# Install 1.6.x series
+Type "tfv install 1.6.^"
+Enter
+Sleep 5s
+
+# ══════════════════════════════════════════════════════════════════════════════
+# 3. LIST INSTALLED VERSIONS
+# ══════════════════════════════════════════════════════════════════════════════
+Type "tfv list"
+Enter
+Sleep 2s
+
+# ══════════════════════════════════════════════════════════════════════════════
+# 4. SWITCH BETWEEN VERSIONS — show terraform version changes
+# ══════════════════════════════════════════════════════════════════════════════
+
+Type "tfv use 1.6.7"
+Enter
+Sleep 1500ms
+Type "terraform version"
+Enter
+Sleep 1500ms
+
+Type "tfv use 1.7.5"
+Enter
+Sleep 1500ms
+Type "terraform version"
+Enter
+Sleep 1500ms
+
+Type "tfv use 1.8.5"
+Enter
+Sleep 1500ms
+Type "terraform version"
+Enter
+Sleep 1500ms
+
+Type "tfv use latest"
+Enter
+Sleep 1500ms
+Type "terraform version"
+Enter
+Sleep 2s
+
+# ══════════════════════════════════════════════════════════════════════════════
+# 5. CURRENT — active version + PATH status
+# ══════════════════════════════════════════════════════════════════════════════
+Type "tfv current"
+Enter
+Sleep 2s
+
+# ══════════════════════════════════════════════════════════════════════════════
+# 6. AUTO-SWITCH — reads required_version from .tf file
+# ══════════════════════════════════════════════════════════════════════════════
+Hide
+Type "mkdir -p /tmp/tfv-demo-tf && printf 'terraform { required_version = \\042~> 1.7\\042 }\\n' > /tmp/tfv-demo-tf/versions.tf && cd /tmp/tfv-demo-tf"
+Enter
+Sleep 500ms
+Type "clear"
+Enter
+Sleep 200ms
+Show
+
+Type "tfv auto-switch"
+Enter
+Sleep 2s
+
+Type "terraform version"
+Enter
+Sleep 1500ms
+
+Hide
+Type "cd -"
+Enter
+Sleep 300ms
+Type "clear"
+Enter
+Sleep 200ms
+Show
+
+# AUTO-SWITCH from .terraform-version file
+Hide
+Type "mkdir -p /tmp/tfv-demo-pin && echo '1.6.7' > /tmp/tfv-demo-pin/.terraform-version && cd /tmp/tfv-demo-pin"
+Enter
+Sleep 500ms
+Type "clear"
+Enter
+Sleep 200ms
+Show
+
+Type "tfv auto-switch"
+Enter
+Sleep 2s
+
+Type "terraform version"
+Enter
+Sleep 1500ms
+
+Hide
+Type "cd -"
+Enter
+Sleep 300ms
+Type "clear"
+Enter
+Sleep 200ms
+Show
+
+# ══════════════════════════════════════════════════════════════════════════════
+# 7. PIN — lock version for teammates
+# ══════════════════════════════════════════════════════════════════════════════
+Hide
+Type "tfv use latest"
+Enter
+Sleep 500ms
+Type "clear"
+Enter
+Sleep 200ms
+Show
+
+Type "tfv pin"
+Enter
+Sleep 500ms
+
+Type "cat .terraform-version"
+Enter
+Sleep 1500ms
+
+# ══════════════════════════════════════════════════════════════════════════════
+# 8. UPGRADE — latest patch in current series
+# ══════════════════════════════════════════════════════════════════════════════
+Type "tfv use 1.8.5"
+Enter
+Sleep 1000ms
+
+Type "tfv upgrade"
+Enter
+Sleep 5s
+
+Type "terraform version"
+Enter
+Sleep 2s
+
+# ══════════════════════════════════════════════════════════════════════════════
+# 9. REMOVE versions
+# ══════════════════════════════════════════════════════════════════════════════
+Type "tfv remove 1.6.7"
+Enter
+Sleep 1s
+
+Type "tfv list"
+Enter
+Sleep 2s
+
+# ══════════════════════════════════════════════════════════════════════════════
+# 10. OPENTOFU — --provider tofu switches to OpenTofu; omit for terraform default
+# ══════════════════════════════════════════════════════════════════════════════
+
+# No --provider needed for terraform (it's the default)
+Type "tfv list"
+Enter
+Sleep 1500ms
+
+# Add --provider tofu to target OpenTofu instead
+Type "tfv install latest --provider tofu"
+Enter
+Sleep 5s
+
+Type "tfv use latest --provider tofu"
+Enter
+Sleep 1500ms
+
+Type "tfv current --provider tofu"
+Enter
+Sleep 1500ms
+
+Type "tofu version"
+Enter
+Sleep 2s
+
+# List available remote OpenTofu versions
+Type "tfv list --remote --provider tofu"
+Enter
+Sleep 4s
+
+# ══════════════════════════════════════════════════════════════════════════════
+# END
+# ══════════════════════════════════════════════════════════════════════════════
+Sleep 2s

package/index.js

@@ -6,10 +6,6 @@ const {join} = require('path')
 yargs
 	.commandDir(join(__dirname, 'lib', 'commands'))
 	.alias('help', 'h')
-	.alias('version', 'v')
 	.scriptName('tfv')
-	.demandCommand(1, 'You need at least one command before moving on')
-	.strictOptions()
-	// .strictCommands()
 	.showHelpOnFail()
 	.argv

package/lib/commands/apply.js

@@ -11,12 +11,17 @@ exports.builder = (yargs) => {
       describe: 'Terraform file(s) to extract targets from',
       type: 'array',
     })
+    .option('provider', {
+      alias: 'p',
+      describe: 'Provider: terraform (default) or tofu/opentofu',
+      type: 'string',
+      default: 'terraform',
+    })
     .epilog('Accepts all terraform flags after --\nExample:\n tfv apply --file main.tf --file network.tf -- -auto-approve -target=<TARGET> -var="env=prod"')
 }
 
 exports.handler = async (argv) => {
-  const {file, _} = argv;
-  // Extra args come after -- in the command line
+  const {file, _, provider} = argv;
   const extraArgs = _.slice(1);
-  await runTerraformCommand('apply', file, extraArgs);
+  await runTerraformCommand('apply', file, extraArgs, provider);
 }

package/lib/commands/current.js

@@ -0,0 +1,25 @@
+'use strict'
+
+const { current } = require('../modules/current');
+
+exports.command = 'current'
+exports.aliases = ['which']
+exports.desc = 'Show the currently active terraform or opentofu version'
+exports.builder = (yargs) => {
+  return yargs
+    .option('provider', {
+      alias: 'p',
+      describe: 'Provider: terraform (default) or tofu/opentofu',
+      type: 'string',
+      default: 'terraform',
+    })
+    .epilog([
+      'Examples:',
+      '  tfv current',
+      '  tfv which --provider tofu',
+    ].join('\n'))
+}
+
+exports.handler = async (argv) => {
+  await current(argv.provider);
+}

package/lib/commands/destroy.js

@@ -11,12 +11,17 @@ exports.builder = (yargs) => {
       describe: 'Terraform file(s) to extract targets from',
       type: 'array',
     })
+    .option('provider', {
+      alias: 'p',
+      describe: 'Provider: terraform (default) or tofu/opentofu',
+      type: 'string',
+      default: 'terraform',
+    })
     .epilog('Accepts all terraform flags after --\nExample:\n tfv destroy --file main.tf --file network.tf -- -auto-approve -target=<TARGET> -var="env=prod"')
 }
 
 exports.handler = async (argv) => {
-  const {file, _} = argv;
-  // Extra args come after -- in the command line
+  const {file, _, provider} = argv;
   const extraArgs = _.slice(1);
-  await runTerraformCommand('destroy', file, extraArgs);
+  await runTerraformCommand('destroy', file, extraArgs, provider);
 }

package/lib/commands/doctor.js

@@ -0,0 +1,20 @@
+'use strict'
+
+const { doctor } = require('../modules/doctor');
+
+exports.command = 'doctor'
+exports.desc = 'Run diagnostics: PATH, binaries, store, shell config'
+exports.builder = (yargs) => {
+  return yargs
+    .epilog([
+      'Checks PATH order, active binaries, store directories,',
+      'shell config, and PATH conflicts.',
+      '',
+      'Example:',
+      '  tfv doctor',
+    ].join('\n'))
+}
+
+exports.handler = async () => {
+  await doctor();
+}

package/lib/commands/exec.js

@@ -0,0 +1,33 @@
+'use strict'
+
+const { exec } = require('../modules/exec');
+
+exports.command = 'exec <ver>'
+exports.desc = 'Run a terraform/tofu command with a specific version without switching the active version'
+exports.builder = (yargs) => {
+  return yargs
+    .positional('ver', {
+      describe: 'Installed version to use for this run',
+      type: 'string',
+    })
+    .option('provider', {
+      alias: 'p',
+      describe: 'Provider: terraform (default) or tofu/opentofu',
+      type: 'string',
+      default: 'terraform',
+    })
+    .epilog([
+      'Pass terraform/tofu args after --',
+      '',
+      'Examples:',
+      '  tfv exec 1.9.0 -- version',
+      '  tfv exec 1.8.0 -- plan -var="env=prod"',
+      '  tfv exec 1.7.3 --provider tofu -- validate',
+    ].join('\n'))
+}
+
+exports.handler = async (argv) => {
+  const { ver, provider, _ } = argv;
+  const extraArgs = _.slice(1);
+  await exec(ver, extraArgs, provider);
+}

package/lib/commands/fmt.js

@@ -0,0 +1,26 @@
+'use strict'
+
+const { runTerraformCommand } = require('../modules/terraform-command');
+
+exports.command = 'fmt'
+exports.desc = 'Run terraform fmt. Accepts all terraform flags after --'
+exports.builder = (yargs) => {
+  return yargs
+    .option('provider', {
+      alias: 'p',
+      describe: 'Provider: terraform (default) or tofu/opentofu',
+      type: 'string',
+      default: 'terraform',
+    })
+    .epilog([
+      'Examples:',
+      '  tfv fmt',
+      '  tfv fmt -- -recursive',
+      '  tfv fmt -- -check',
+    ].join('\n'))
+}
+
+exports.handler = async (argv) => {
+  const extraArgs = argv._.slice(1);
+  await runTerraformCommand('fmt', null, extraArgs, argv.provider);
+}

package/lib/commands/init.js

@@ -0,0 +1,26 @@
+'use strict'
+
+const { runTerraformCommand } = require('../modules/terraform-command');
+
+exports.command = 'init'
+exports.desc = 'Run terraform init. Accepts all terraform flags after --'
+exports.builder = (yargs) => {
+  return yargs
+    .option('provider', {
+      alias: 'p',
+      describe: 'Provider: terraform (default) or tofu/opentofu',
+      type: 'string',
+      default: 'terraform',
+    })
+    .epilog([
+      'Examples:',
+      '  tfv init',
+      '  tfv init -- -upgrade',
+      '  tfv init -- -backend-config=backend.hcl',
+    ].join('\n'))
+}
+
+exports.handler = async (argv) => {
+  const extraArgs = argv._.slice(1);
+  await runTerraformCommand('init', null, extraArgs, argv.provider);
+}

package/lib/commands/install.js

@@ -1,26 +1,35 @@
 'use strict'
 
-const yargs = require('yargs');
-const {install} = require('../modules/install');
+const { install } = require('../modules/install');
 
-exports.command = 'install <version> [option]'
+exports.command = 'install <ver>'
 exports.aliases = ['i']
-exports.desc = 'Install a terraform version'
+exports.desc = 'Install a terraform or opentofu version'
 exports.builder = (yargs) => {
   return yargs
     .option('arch', {
       alias: 'a',
-      describe: 'Specify system architecture. Defaults is the user system architecture',
+      describe: 'Specify system architecture (arm64, amd64, etc). Defaults to your system arch.',
       type: 'string',
-      default: ''
+      default: '',
     })
-    .epilog('Version formats: latest, x.x.x (exact), x^ (latest major), x.x.^ (latest minor)\nExample: tfv install 1.5.7 --arch amd64')
+    .option('provider', {
+      alias: 'p',
+      describe: 'Provider to install: terraform (default) or tofu/opentofu',
+      type: 'string',
+      default: 'terraform',
+    })
+    .epilog([
+      'Version formats: latest, x.x.x (exact), x^ (latest major), x.x.^ (latest minor)',
+      'Examples:',
+      '  tfv install latest',
+      '  tfv install 1.7.3',
+      '  tfv install 1.7.^',
+      '  tfv install latest --provider tofu',
+    ].join('\n'))
 }
 
-exports.handler = async () => {
-  const [,version] = yargs.argv._;
-  const {arch} = yargs.argv;
-
-  await install(version, arch);
+exports.handler = async (argv) => {
+  const { ver, arch, provider } = argv;
+  await install(ver, arch, provider);
 }
-

package/lib/commands/list.js

@@ -1,29 +1,38 @@
 'use strict'
 
-const yargs = require('yargs');
-const {list} = require('../modules/list');
+const { list } = require('../modules/list');
 
-exports.command = 'list [option]'
+exports.command = 'list'
 exports.aliases = ['ls']
-exports.desc = 'List installed or available terraform versions'
+exports.desc = 'List installed or available terraform/opentofu versions'
 exports.builder = (yargs) => {
   return yargs
     .option('local', {
       alias: 'l',
-      describe: 'List terraform versions you have installed using tfv',
+      describe: 'List versions installed locally (default)',
       type: 'boolean',
       default: true,
     })
     .option('remote', {
       alias: 'r',
-      describe: 'List all available terraform versions',
+      describe: 'List all available remote versions',
       type: 'boolean',
     })
-    .epilog('Examples:\n  tfv ls            List locally installed versions\n  tfv ls --remote   List all available remote versions')
+    .option('provider', {
+      alias: 'p',
+      describe: 'Provider: terraform (default) or tofu/opentofu',
+      type: 'string',
+      default: 'terraform',
+    })
+    .epilog([
+      'Examples:',
+      '  tfv ls                              List locally installed terraform versions',
+      '  tfv ls --remote                     List all available terraform versions',
+      '  tfv ls --remote --provider tofu     List all available opentofu versions',
+    ].join('\n'))
 }
 
-exports.handler = async () => {
-  const {local, remote} = yargs.argv;
-  await list(local, remote);
+exports.handler = async (argv) => {
+  const { local, remote, provider } = argv;
+  await list(local, remote, provider);
 }
-

package/lib/commands/pin.js

@@ -0,0 +1,26 @@
+'use strict'
+
+const { pin } = require('../modules/pin');
+
+exports.command = 'pin [ver]'
+exports.desc = 'Pin the active (or specified) version to a .terraform-version file'
+exports.builder = (yargs) => {
+  return yargs
+    .option('provider', {
+      alias: 'p',
+      describe: 'Provider: terraform (default) or tofu/opentofu',
+      type: 'string',
+      default: 'terraform',
+    })
+    .epilog([
+      'Creates a .terraform-version file in the current directory.',
+      'Examples:',
+      '  tfv pin               Pin currently active version',
+      '  tfv pin 1.7.3         Pin a specific version',
+      '  tfv pin --provider tofu',
+    ].join('\n'))
+}
+
+exports.handler = async (argv) => {
+  await pin(argv.ver, argv.provider);
+}

package/lib/commands/plan.js

@@ -11,12 +11,17 @@ exports.builder = (yargs) => {
       describe: 'Terraform file(s) to extract targets from',
       type: 'array',
     })
+    .option('provider', {
+      alias: 'p',
+      describe: 'Provider: terraform (default) or tofu/opentofu',
+      type: 'string',
+      default: 'terraform',
+    })
     .epilog('Accepts all terraform flags after --\nExample:\n tfv plan --file main.tf --file network.tf -- -auto-approve -target=<TARGET> -var="env=prod"')
 }
 
 exports.handler = async (argv) => {
-  const {file, _} = argv;
-  // Extra args come after -- in the command line
+  const {file, _, provider} = argv;
   const extraArgs = _.slice(1);
-  await runTerraformCommand('plan', file, extraArgs);
+  await runTerraformCommand('plan', file, extraArgs, provider);
 }

package/lib/commands/prune.js

@@ -0,0 +1,41 @@
+'use strict'
+
+const { prune } = require('../modules/prune');
+
+exports.command = 'prune'
+exports.desc = 'Remove all non-active installed versions to free disk space'
+exports.builder = (yargs) => {
+  return yargs
+    .option('keep', {
+      alias: 'k',
+      describe: 'Keep the N most recent versions in addition to the active one',
+      type: 'number',
+      default: 0,
+    })
+    .option('provider', {
+      alias: 'p',
+      describe: 'Provider: terraform (default) or tofu/opentofu',
+      type: 'string',
+      default: 'terraform',
+    })
+    .option('yes', {
+      alias: 'y',
+      describe: 'Skip confirmation prompt',
+      type: 'boolean',
+      default: false,
+    })
+    .epilog([
+      'Always keeps the currently active version.',
+      '',
+      'Examples:',
+      '  tfv prune                   # remove all but active',
+      '  tfv prune --keep 2          # remove all but active + 2 most recent',
+      '  tfv prune --provider tofu',
+      '  tfv prune --yes             # skip confirmation',
+    ].join('\n'))
+}
+
+exports.handler = async (argv) => {
+  const { provider, keep, yes } = argv;
+  await prune(provider, keep, yes);
+}

package/lib/commands/remove.js

@@ -1,22 +1,27 @@
 'use strict'
 
-const yargs = require('yargs');
-const {remove} = require('../modules/remove');
+const { remove } = require('../modules/remove');
 
-exports.command = 'remove <version>'
+exports.command = 'remove <ver>'
 exports.aliases = ['rm']
-exports.desc = 'Remove terraform versions from tfv store'
+exports.desc = 'Remove terraform/opentofu versions from tfv store'
 exports.builder = (yargs) => {
   return yargs
-    .option('verbose', {
-      describe: 'Produce detailed output',
-      type: 'boolean',
+    .option('provider', {
+      alias: 'p',
+      describe: 'Provider: terraform (default) or tofu/opentofu',
+      type: 'string',
+      default: 'terraform',
     })
-    .epilog('Example: tfv rm 1.5.7 1.4.6')
+    .epilog([
+      'Examples:',
+      '  tfv rm 1.5.7 1.4.6',
+      '  tfv rm 1.7.3 --provider tofu',
+    ].join('\n'))
 }
 
-exports.handler = async () => {
-  const [,...version] = yargs.argv._;
-
-  await remove(version);
+exports.handler = async (argv) => {
+  const versions = argv._.slice(1);
+  const { provider } = argv;
+  await remove(versions, provider);
 }

package/lib/commands/shell-init.js

@@ -0,0 +1,25 @@
+'use strict'
+
+const { shellInit } = require('../modules/shell-init');
+
+exports.command = 'shell-init <shell>'
+exports.desc = 'Generate shell hook for automatic version switching on cd'
+exports.builder = (yargs) => {
+  return yargs
+    .positional('shell', {
+      describe: 'Shell to generate hook for',
+      choices: ['bash', 'zsh', 'fish', 'powershell', 'pwsh'],
+    })
+    .epilog([
+      'Outputs a shell script to stdout intended to be eval\'d.',
+      'Setup instructions are printed to stderr.',
+      '',
+      'Bash/Zsh:       eval "$(tfv shell-init zsh)"     # add to ~/.zshrc',
+      'Fish:           tfv shell-init fish | source      # add to config.fish',
+      'PowerShell:     Invoke-Expression (tfv shell-init powershell | Out-String)',
+    ].join('\n'))
+}
+
+exports.handler = (argv) => {
+  shellInit(argv.shell);
+}