Scriptster

Scriptster is a small library to help you writing scripts in Ruby. It is only consists of two functions and it's especially useful for apps that uses many external tools through the shell.

The two basic things this library focuses on are

Running shell commands
Providing nice logs/status messages about what happened

See the examples bellow.

Usage

require 'scriptster'

It is not necessary to configure scriptster before using it, in case you're fine with the default settings. But if not, the configure method offers many options to change. For the full list of options, please refer to the docs.

Scriptster::configure do |conf|
  conf.name = "my-script"
  conf.theme = :dark
end

The following snippet demonstrates exactly how would you use scriptster in practice:

Scriptster::log :info, "Starting ..."

Scriptster::cmd.new "git branch",
  :show_out = true,
  :show_err = true,

The log method has one more argument available and the cmd method has other options that you can use. Again, you will find more in the docs.

Installation

Add this line to your application's Gemfile:

gem 'scriptster'

And then execute:

$ bundle

Or install it yourself as:

$ gem install scriptster

Contributing

Fork it ( https://github.com/[my-github-username]/scriptster/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create a new Pull Request