# Foreman

[![Build Status](https://travis-ci.org/ddollar/foreman.svg?branch=master)](https://travis-ci.org/ddollar/foreman)
[![Code Climate](https://codeclimate.com/github/ddollar/foreman.png)](https://codeclimate.com/github/ddollar/foreman)
[![Inline docs](http://inch-ci.org/github/ddollar/foreman.svg?branch=master)](http://inch-ci.org/github/ddollar/foreman)

Manage Procfile-based applications

<table>
  <tr>
    <th>If you have...</th>
    <th>Install with...</th>
  </tr>
  <tr>
    <td>Ruby (MRI, JRuby, Windows)</td>
    <td><pre>$ gem install foreman</pre></td>
  </tr>
  <tr>
    <td>Mac OS X</td>
    <td><a href="http://assets.foreman.io/foreman/foreman.pkg">foreman.pkg</a></td>
  </tr>
</table>

## Installation

    $ gem install foreman

Ruby users should take care *not* to install foreman in their project's `Gemfile`.

## Getting Started

* http://blog.daviddollar.org/2011/05/06/introducing-foreman.html

## Supported Ruby versions

See [.travis.yml](.travis.yml) for a list of Ruby versions against which Foreman is tested.

## Documentation

* [man page](http://ddollar.github.com/foreman)
* [wiki](http://github.com/ddollar/foreman/wiki)
* [changelog](https://github.com/ddollar/foreman/blob/master/Changelog.md)

## Ports

* [forego](https://github.com/ddollar/forego) - Go
* [gaffer](https://github.com/jingweno/gaffer) - Java/JVM
* [honcho](https://github.com/nickstenning/honcho) - python
* [proclet](https://github.com/kazeburo/Proclet) - Perl
* [shoreman](https://github.com/hecticjeff/shoreman) - shell

## Authors

#### Created and maintained by
David Dollar

#### Patches contributed by
[Contributor List](https://github.com/ddollar/foreman/contributors)

## License

Foreman is licensed under the MIT license.

See LICENSE for the full license text.
