Class: Nimbu::Command::Help

Inherits:
Base
  • Object
show all
Defined in:
lib/nimbu/command/help.rb

Overview

list commands and display help

Constant Summary collapse

PRIMARY_NAMESPACES = 
%w( auth server themes sites init browse )

Instance Attribute Summary

Attributes inherited from Base

#args, #options

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#initialize, namespace, #nimbu

Methods included from Helpers

#action, #ask, #confirm, #confirm_billing, #confirm_command, #create_git_remote, #deprecate, disable_error_capture, #display, #display_header, #display_object, #display_row, #display_table, enable_error_capture, #error, error_with_failure, error_with_failure=, extended, extended_into, #fail, #format_bytes, #format_date, #format_error, #format_with_bang, #get_terminal_environment, #git, #has_git?, #home_directory, #hprint, #hputs, included, included_into, #json_decode, #json_encode, #launchy, #line_formatter, #longest, #output, #output_with_arrow, #output_with_bang, #quantify, #redisplay, #retry_on_exception, #run_command, #running_on_a_mac?, #running_on_windows?, #set_buffer, #shell, #spinner, #status, #string_distance, #styled_array, #styled_error, #styled_hash, #styled_header, #suggestion, #time_ago, #truncate, #with_tty

Methods included from Helpers::System

#browser_launcher, #command?, #osx?, #tmp_dir, #which, #windows?

Constructor Details

This class inherits a constructor from Nimbu::Command::Base

Class Method Details

.usage_for_command(command) ⇒ Object 



25
26
27
28
 
# File 'lib/nimbu/command/help.rb', line 25

def self.usage_for_command(command)
  command = new.send(:commands)[command]
  "Usage: nimbu #{command[:banner]}" if command
end

Instance Method Details

#index ⇒ Object

help [COMMAND]

list available commands or display help for a specific command



14
15
16
17
18
19
20
 
# File 'lib/nimbu/command/help.rb', line 14

def index
  if command = args.shift
    help_for_command(command)
  else
    help_for_root
  end
end