SSHClient

Ruby SSH client for servers without exec requests support

Attention!!! This gem is research tool. Not recommended to use it in production environment.

Installation

Add this line to your application's Gemfile:

gem 'ssh_client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ssh_client

Usage

Configure client

# Default config
SSHClient.configure do |conf|
  conf.hostname = 'example.com'
  conf.username = 'sample'
  conf.password = 'sample'
  conf.logger = Logger.new('log/my.log') # default log to STDOUT
  conf.read_timeout = 0.5 # default 0.3
  conf.raise_on_errors = true # raise exception if command write to STDERR
end

# Custom config
SSHClient.configure(:custom) do |conf|
  conf.hostname = '127.0.0.1'
end

Execute commands

Using connection instance

connection = SSHClient.connect

listener = connection.add_listener(:stdout) do |data|
  puts data
end

connection.exec 'hostname'
connection.remove_listener(listener)
connection.close

Using connection with custom config

connection = SSHClient.connect :custom

Pass hostname, username and password to connection

connection = SSHClient.connect hostname: 'example.com', username: 'sample', password: 'sample'

Multiply commands run with block. Connection closed after block execution

SSHClient.connect do
  run 'hostname'
  run 'uname -a'
  run 'cat /proc/cpuinfo | grep model'
end

Run command and return output

output = connection.exec! 'hostname'

output = connection.exec! do
  run 'hostname'
  run 'uname -a'
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ssh_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

elbowdonkey/ssh_client