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, #exit_code, #options, #out, #runner, #work_dir

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

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

Methods included from Bosh::Cli::CommandDiscovery

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

Methods included from DeploymentHelper

#cancel_deployment, #deployment_changed?, #inspect_deployment_changes, #job_exists_in_deployment?, #job_must_exist_in_deployment, #job_unique_in_deployment?, #jobs_and_indexes, #latest_release_versions, #prepare_deployment_manifest, #prompt_for_job_and_index, #resolve_release_aliases

Methods included from VersionCalc

#major_version, #minor_version, #version_cmp, #version_greater, #version_less, #version_same

Constructor Details

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

Class Method Details

.list_commands(commands) ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/cli/commands/help.rb', line 86

def self.list_commands(commands)
  help_column_width = terminal_width - 5
  help_indent = 4

  commands.each_with_index do |command, i|
    nl if i > 0
    say("#{command.usage_with_params.columnize(70).make_green}")
    say(command.desc.columnize(help_column_width).indent(help_indent))
    if command.has_options?
      say(command.options_summary.indent(help_indent))
    end
  end
end

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