Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master

This branch is 71 commits behind chrismytton:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
script
test
.travis.yml
MIT-LICENCE
Makefile
README.md
shoreman.sh

README.md

shoreman

A shell implementation of the Procfile format.

Install

Standalone

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

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

Homebrew

To install shoreman with homebrew use this gist with the following command:

brew install --HEAD https://gist.github.com/raw/1973792/e7e053623e9c9aaa52ef67afecc4391a65605629/shoreman.rb

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.

cd project-with-procfile
shoreman

Running tests

Tests are written using roundup which is downloaded using curl on every test run.

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

cd shoreman
make

Manually running tests

If you're on a mac then you should be able to run brew update && brew install roundup to install roundup locally. Then you can run the tests from the root of the repository.

cd shoreman
roundup test/shoreman_test.sh

Todo

  • Automatically assign a free port to processes.
  • Add proper logging so it's clear what's coming from where.
  • Add concurrency controls for process types.
  • Support .env files.

Credits

Inspired by the original Foreman by David Dollar (@ddollar) and Norman (foreman for Node) by Josh Peek (@josh).

Copyright (c) Chris Mytton

Something went wrong with that request. Please try again.