Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Monitor for any changes in your node.js application and automatically restart the server - perfect for development
Branch: master
Pull request Compare This branch is 753 commits behind remy:master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
README.md
nodemon-ignore.example
nodemon.js
package.json

README.md

nodemon

For use during development of a node.js based application.

nodemon will watch all the files in the directory that nodemon was started, and if they change, it will automatically restart your node application.

nodemon does not require any changes to your code or method of development. nodemon simply wraps your node application and keeps an eye on any files that have changed.

Installation

Either through forking or:

npm install nodemon

And nodemon will be installed in to your bin path.

Usage

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

nodemon [your node app]

For example, 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 [nodemon], otherwise all output from your application, errors included, will be echoed out as expected.

Ignoring files

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

The nodemon-ignore file is automatically created in the directory that you run your application from, so that you can have application specific ignore lists.

You can use the example ignore file as a basis for your nodemon, but it's very simple to create your own:

# this is my ignore file with a nice comment at the top

/vendor/*     # ignore all external submodules
/public/*     # static files
./README.md   # a specific file
*.css         # ignore any CSS files too

The ignore file accepts:

  • Comments starting with a # symbol
  • Blank lines
  • Specific files
  • File patterns (this is converted to a regex, so you have full control of the pattern)

Prerequisites

nodemon currently depends on the unix find command (which also is installed on Macs)

Something went wrong with that request. Please try again.