Github url


by remy

remy /nodemon

Monitor for any changes in your node.js application and automatically restart the server - perfect f...

20.9K Stars 1.4K Forks Last release: about 2 months ago (v2.0.4) MIT License 1.1K Commits 112 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Nodemon Logo


nodemon is a tool that helps develop node.js based applications by automatically restarting the node application when file changes in the directory are detected.

nodemon does not require any additional changes to your code or method of development. nodemon is a replacement wrapper for


. To use


, replace the word


on the command line when executing your script.

NPM versionTravis Status Backers on Open Collective Sponsors on Open Collective


Either through cloning with git or by using npm (the recommended way):

npm install -g nodemon

And nodemon will be installed globally to your system path.

You can also install nodemon as a development dependency:

npm install --save-dev nodemon

With a local installation, nodemon will not be available in your system path. Instead, the local installation of nodemon can be run by calling it from within an npm script (such as

npm start

) or using

npx nodemon



nodemon wraps your application, so you can pass all the arguments you would normally pass to your app:

nodemon [your node app]

For CLI options, use the




) argument:

nodemon -h

Using nodemon is simple, if my application accepted a host and port as the arguments, I would start it as so:

nodemon ./server.js localhost 8080

Any output from this script is prefixed with


, otherwise all output from your application, errors included, will be echoed out as expected.

If no script is given, nodemon will test for a


file and if found, will run the file associated with the main property (ref).

You can also pass the


flag to node through the command line as you would normally:

nodemon --inspect ./server.js 80

If you have a


file for your app, you can omit the main script entirely and nodemon will read the


for the


property and use that value as the app.

nodemon will also search for the


property in


(as of nodemon 1.1.x).

Also check out the FAQ or issues for nodemon.

Automatic re-running

nodemon was originally written to restart hanging processes such as web servers, but now supports apps that cleanly exit. If your script exits cleanly, nodemon will continue to monitor the directory (or directories) and restart the script if there are any changes.

Manual restarting

Whilst nodemon is running, if you need to manually restart your application, instead of stopping and restart nodemon, you can type


with a carriage return, and nodemon will restart your process.

Config files

nodemon supports local and global configuration files. These are usually named


and can be located in the current working directory or in your home directory. An alternative local configuration file can be specified with the

--config <file></file>


The specificity is as follows, so that a command line argument will always override the config file settings:

  • command line arguments
  • local config
  • global config

A config file can take any of the command line arguments as JSON key values, for example:

{ "verbose": true, "ignore": ["\*.test.js", "fixtures/\*"], "execMap": { "rb": "ruby", "pde": "processing --sketch={{pwd}} --run" } }

The above


file might be my global config so that I have support for ruby files and processing files, and I can run

nodemon demo.pde

and nodemon will automatically know how to run the script even though out of the box support for processing scripts.

A further example of options can be seen in


If you want to keep all your package configurations in one place, nodemon supports using


for configuration. Specify the config in the same format as you would for a config file but under


in the


file, for example, take the following



{ "name": "nodemon", "homepage": "", "...": "... other standard package.json values", "nodemonConfig": { "ignore": ["test/\*", "docs/\*"], "delay": "2500" } }

Note that if you specify a


file or provide a local




config is ignored.

_This section needs better documentation, but for now you can also see

nodemon --help config

(also here)_ .

Using nodemon as a module

Please see doc/

Using nodemon as child process

Please see doc/

Running non-node scripts

nodemon can also be used to execute and monitor other programs. nodemon will read the file extension of the script being run and monitor that extension instead of


if there's no



nodemon --exec "python -v" ./

Now nodemon will run

with python in verbose mode (note that if you're not passing args to the exec program, you don't need the quotes), and look for new or modified files with the



Default executables

Using the


config file, you can define your own default executables using the


property. This is particularly useful if you're working with a language that isn't supported by default by nodemon.

To add support for nodemon to know about the


extension (for Perl), the


file would add:

{ "execMap": { "pl": "perl" } }

Now running the following, nodemon will know to use


as the executable:


It's generally recommended to use the global


to add your own


options. However, if there's a common default that's missing, this can be merged in to the project so that nodemon supports it by default, by changing default.js and sending a pull request.

Monitoring multiple directories

By default nodemon monitors the current working directory. If you want to take control of that option, use the


option to add specific paths:

nodemon --watch app --watch libs app/server.js

Now nodemon will only restart if there are changes in the




directory. By default nodemon will traverse sub-directories, so there's no need in explicitly including sub-directories.

Don't use unix globbing to pass multiple directories, e.g

--watch ./lib/\*

, it won't work. You need a


flag per directory watched.

Specifying extension watch list

By default, nodemon looks for files with the








, and


extensions. If you use the


option and monitor

nodemon will monitor files with the extension of


. However, you can specify your own list with the




) switch like so:

