Class: Remind101::Command::Help

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

Overview

list commands and display help

Constant Summary collapse

PRIMARY_NAMESPACES = 
%w( auth groups messages )

Instance Method Summary collapse

Instance Method Details

#index ⇒ Object

help [COMMAND]

list available commands or display help for a specific command

Examples:

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

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

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

Additional topics:

account      #  manage remind101 account options
accounts     #  manage multiple remind101 accounts
...

$ remind101 help apps:create Usage: remind101 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 "remind101"
-s, --stack STACK          # the stack on which to create the app



40
41
42
43
44
45
46
 
# File 'lib/remind101/command/help.rb', line 40

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