class Jack::Config::Help

Public Class Methods

apply() click to toggle source
# File lib/jack/config/help.rb, line 3
    def apply
<<-EOL
Apply the specified template configuration in jack/cfg to the Elastic Beanstalk environment.

#{convention}

Example:

$ jack config apply hi-web-stag-1

$ jack config apply myapp -c myconfig hi-web-stag-1
EOL
    end
diff() click to toggle source
# 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
get() click to toggle source
# File lib/jack/config/help.rb, line 17
    def get
<<-EOL
Downloads the environment's config to jack/cfg/[CONFIG_NAME].cfg.yml

#{convention}

Example:

$ jack config get hi-web-stag-1

$ jack config get myapp -c myconfig hi-web-stag-1
EOL
    end
sort() click to toggle source
# 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

Private Class Methods

convention() click to toggle source

duplicated in jack/help.rb

# File lib/jack/config/help.rb, line 64
    def convention
<<-EOL
The configuration name is based on convention.  An environment with the name of hi-web-stag-1 results in the jack/cfg/hi-web-stag.cfg.yml being used.  The convention can be overriden with the --cfg option.
EOL
    end