Class: Vagrant::CLI

Inherits:
Object
  • Object
show all
Defined in:
lib/vagrant/cli.rb

Overview

Manages the command line interface to Vagrant.

Instance Method Summary collapse

Constructor Details

#initialize(argv, env) ⇒ CLI

Returns a new instance of CLI.



7
8
9
10
11
12
13
14
 
# File 'lib/vagrant/cli.rb', line 7

def initialize(argv, env)
  super

  @logger = Log4r::Logger.new("vagrant::cli")
  @main_args, @sub_command, @sub_args = split_main_and_subcommand(argv)

  @logger.info("CLI: #{@main_args.inspect} #{@sub_command.inspect} #{@sub_args.inspect}")
end

Instance Method Details

#execute ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/vagrant/cli.rb', line 16

def execute
  if @main_args.include?("-v") || @main_args.include?("--version")
    # Version short-circuits the whole thing. Just print
    # the version and exit.
    @env.ui.info(I18n.t("vagrant.commands.version.output",
                        :version => Vagrant::VERSION),
                 :prefix => false)

    return 0
  elsif @main_args.include?("-h") || @main_args.include?("--help")
    # Help is next in short-circuiting everything. Print
    # the help and exit.
    help
    return 0
  end

  # If we reached this far then we must have a subcommand. If not,
  # then we also just print the help and exit.
  command_class = nil
  if @sub_command
    command_class = Vagrant.plugin("2").manager.commands[@sub_command.to_sym]
  end

  if !command_class || !@sub_command
    help
    return 1
  end
  @logger.debug("Invoking command class: #{command_class} #{@sub_args.inspect}")

  # Initialize and execute the command class, returning the exit status.
  result = command_class.new(@sub_args, @env).execute
  result = 0 if !result.is_a?(Fixnum)
  return result
end

#help ⇒ Object

This prints out the help for the CLI.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/vagrant/cli.rb', line 52

def help
  # We use the optionparser for this. Its just easier. We don't use
  # an optionparser above because I don't think the performance hits
  # of creating a whole object are worth checking only a couple flags.
  opts = OptionParser.new do |o|
    o.banner = "Usage: vagrant [-v] [-h] command [<args>]"
    o.separator ""
    o.on("-v", "--version", "Print the version and exit.")
    o.on("-h", "--help", "Print this help.")
    o.separator ""
    o.separator "Available subcommands:"

    # Add the available subcommands as separators in order to print them
    # out as well.
    keys = []
    Vagrant.plugin("2").manager.commands.each do |key, _|
      keys << key
    end

    keys.sort.each do |key|
      o.separator "     #{key}"
    end

    o.separator ""
    o.separator "For help on any individual command run `vagrant COMMAND -h`"
  end

  @env.ui.info(opts.help, :prefix => false)
end