Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

node.js port of foreman + hot code reload

tree: b82fcaee4b

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

Forewoman

Forewoman is a Node.js port of foreman, with the added feature of hot code reloading. Credits to node-supervisor for inspiring the hot code reloading implementation.

Export is not completed yet. It will be available from 0.2.x

Forewoman is extracted from the code base of Notifymode

Caveats

Forewoman should work on Linux, Mac OS and other variants of Unix. Windows is not supported.

Installation

You can install locally

npm install forewoman

or globally

npm install -g forewoman

If you choose to install locally, you have to invoke the full path to the forewoman command.

./node_modules/forewoman/bin/forewoman

If it is a global install, forewoman should be available from your PATH.

Usage

SYNOPSIS

forewoman start [OPTION]

forewoman start is used to run your application directly from the command line.

If no additional parameters are passed, forewoman will run one instance of each type of process defined in your Procfile. The format of a Procfile is explained here

If a parameter is passed, forewoman will run one instance of the specified application type.

The following options control how the application is run:

Options

-c, --concurrency

Specify the number of each process type to run. The value passed in should be in the format process=num,process=num

-e, --env

Specify one or more .env files to load

-d, --directory

Specify an alternate application root. This defaults to the directory containing the Procfile.

-f, --procfile

Specify an alternate Procfile to load, implies -d at the Procfile root.

-p, --port

Specify which port to use as the base for this application. Should be a multiple of 1000.

-w, --watch

Specify the files to watch. If the files are modified, forewoman will restart the process. The value passed in should be in the format process=/path/to/file,process=/path/to/file

License

Copyright (c) 2012 Wong Liang Zan. MIT License

Something went wrong with that request. Please try again.