A simple CLI tool for ensuring that a given node.js application runs conveniently and continuously.
v0.3.x: change options
- start-stop interface
- set envs
- clustering
- daemonize
- job script
- stdout and stderr logger
- watch script changes
- watch assets changes
- compile and minify assets
npm i nodectl -g
You can use nodectl to run javascript or coffee-script.
nodectl [action] [options] <script>
Lower-case options require a parameter, upper-cases are Boolean.
Usage: nodectl [action] [options] <script>
Action:
start : start <script> as a node.js app
stop : stop the <script>
restart : restart the <script>
status : check the <program> running or not
Options:
-p, --port : set process.env.PORT 3000
-e, --env : set process.env.NODE_ENV development
-c, --cluster : number of concurrents CPU_THREAD_LENGTH
-d, --delay : delay time for refork 250
-s, --setenv : set custom env (k=v) {}
-x, --exec : exec job script null
-l, --log : stdout+stderr log file null
-1, --stdout : stdout log file null
-2, --stderr : stderr log file null
-a, --assets : dir for assets null
-o, --output : dir for assets output null
-M, --minify : minify compiled assets false
-D, --daemon : daemonize process false
-W, --watch : restart app on code change false
-N, --nocolor : disable custom console false
-v, --version : show version and exit
-h, --help : show this message and exit
--debug : show debug information
nodectl requires package.json includes the key named name and version.
<script> is omissible if the key named main exists in either package.json or .nodectl.json.
If the key named nodectlrc exists, you can change rcfile name .nodectl.json to other.
When .nodectl.json is placed in PROJECT_ROOT, load the value for key named long-option-name and set to a [options] default value.
See Recipes section for how to write json file.
Do not touch ${PROJECT_ROOT}/.nodectl.run manually.
.nodectl.run use for app state management.
Current working directory should be under the project root.
nodectl -h
nodectl --help
nodectl -v
nodectl --version
default action, only javascript or coffee-script runnable.
nodectl start app.js
nodectl app.js
nodectl app.coffee
nodectl stop
restart application workers
nodectl restart app.js
nodectl status app.js
set listening port with process.env.PORT
nodectl app.js -p 3000
set application environment with process.env.NODE_ENV
nodectl app.js -e production
number of process concurrents
nodectl app.js -c 1
interval time on forking worker
nodectl app.js -d 250
set custom envs
nodectl app.js -s ROOTDIR=/opt -s COEFFICIENT=3.6
execute job script on launch
nodectl app.js -x clock.js
logs stdout and stderr to file
nodectl app.js -l app.log
overwrite stdout log file
nodectl app.js -1 app.out
app.log logs stderr only:
nodectl app.js -l app.log -1 app.out
overwrite stderr log file
nodectl app.js -2 app.err
set asset directory Note: required -o option
compiles automatically on change assets
compilable: js, css, html, coffee, stylus, jade
nodectl app.js -a assets -o public
set output directory Note: required -a option
compiles automatically on change assets
nodectl app.js -a assets -o public
minify code on compiles assets
nodectl app.js -M -a assets -o public
daemonize app
nodectl app.js -D
watch code changes, auto reload programs
nodectl app.js -W
stop colorize console
nodectl app.js -N
show debug info
nodectl app.js --debug
- detected project name
- detected project version
- is
nodectl
- nodectl version
- worker number (
worker.#{number})
- is daemonized or not
{
"main": "app.coffee",
"env": "development",
"cluster": 1,
"watch": true,
"assets": "assets",
"output": "public",
"minify": true
}
cd $PROJECT_ROOT
nodectl start app.coffee -e development -c 1 -W -a assets -o public -M
cd $PROJECT_ROOT
nodectl
{
"main": "app.coffee",
"env": "development",
"watch": true,
}
cd $PROJECT_ROOT
nodectl start app.coffee -e development -W
cd $PROJECT_ROOT
nodectl
.nodectl.jsonvalues take priority overpackage.jsonvalues.
{
"nodectlrc": "nodectl.json"
}
- change rcfile name
.nodectl.jsontonodectl.json
{
"port": 3000,
"switch_env": {
"development": {
"port": 3050
},
"production": {
"port": 3040
}
}
}
NODE_ENV=development, port is3050NODE_ENV=production, port is3040NODE_ENV=test, port is3000NODE_ENV=, env is fallback todevelopmentby nodectl, port is3050
{
"main": "app.coffee",
"env": "production",
"assets": "assets",
"output": "public",
"minify": true,
"daemon": true
}
nodectl start app.coffee -e production -a assets -o output -M -D
{
"main": "app.coffee",
"assets": "assets",
"output": "public",
"minify": true,
"setenv": {
"ROOTDIR": "/opt",
"COEFFICIENT": 3.6
}
}
nodectl start app.coffee -a assets -o output -M -s ROOTDIR=/opt -s COEFFICIENT=3.6
- use
--exec
setInterval ->
/* some action */
, 5000
{
"main": "app.coffee",
"env": "production",
"assete": "assets",
"output": "public",
"minify": true,
"daemon": true,
"exec": "script.coffee"
}
Copyright © 2013 geta6 licensed under MIT
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.