Class: Jack::Config::Help

Inherits:
Object
  • Object
show all
Defined in:
lib/jack/config/help.rb

Class Method Summary collapse

Class Method Details

.diff ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/jack/config/help.rb', line 32

def diff
<<-EOL
Diff local jack config vs environment config.  The environment config is generated on the fly.

If you have colordiff installed the diff command will use make use of it.  If you want to have your own custom diff, you can set your JACK_DIFF environment variable to it.

#{convention}

Example:

$ jack config diff hi-web-stag-1

$ jack config diff myapp -c myconfig hi-web-stag-1
EOL
end

.download ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/jack/config/help.rb', line 17

def download
<<-EOL
Downloads the environment's config to jack/cfg/[CONFIG_NAME].cfg.yml

#{convention}

Example:

$ jack config download hi-web-stag-1

$ jack config download myapp -c myconfig hi-web-stag-1
EOL
end

.sort ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/jack/config/help.rb', line 48

def sort
<<-EOL
Reformats local jack config file to a sorted yaml format.

#{convention}

Example:

$ jack config sort hi-web-stag-1

$ jack config sort -c myconfig hi-web-stag-1 # env name doesnt matter here
EOL
end

.upload ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
14
15
 
# File 'lib/jack/config/help.rb', line 3

def upload
<<-EOL
Uploads the specified template configuration in jack/cfg and applies it to the environment immediately.

#{convention}

Example:

$ jack config upload hi-web-stag-1

$ jack config upload myapp -c myconfig hi-web-stag-1
EOL
end