Class: ORS::Commands::Help

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

Constant Summary

Constants included from ORS::Config

ORS::Config::CONFIG_FILENAME

Instance Method Summary collapse

Methods inherited from Base

#run

Methods included from Base::ClassMethods

#run

Methods included from Helpers

#build_command, #bundle_install, #execute_command, #execute_in_parallel, #fatal, #info, #prepare_environment, #restart_server, #run_migrations, #setup_repo, #setup_ruby, #start_server, #stop_server, #update_code

Methods included from ORS::Config

#all_servers, #deploy_directory, #revision, #ruby_servers

Methods included from ORS::Config::ModuleMethods

#git, #parse_config_file, #parse_options, #valid_environments, #valid_options?

Instance Method Details

#execute ⇒ Object 



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
 
# File 'lib/ors/commands/help.rb', line 5

def execute
  puts <<-END
Usage: ./ors <action> [environment=production] [options]

=== Actions
changes       View changes between what is deployed and committed
check         Prints out contents of restart.timestamp on the app servers
console       Bring up a console on the console server
deploy        Update the code, run the migrations, and restart unicorn
help          You're looking at it
logs          Show the last few log entries from the production servers
migrate       Runs the migrations on the migration server
restart       Retarts unicorn on the app servers
runner        Runs ruby code via Rails' runner on the console server
setup         Sets up the default environment on the servers
start         Starts up unicorn on the app servers
stop          Stops unicorn on the app servers
update        Updates the code on all servers

=== Environments
Must be one of: production demo staging
Defaults to production.

=== Options
--pretend    (or -p)   Don't execute anything, just show me what you're going to do (default: false)
--no-gateway (or -ng)  Don't use a gateway (if you're inside the firewall)          (default: true)
  END
end