shoreman(1)
===========

A shell implementation of the Procfile format.

[![Build Status](https://travis-ci.org/chrismytton/shoreman.svg?branch=master)](https://travis-ci.org/chrismytton/shoreman)

## Install

### Standalone

Install as a standalone, change `~/bin/` to any other directory that's
in your `$PATH` if you wish.

```
curl https://github.com/chrismytton/shoreman/raw/master/shoreman.sh -sLo ~/bin/shoreman && \
chmod 755 ~/bin/shoreman
```

### Homebrew

    brew install --HEAD chrismytton/formula/shoreman

## Usage

Head into a project that has a `Procfile` in it, then simply run the
`shoreman` command, it will read your Procfile, and start up the
processes it finds. If there is a `.env` file in the directory then
environment variables will be read from it, as with foreman.

```
cd project-with-procfile
shoreman
```

## Running tests

Tests are written using [roundup](http://bmizerany.github.com/roundup/).

To run the tests, go to the root of the repository then run `make`.

```
cd shoreman
make
```

## Projects using shoreman

- [dokku-shoreman](https://github.com/statianzo/dokku-shoreman) a plugin
  for [dokku](https://github.com/progrium/dokku) to allow it to run
  multiple process types.

## Todo

* Add concurrency controls for process types.

## Contributors

* Chris Mytton ([@chrismytton](https://github.com/chrismytton))
* Mickael Riga ([@mig-hub](https://github.com/mig-hub))
* Matthew Johnston ([@warmwaffles](https://github.com/warmwaffles))
* Dmitrij Mjakotnyi ([@kucaahbe](https://github.com/kucaahbe))
* Stephen Paul Weber ([@singpolyma](https://github.com/singpolyma))
* ryanrhee ([@ryanrhee](https://github.com/ryanrhee))
* Lorenzo Giuliani ([@aliem](https://github.com/aliem))
* KOSEKI Kengo ([@koseki](https://github.com/koseki))

## Credits

Inspired by the original [Foreman](https://github.com/ddollar/foreman)
by David Dollar (@ddollar).

Copyright (c) Chris Mytton
