Remote

SSH helpers.

Getting started

First, install it.

gem install remote

Then, create a sample config file.

remote --sample

This generates a file called remotes.yml. Edit this sample file. (Tip: you can also put this in config/remotes.yml -- useful for Rails/Sinatra projects.)

# remotes.yml
live:
  host: foo.mysite.com
  user: app
  key: ~/.ssh/id_rsa
  path: /home/app/myapp

Now, you may easily run commands on your given servers.

remote live rake db:migrate
# Equivalent of running `ssh -i ~/.ssh/id_rsa app@foo.mysite.com -- rake db:migrate`

Going further

You may even define aliases for complicated commands.

# remotes.yml
live:
  host: foo.mysite.com
  commands:
    deploy: |
      git pull
      thin -C config/thin.yml restart
      rake cdn:propogate
      echo Deployed new version `rake app:version`

You may then run it easily with one command:

remote live deploy
# Runs the deploy script you've defined in the config file

You may also define aliases than take arguments.

# remotes.yml
live:
  host: foo.mysite.com
  commands:
    thor: env RACK_ENV=production rake %s

So then you may:

remote live rake app:version 
# Executes 'env RACK_ENV=production rake app:version' on the remote server

Using in Ruby

require 'remote'

r = Remote::App.new
r = Remote::App.new(:config => 'servers.yml')  # Optional

r.run 'live', 'ls'    # Same as 'remote live ls'
r.servers             #=> [<Server 'development'>, <Server 'production'>, ...]
r.write_sample        # same as 'remote --sample'

r = Remote::App.new(:console => true)
r.list    # Same as 'remote --list'
r.help    # Same as 'remote --help'