Sha256: 11810556aa9ec767d8777803cf08777315c6f6f0847101def23862af6b3d63c9

Contents?: true

Size: 1.76 KB

Versions: 1

Compression:

Stored size: 1.76 KB

Contents

Shell2html
===============

[![Gem Version](https://img.shields.io/gem/v/shell2html.svg)](http://rubygems.org/gems/shell2html)
[![Build Status](https://img.shields.io/travis/mose/shell2html.svg)](https://travis-ci.org/mose/shell2html)
[![Coverage Status](https://img.shields.io/coveralls/mose/shell2html.svg)](https://coveralls.io/r/mose/shell2html?branch=master)
[![Dependency Status](https://img.shields.io/gemnasium/mose/shell2html.svg)](https://gemnasium.com/mose/shell2html)
[![Code Climate](https://img.shields.io/codeclimate/github/mose/shell2html.svg)](https://codeclimate.com/github/mose/shell2html)

----

A ruby lib for conversion between bash colors and HTML. It was created to help the Shellplay tool to export html from colored shell output.

Code is still experimental, use at your own risk. But "it works for me".

Installation
-------------------
Add this line to your application's Gemfile:

    gem 'shell2html'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install shell2html

Usage
-----------------

````
require "shell2html"

puts Shell2html.to_html("\e[33m>\e[0m\e[1;31m some colored thing.\e[0m")
````

Commandline command
-------------------

(not functionnal yet)

There is a command `shell2html` provided in this lib for commandline execution.

    shell2html <file>
    echo "\e[31mPrompt: \e[0m" | shell2html

The html is output in stdout.

An example of usage is visible on http://mose.com/20140814-dokku/

Contributing
-----------------
1. Fork it
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

Copyright
----------------
(c) Copyright 2014 mose. Distributed under MIT license

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
shell2html-0.0.5 README.md