Class: Mortar::Command::Help
Overview
list commands and display help
Constant Summary collapse
- PRIMARY_NAMESPACES =
%w( auth config clusters generate jobs local luigi projects )
Instance Attribute Summary
Attributes inherited from Base
Class Method Summary collapse
Instance Method Summary collapse
-
#index ⇒ Object
help [COMMAND].
Methods inherited from Base
#api, #ask_public, #config_parameters, #get_error_message_context, #git, #initialize, #initialize_embedded_project, #luigi_parameters, namespace, #pig_parameters, #project, #register_api_call, #register_do, #register_project, #spark_script_arguments, #validate_project_name, #validate_project_structure
Methods included from Helpers
#action, #ask, #confirm, #copy_if_not_present_at_dest, #default_host, #deprecate, #display, #display_header, #display_object, #display_row, #display_table, #display_with_indent, #download_to_file, #ensure_dir_exists, #error, error_with_failure, error_with_failure=, extended, extended_into, #format_bytes, #format_date, #format_with_bang, #full_host, #get_terminal_environment, #home_directory, #host, #hprint, #hputs, included, included_into, #installed_with_omnibus?, #json_decode, #json_encode, #line_formatter, #longest, #output_with_bang, #pending_github_team_state_message, #quantify, #redisplay, #retry_on_exception, #running_on_a_mac?, #running_on_windows?, #set_buffer, #shell, #spinner, #status, #string_distance, #styled_array, #styled_error, #styled_hash, #styled_header, #suggestion, #test_name, #ticking, #time_ago, #truncate, #warning, #with_tty, #write_to_file
Constructor Details
This class inherits a constructor from Mortar::Command::Base
Class Method Details
.usage_for_command(command) ⇒ Object
47 48 49 50 |
# File 'lib/mortar/command/help.rb', line 47 def self.usage_for_command(command) command = new.send(:commands)[command] "Usage: mortar #{command[:banner]}" if command end |
Instance Method Details
#index ⇒ Object
help [COMMAND]
list available commands or display help for a specific command
Examples:
Get help about mortar illustrate command.
$ mortar help llustrate
36 37 38 39 40 41 42 |
# File 'lib/mortar/command/help.rb', line 36 def index if command = args.shift help_for_command(command) else help_for_root end end |