File: README.md

package info (click to toggle)
ruby-buff-shell-out 0.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid, stretch
  • size: 164 kB
  • ctags: 18
  • sloc: ruby: 136; makefile: 3
file content (44 lines) | stat: -rw-r--r-- 1,130 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# Buff::ShellOut
[![Gem Version](https://badge.fury.io/rb/buff-shell_out.png)](http://badge.fury.io/rb/buff-shell_out)
[![Build Status](https://travis-ci.org/RiotGames/buff-shell_out.png?branch=master)](https://travis-ci.org/RiotGames/buff-shell_out)

Buff up your code with a mixin for issuing shell commands and collecting the output

## Installation

Add this line to your application's Gemfile:

    gem 'buff-shell_out'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install buff-shell_out

## Usage

Using it as a mixin

    require 'buff/shell_out'

    class PowerUp
      include Buff::ShellOut
    end

    power_up = PowerUp.new
    power_up.shell_out("ls") #=> <#Buff::ShellOut::Response @exitstatus=0, @stdout="...", @stderr="...">

Using it as a module

    require 'buff/shell_out'

    Buff::ShellOut.shell_out("ls") #=> <#Buff::ShellOut::Response @exitstatus=0, @stdout="...", @stderr="...">

# Authors and Contributors

* Jamie Winsor (<jamie@vialstudios.com>)

Thank you to all of our [Contributors](https://github.com/RiotGames/buff-shell_out/graphs/contributors), testers, and users.