nodemon: Automatically Restart Node.js Apps on File Changes

Use at your own risk

OSRepos shares public repositories for knowledge and discovery only. Any installation, execution, configuration, or use of code from these repositories is the user's own responsibility. Always review the repository, source code, dependencies, licenses, and security implications before running or installing anything. OSRepos is not responsible for issues, damages, or losses resulting from third-party repositories.

Overview

nodemon is a command-line wrapper for running Node.js applications during development. It monitors files and restarts the application when relevant changes are detected, avoiding the repeated manual cycle of stopping and restarting a server.

It suits developers who want an automatic development workflow while keeping their app's normal startup command and code unchanged. It can also run and monitor non-Node scripts when given an appropriate executable.

Key Features

Restarts an application when watched files change.
Wraps the usual application command, passing arguments through to the app.
Supports watching selected directories and file extensions, and ignoring paths or patterns.
Offers local and global configuration, with command-line options taking precedence.
Allows a manual restart by entering rs while nodemon is running.
Supports restart delays, custom signals, and actions triggered by nodemon events.
Can run non-Node programs with --exec and configured executable mappings.

Use Cases

Node.js developers can keep a local server running and have it reload after source edits.
Teams can add nodemon to an npm development script so contributors get a consistent restart workflow.
Developers working with several source folders can specify exactly which directories and extensions should trigger a restart.
Developers running a supported non-Node script can use nodemon to watch its files and rerun it after changes.

Project Facts

Language: JavaScript
License: MIT
Stars: 26.7k
Forks: 1.7k
Topics: node, nodemon, watch
Archived: no

Getting Started

Install globally with npm and run your application through nodemon:

npm install -g nodemon
nodemon ./server.js

For local installation, configuration, and CLI options, see the README.

Considerations

nodemon is a development aid, not a replacement for a production process manager. File watching behavior may need adjustment in networked or mounted-drive environments, where the project documents polling as an option and cautions that it can poll every file. Custom signal handling and restart behavior should be considered if the application needs graceful shutdown or cleanup.