headlight
v0.0.4
Published
Start, Stop, & Status For NodeJS Apps
Downloads
86
Maintainers
Readme
#Headlight
Start, Stop, & Status For NodeJS Apps.
#FEATURES
- Pid based application runner
- start / stop node js apps
- app running status
- command line tty
- works as a module
#INSTALLING Using Git:
git clone https://github.com/active9/headlight
cd headlight
npm install
Using NPM:
npm install headlight -g
Once installed headlight has a few command line switches to help get your app running.
App Start
headlight start
App Stop
headlight stop
App Status
headlight status
The easiest way to start an appliction would be to change to the directory where your nodejs application resides and type the following:
headlight start
Then to stop your script while within the same directory type in:
headlight stop
You can also run scripts from other directories like this:
headlight start /path/to/my/app
Or like this:
headlight start /path/to/my/app myscript.js
Note: If you do not specify a third argument headlight will attempt to read the package.json file within the directory and load the main script.
#MODULE
Headlight can be included as a nodejs module. The examples folder on the github repo will show you how to programmatically use headlight in your own modules or scripts.
#CONTRIB
Headlight is not designed to replace existing application runners instead you can use it with existing ones or stand-alone. We encourage forking.
#LICENSE MIT