nissh

A wrapper for net/ssh to make running commands more fun


License
MIT
Install
gem install nissh -v 1.0.1

Documentation

Nissh

A wrapper for net/ssh to make running commands and getting the data you need nicer.

Installation

As always, just add Nissh to your Gemfile and run bundle install.

gem 'nissh'

Usage

Nissh is designed to be very easy to use and get started with.

Connecting

To start a session, just create an object using the same properties that you would pass to a Net::SSH.start method.

session = Nissh::Session.new('185.22.208.5', 'root')

Running a simple command

Run a command using the execute! method which will return an object containing the response. This method will run in the foreground so the call will block until the server finishes.

result = ssh.execute!("hostname")
result.success?     # => Was the command successfully executed?
result.exit_code    # => Exit code
result.stdout       # => Full contents of stdout
result.stderr       # => Full contents of stderr

Logging

If you want to log all commands which are executed to a file, you can do this by just setting a logger for all sessions. Once enabled, it will log all commands which are run along with their full output, exit code and the server they were executed on. This is likely only required in development.

Nissh::Session.logger = Logger.new("ssh.log")

Sudo Passwords

If the user you are authenticating with needs to run a sudo command and provide a password, Nissh can help. Just pass the :sudo option when calling execute. You do not need to add the sudo keyword before your command.

# Just provide the password as an option when running your command
session.execute!("cat /etc/passwd", :sudo => "yourpassword")

# Alternative, you can provide it to the session and just pass true.
session.sudo_password = "yourpassword"
session.execute!("cat /etc/passwd", :sudo => true)

Timing out

If you want to only wait a specific length of time for a command to complete, you can use the execute_with_timeout method.

result = session.execute_with_timeout!("something-slow", 5)
result.success?     # => false
result.exit_code    # => -255