Class: DBRocket::Command::Help

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

Instance Attribute Summary

Attributes inherited from Base

#args

Instance Method Summary collapse

Methods inherited from Base

#ask, #ask_for_config_file, #conf_to_uri_hash, #config_file, #confirm, #display, #error, #extract_option, #home_directory, #initialize, #load_taps, #make_config_file, #make_url_from_config, #parse_database_yml, #parse_taps_opts, #running_on_windows?, #shell, #taps_client, #uri_hash_to_url, #userinfo_from_uri

Constructor Details

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

Instance Method Details

#index ⇒ Object 



3
4
5
 
# File 'lib/db_rockets/cli/commands/help.rb', line 3

def index
  display usage
end

#usage ⇒ Object 



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/db_rockets/cli/commands/help.rb', line 7

def usage
  usage = <<EOTXT
=== General Commands

 help                     # show this usage
 create                   # create config file for your app
 push
 pull

=== Server

 server:start             #run db_rocket server
 server:stop              #stop db_rocket server

=== Example story:

 rails myapp
 cd myapp
 (...make edits...)
 db_rocket create
EOTXT
end