Class: Dreamy::Command::Help

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

Instance Attribute Summary

Attributes inherited from Base

#args

Instance Method Summary collapse

Methods inherited from Base

#ask, #display, #extract_option, #home_directory, #initialize, #running_on_windows?, #shell

Constructor Details

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

Instance Method Details

#index ⇒ Object 



3
4
5
 
# File 'lib/dreamy/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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/dreamy/commands/help.rb', line 7

def usage
	usage = <<EOTXT

=== Commands
 
 announce                           # list announce lists
 announce:list <list>               # list all subscribers to <name> list
 announce:add <list> <email>        # add subscriber with <email> to <list>
 announce:remove <list> <email>     # remove subscriber with <email> from <list>

 dns                                # list DNS records
 dns <name>                         # list DNS records for <name>
 dns:add <record> <type> <value>    # add DNS record 
 dns:remove <record> <type> <value> # remove DNS record

 domains:http                       # list HTTP domain details
 domains:mysql                      # list MySQL domains
 domains:status                     # check availability of all domains (pingability)
 
 mysql:dbs                          # list MySQL database details
 mysql:hosts                        # list MySQL database hostnames
 mysql:users                        # list MySQL user details
 
 ps                                 # list private servers
 ps:add <web|mysql> <yes|no>        # adds a private server of type <web|mysql>. Yes = move data
 ps:pending                         # list private servers scheduled to be created
 ps:reboots <name>                  # list historical reboots for <name>
 ps:reboot <name> now!              # reboot <name> now! (proceed with caution)
 ps:remove                          # removes all pending private servers
 ps:settings <name>                 # list settings for private server <name>
 ps:set <name> <setting> <value>    # change <setting> on <name> to <value>
 ps:size <name>                     # list historical memory sizes for <name>
 ps:size <name> <value>             # set new memory <value> for <name>
 ps:usage <name>                    # list historical memory & CPU usage for <name>
 
 users                              # list user accounts: details
 users:pw                           # list user accounts: usernames & passwords

EOTXT
end