README.md

Shellany

Shellany captures command output.

Features

• Portability (should work on recent JRuby versions).
• Capturing stdout, stderr in a convenient way.
• Returning the result in a convenient way.
• Detecting if a shell is needed (though incomplete/primitive implementation).
• Prevents running the same command multiple times.

Installation

Add this line to your application's Gemfile:

gem 'shellany'

And then execute:

$ bundle

Or install it yourself as:

$ gem install shellany

Usage

Basic usage:

require 'shellany/sheller'

Shellany::Sheller.stdout("echo abc") # => "abc"
Shellany::Sheller.stderr("touch /foo") # => "touch: cannot touch  ‘/aef’: Permission denied
Shellany::Sheller.run("false") # => false
Shellany::Sheller.system("clear") # => clears screen (no capture done)

Using Sheller object:

require 'shellany/sheller'

sh = Shellany::Sheller.new('grep /etc/passed|tail -n 1') # does nothing

sh.stdout # shows output (runs the command since it wasn't run)
sh.stderr # shows stderr (does not run the command)
sh.ok? # returns true if exit code was zero (does not run the command)

Project status

Only developed enough for Guard to run, though pull requests are more than welcome.

Especially for:

• Better API.
• Better shell detection code.
• Better support for various system() arguments.
• Better support for redirection handling.
• Better support for shell detection (e.g. Windows).

Contributing

1. Fork it (https://github.com/guard/shellany/fork).
2. Create your feature branch (git checkout -b my-new-feature).
3. Commit your changes (git commit -am 'Add some feature').
4. Push to the branch (git push origin my-new-feature).
5. Create a new Pull Request.