Class: RubyTerraform::Commands::Login

Inherits:
Base
  • Object
show all
Includes:
Options::Global
Defined in:
lib/ruby_terraform/commands/login.rb

Overview

Wraps the terraform login command which retrieves an authentication token for the given hostname, if it supports automatic login, and saves it in a credentials file in your home directory.

If no hostname is provided, the default hostname is app.terraform.io, to log in to Terraform Cloud.

If not overridden by credentials helper settings in the CLI configuration, the credentials will be written to the following local file:

~/.terraform.d/credentials.tfrc.json

For options accepted on construction, see Base#initialize.

When executing an instance of Login via Base#execute, the following options are supported:

  • :chdir: the path of a working directory to switch to before executing the given subcommand.

The Base#execute method accepts an optional second parameter which is a map of invocation options. Currently, the only supported option is :environment which is a map of environment variables to expose during invocation of the command.

Examples:

Basic Invocation

RubyTerraform::Commands::Login.new.execute

Constructor Details

This class inherits a constructor from RubyTerraform::Commands::Base