Class: Jiveapps::Command::Help

Inherits:
Base
  • Object
show all
Defined in:
lib/jiveapps/commands/help.rb

Instance Attribute Summary

Attributes inherited from Base

#args, #autodetected_app

Instance Method Summary collapse

Methods inherited from Base

#extract_app, #extract_app_from_git_config, #extract_app_in_dir, #extract_option, #git_remotes, #initialize, #jiveapps

Methods included from Helpers

#ask, #catch_args, #check_git_version, #confirm, #confirm_command, #debug, #debug_mode?, #display, #display_oauth_services, #error, #get_app_prop_with_default, #get_or_set_git_prop, #git_version, #has_program?, #home_directory, #run, #running_on_a_mac?, #running_on_windows?, #sh, #usage, #user_git_version

Constructor Details

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

Instance Method Details

#index ⇒ Object 



4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/jiveapps/commands/help.rb', line 4

def index
  display "jiveapps gem: v#{Jiveapps::VERSION}"
  display ""
  display "=== Summary"
  display "The \"jiveapps\" program is a command line tool for building and hosting Jive App front-ends."
  display ""
  display "=== General Commands"
  display ""
  display "help                                       # show this usage"
  display ""
  display "list                                       # list your apps"
  display "create <app_name>                          # create a new app"
  display "clone <app_name>                           # clone the repository of an existing app"
  display ""
  display "=== App Specific Commands"
  display "    NOTE: run these within app directory, or pass app name with: --app <app_name>"
  display ""
  display "info                                       # display information about an app"
  display "install                                    # install an app on the sandbox (if you removed it, you can reinstall)"
  display "livedev                                    # start livedev mode"
  display "delete                                     # delete app"
  display ""
  display "keys                                       # show your user\'s public keys"
  display "keys:add [<path to keyfile>]               # add a public key. optionally include path"
  display "keys:remove <keyname>                      # remove a key by name (user@host)"
  display ""
  display "oauth                                      # show the oauth services for this app"
  display "oauth:add <service_name> <key> <secret>    # add an oauth service for this app"
  display "oauth:remove <service_name>                # remove an oauth service for this app"
  display ""
  display "sharing                                    # list collaborators"
  display "sharing:add <username>                     # add a collaborator"
  display "sharing:remove <username>                  # remove a collaborator"
  display ""
  display "=== Simple Workflow Example:"
  display ""
  display "$ jiveapps create myapp                    # create a new app named \"myapp\""
  display "$ cd myapp                                 # switch into app\'s directory"
  display ""
  display " ... develop your app ..."
  display ""
  display "$ git add .                                # stage all files for commit"
  display "$ git commit -m \"some updates to my app\"   # commit to your local git repository"
  display "$ git push jiveapps master                 # push updates to jive"
end