Method: Capistrano::CLI#initialize

Defined in:

lib/capistrano/cli.rb

#initialize(args) ⇒ CLI

Create a new CLI instance using the given array of command-line parameters to initialize it. By default, ARGV is used, but you can specify a different set of parameters (such as when embedded cap in a program):

require 'capistrano/cli'
Capistrano::CLI.parse(%w(-vvvv -r config/deploy update_code)).execute!

Note that you can also embed cap directly by creating a new Configuration instance and setting it up, but you’ll often wind up duplicating logic defined in the CLI class. The above snippet, redone using the Configuration class directly, would look like:

require 'capistrano'
require 'capistrano/cli'
config = Capistrano::Configuration.new
config.logger_level = Capistrano::Logger::TRACE
config.set(:password) { Capistrano::CLI.password_prompt }
config.load "config/deploy"
config.update_code

There may be times that you want/need the additional control offered by manipulating the Configuration directly, but generally interfacing with the CLI class is recommended.

# File 'lib/capistrano/cli.rb', line 38

def initialize(args)
  @args = args.dup
  $stdout.sync = true # so that Net::SSH prompts show up
end