class RubyTerraform::Commands::Get
Wraps the +terraform get+ command which downloads and installs modules needed for the given configuration.
This recursively downloads all modules needed, such as modules imported by the root and so on. If a module is already downloaded, it will not be redownloaded or checked for updates unless :update
is true
.
Module installation also happens automatically by default as part of the {Init} command, so you should rarely need to run this command separately.
For options accepted on construction, see {#initialize}.
When executing an instance of {Get} via {#execute}, the following options are supported:
-
:directory
: the path to a directory containing terraform configuration (deprecated in terraform 0.14, removed in terraform 0.15, use:chdir
instead). -
:chdir
: the path of a working directory to switch to before executing the given subcommand. -
:update
: iftrue
, checks already-downloaded modules for available updates and installs the newest versions available; defaults tofalse
. -
:no_color
: whether or not the output from the command should be in color; defaults tofalse
.
@example Basic Invocation
RubyTerraform::Commands::Get.new.execute( directory: 'infra/networking')
Public Instance Methods
@!visibility private
# File lib/ruby_terraform/commands/get.rb, line 55 def arguments(parameters) [parameters[:directory]] end
@!visibility private
RubyTerraform::Options::Global#options
# File lib/ruby_terraform/commands/get.rb, line 47 def options %w[ -no-color -update ] + super end
@!visibility private
# File lib/ruby_terraform/commands/get.rb, line 42 def subcommands %w[get] end