Class: Heroku::Command::Help

Inherits:
Base
  • Object
show all
Includes:
Deprecated::Help
Defined in:
lib/heroku/command/help.rb

Overview

list commands and display help

Constant Summary collapse

PRIMARY_NAMESPACES =
%w( auth apps ps run restart addons config releases domains logs sharing )

Instance Attribute Summary

Attributes inherited from Base

#args, #options

Instance Method Summary collapse

Methods included from Deprecated::Help

included

Methods inherited from Base

#api, #app, #heroku, #initialize, namespace, #org, #org_api

Methods included from Helpers

#action, #app_owner, #ask, #confirm, #confirm_command, #create_git_remote, #debug, #debugging?, #default_org_host, #deprecate, #display, #display_header, #display_object, #display_row, #display_table, #error, #error_log, #error_log_path, 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?, #has_git_remote?, #has_http_git_entry_in_netrc, #home_directory, #hprint, #hputs, included, included_into, #json_decode, #json_encode, #launchy, #line_formatter, #longest, #org?, #org_host, #output_with_bang, #quantify, #redisplay, #retry_on_exception, #run_command, #running_on_a_mac?, #running_on_windows?, #set_buffer, #shell, #spinner, #status, #stderr_print, #stderr_puts, #string_distance, #styled_array, #styled_error, #styled_hash, #styled_header, #suggestion, #time_ago, #truncate, #update_git_remote, #warn_if_using_jruby, #with_tty

Constructor Details

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

Instance Method Details

#indexObject

help [COMMAND]

list available commands or display help for a specific command

Examples:

$ heroku help Usage: heroku COMMAND [–app APP] [command-specific-options]

Primary help topics, type “heroku help TOPIC” for more details:

addons    #  manage addon resources
apps      #  manage apps (create, destroy)
...

Additional topics:

account      #  manage heroku account options
accounts     #  manage multiple heroku accounts
...

$ heroku help apps:create Usage: heroku apps:create [NAME]

create a new app

    --addons ADDONS        # a comma-delimited list of addons to install
-b, --buildpack BUILDPACK  # a buildpack url to use for this app
-r, --remote REMOTE        # the git remote to create, default "heroku"
-s, --stack STACK          # the stack on which to create the app

43
44
45
46
47
48
49
# File 'lib/heroku/command/help.rb', line 43

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