nodemon -e js,pug

Now nodemon will restart on any changes to files in the directory (or subdirectories) with the extensions





Ignoring files

By default, nodemon will only restart when a


JavaScript file changes. In some cases you will want to ignore some specific files, directories or file patterns, to prevent nodemon from prematurely restarting your application.

This can be done via the command line:

nodemon --ignore lib/ --ignore tests/

Or specific files can be ignored:

nodemon --ignore lib/app.js

Patterns can also be ignored (but be sure to quote the arguments):

nodemon --ignore 'lib/\*.js'

Note that by default, nodemon will ignore the












directories and add your ignored patterns to the list. If you want to indeed watch a directory like


, you need to override the underlying default ignore rules.

Application isn't restarting

In some networked environments (such as a container running nodemon reading across a mounted drive), you will need to use the

legacyWatch: true

which enables Chokidar's polling.

Via the CLI, use either




for short:

nodemon -L

Though this should be a last resort as it will poll every file it can find.

Delaying restarting

In some situations, you may want to wait until a number of files have changed. The timeout before checking for new file changes is 1 second. If you're uploading a number of files and it's taking some number of seconds, this could cause your app to restart multiple times unnecessarily.

To add an extra throttle, or delay restarting, use the



nodemon --delay 10 server.js

For more precision, milliseconds can be specified. Either as a float:

nodemon --delay 2.5 server.js

Or using the time specifier (ms):

nodemon --delay 2500ms server.js

The delay figure is number of seconds (or milliseconds, if specified) to delay before restarting. So nodemon will only restart your app the given number of seconds after the last file change.

If you are setting this value in


, the value will always be interpreted in milliseconds. E.g., the following are equivalent:

nodemon --delay 2.5 { "delay": "2500" }

Gracefully reloading down your script

It is possible to have nodemon send any signal that you specify to your application.

nodemon --signal SIGHUP server.js

Your application can handle the signal as follows.

process.once("SIGHUP", function () { reloadSomeConfiguration(); })

Please note that nodemon will send this signal to every process in the process tree.

If you are using


, then each workers (as well as the master) will receive the signal. If you wish to terminate all workers on receiving a


, a common pattern is to catch the


in the master, and forward


to all workers, while ensuring that all workers ignore



if (cluster.isMaster) { process.on("SIGHUP", function () { for (const worker of Object.values(cluster.workers)) { worker.process.kill("SIGTERM"); } }); } else { process.on("SIGHUP", function() {}) }

Controlling shutdown of your script

nodemon sends a kill signal to your application when it sees a file update. If you need to clean up on shutdown inside your script you can capture the kill signal and handle it yourself.

The following example will listen once for the


signal (used by nodemon to restart), run the clean up process and then kill itself for nodemon to continue control:

process.once('SIGUSR2', function () { gracefulShutdown(function () { process.kill(, 'SIGUSR2'); }); });

Note that the


is only called once your shutdown jobs are complete. Hat tip to Benjie Gillam for writing this technique up.

Triggering events when nodemon state changes

If you want growl like notifications when nodemon restarts or to trigger an action when an event happens, then you can either


nodemon or add event actions to your



For example, to trigger a notification on a Mac when nodemon restarts,


looks like this:

{ "events": { "restart": "osascript -e 'display notification \"app restarted\" with title \"nodemon\"'" } }

A full list of available events is listed on the event states wiki. Note that you can bind to both states and messages.

Pipe output to somewhere else

nodemon({ script: ..., stdout: false // important: this tells nodemon not to output to console }).on('readable', function() { // the `readable` event indicates that data is ready to pick up this.stdout.pipe(fs.createWriteStream('output.txt')); this.stderr.pipe(fs.createWriteStream('err.txt')); });

Using nodemon in your gulp workflow

Check out the gulp-nodemon plugin to integrate nodemon with the rest of your project's gulp workflow.

Using nodemon in your Grunt workflow

Check out the grunt-nodemon plugin to integrate nodemon with the rest of your project's grunt workflow.


nodemon, is it pronounced: node-mon, no-demon or node-e-mon (like pokémon)?

Well...I've been asked this many times before. I like that I've been asked this before. There's been bets as to which one it actually is.

The answer is simple, but possibly frustrating. I'm not saying (how I pronounce it). It's up to you to call it as you like. All answers are correct :)

Design principles

  • Fewer flags is better
  • Works across all platforms
  • Fewer features
  • Let individuals build on top of nodemon
  • Offer all CLI functionality as an API
  • Contributions must have and pass tests

Nodemon is not perfect, and CLI arguments has sprawled beyond where I'm completely happy, but perhaps it can be reduced a little one day.


See the FAQ and please add your own questions if you think they would help others.


Thank you to all our backers! 🙏

nodemon backers


Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Sponsor this project today ❤️



We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.