Class: Bosh::Cli::Command::Help

Inherits:
Base show all
Defined in:
lib/cli/commands/help.rb

Constant Summary

Constants inherited from Base

Base::DEFAULT_DIRECTOR_PORT

Instance Attribute Summary

Attributes inherited from Base

#args, #options, #out, #runner, #work_dir

Instance Method Summary collapse

Methods inherited from Base

#add_option, #blob_manager, #blobstore, #cache, #config, #confirmed?, #deployment, #director, #exit_code, #initialize, #interactive?, #logged_in?, #non_interactive?, #password, #redirect, #release, #remove_option, #target, #target_name, #task_report, #username, #verbose?

Methods included from Bosh::Cli::CommandDiscovery

#desc, #method_added, #option, #register_command, #usage

Constructor Details

This class inherits a constructor from Bosh::Cli::Command::Base

Instance Method Details

#help(*keywords) ⇒ Object

Parameters:

  • keywords (Array) —

    What specific kind of help is requested



12
13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/cli/commands/help.rb', line 12

def help(*keywords)
  if runner.nil?
    err("Cannot show help message, command runner is not instantiated")
  end

  keywords = "all" if keywords.empty? && options[:all]

  if keywords.empty?
    generic_help
  else
    keyword_help(keywords)
  end
end