How can I run nodemon from within WebStorm?

Question

I would like to use nodemon from within the WebStorm IDE (version 7). Nodemon watches one or more files in my source folder and restarts the node process (an Express server in this case), when one of the source files changes.

How do I configure WebStorm to use nodemon in a Run Configuration, so that the node process is automatically restarted?

Without nodemon, I use the following configuration in WebStorm, but have to restart the node process whenever I change something in the source file:

• Node interpreter: /usr/local/bin/node
• Working directory: /Users/foo/test
• JavaScript file: server.js

This results in a Run Configuration that runs node server.js in the specified directory.

From command line, I can use the following command to use nodemon to watch for file changes: nodemon server.js in the project directory.

How do I need to change the WebStorm configuration so that it also uses nodemon?

Achondrite

This question seems to be along the same lines: #11175541 – Achondrite

See my answer https://mcmap.net/q/225259/-node-js-debugging-flow is using the most updated version of the Webstorm so far. – Shipboard

Answer 1

It looks like the workaround with --exec isn't necessary anymore, at least when using the newest version of nodemon and Webstorm 7 or 8.

All you have to do is specify your path to nodemon by obtaining its path with running which nodemon in your console (e.g. /usr/local/bin/nodemon) under "Node parameters":

@Bela Clark, thanks for confirming.

---

You may NOT have nodemon exists from which nodemon command, then you should have it in your package.json ie nodemon be installed at :project_dir/node_modules/.bin/nodemon

Then from Webstorm 's run/debug config, set Node parameters to be

:path_to_project_dir/node_modules/.bin/nodemon

---

You should save the debug/run config to file so your teammates can also easily debug/run your nodejs app like you

This will save the config into some .xml file, sample as below

<component name="ProjectRunConfigurationManager">
  <configuration default="false" name="index.js" type="NodeJSConfigurationType" path-to-node="$USER_HOME$/.nvm/versions/node/v19.4.0/bin/node" nameIsGenerated="true" node-parameters="../node_modules/.bin/nodemon" path-to-js-file="index.js" working-dir="$PROJECT_DIR$/nodejs27/node27_sequelize_apiapp/src">
    <method v="2" />
  </configuration>
</component>

Contrast

Just gave this a try - it works perfectly fine now. Thanks for providing an updated answer! – Achondrite

@bernhardw, webstorm doesn't stop on breakpoints when starting debugger with these configurations. Any idea why? – Cherian

Managed to get nodemon and breakpoints working by following these instructions: vcfvct.wordpress.com/2015/02/13/… Note that I used --debug-brk instead of --debug – Maryannemarybella

To make debugging work I had to use Live Edit plugging for IntelliJ instead of nodemon. – Hydrophilous

Good answer ! Thank you – Except

But, debugging is not working i.e program is not stopping at breakpoints. ?? – Hill

to stop at breakpoints you have to put the parameter --inspect-brk in 'node parameters: ' and run in debugging mode. – Shipboard

Following on from iwaduarte's breakpoint fix, --inspect-brk has to go into Application Parameters to work, not Node Parameters (for me anyway - WebStorm 2019.1.4) – Rem

reminder: you have to physically click on the run window in order for it to update after you implement this solution – Genera

Didn't work for me at all on MacOS 13.1, node 18, nodemon 2.0.20. nodemon doesn't start with this config (which seems logical, as it is a binary in my case and works as a standalone binary and not as a node parameter - though it worked for many people somehow...). This answer helped me to start nodemon: https://mcmap.net/q/223245/-how-can-i-run-nodemon-from-within-webstorm – Defraud

Answer 2

This is the Windows solution

You can just use the nodemon.cmd instead of node directly like :

Node interpreter : C:\MyPath\To\nodemon.cmd
Node parameters : /*Empty for me*/
Node WorkingDirectoy : C:\Users\MyUserName\Desktop\DirectoryContainingMyIndex.js
JavaScriptFile : app\index.js /*or just index.js depending on your config*/

and then :

Hope it will help you.

Bohemian

I thought this was the most straight forward answer. – Ulrikaumeko

Hi, Tried this and when I change a file it asks me (in the Web Storm console) "Terminate batch job (Y/N)?". I also see that the command being executed is: "C:\Program Files (x86)\JetBrains\WebStorm 8.0.4\bin\runnerw.exe" C:\Users\xyz\AppData\Roaming\npm\nodemon.cmd --debug-brk=27344 --nolazy -q app.js. Am I missing anything? – Regenaregency

for the "terminate batch job" problem just add " < nul" (leave out quotations) to the "Application parameters" input. (answer found here: superuser.com/a/498798) – Homozygous

Why is this upvoted ? It won't work, when nodemon restarts it doesn't add the " <nul" from the initial start, so you still get "Terminate batch job (Y/N)?" – Quenchless

the location in windows is C:\Users\<user>\AppData\Roaming\npm\nodemon.cmd – Fraternize

Answer 3

To install nodemon, use the following (if required, use sudo to run the installation with root privileges:

npm install -g nodemon

This will install nodemon globally on your machine.

Then, in your WebStorm Run Configuration, add the following, leaving everything else unchanged:

• Node parameters: /usr/local/bin/nodemon --exec /usr/local/bin/node

This will instruct the node interpreter to execute the nodemon script using the following command line: node /usr/local/bin/nodemon --exec /usr/local/bin/node server.js.

The --exec part is important, as the execution will fail with the following error:

/usr/local/bin/node /usr/local/bin/nodemon server.js
4 Oct 13:56:50 - [nodemon] v0.7.10
4 Oct 13:56:50 - [nodemon] to restart at any time, enter `rs`
4 Oct 13:56:50 - [nodemon] watching: /Users/foo/test
execvp(): No such file or directory
4 Oct 13:56:50 - [nodemon] starting `node server.js`
4 Oct 13:56:50 - [nodemon] exception in nodemon killing node
Error: spawn ENOENT
    at errnoException (child_process.js:980:11)
    at Process.ChildProcess._handle.onexit (child_process.js:771:34)

The error seems to be caused by WebStorm not seeing the node executable on its path.

The fix for this is to specify the location to the node executable using the --exec /usr/local/bin/node parameter.

Using these settings, nodemon works fine when run from a WebStorm Run Configuration.

The same trick might have to be used with some of the tools similar to nodemon, e.g. node-supervisor.

Achondrite

This works for Run Configuration, but not with Debug. Any idea to Debug as well with nodemon in webstorm? – Joann

At least with Webstorm 8 EAP and nodemon 1.0.15 you don't have to specify --exec anymore. All I had to do was use /usr/local/bin/nodemon in "Node parameters". – Contrast

@bernhardw: I can confirm the same – Amata

Answer 4

I'm on Windows and for me didn't worked with nodemon (no idea why), but someone from Jetbrains suggested to try with supervisor:

1. I installed supervisor: npm install supervisor -g

2. Then find where is supervisor installed, for me was in: C:\Users\AlinC\AppData\Roaming\npm\node_modules\supervisor\lib\cli-wrapper.js –no-restart-on error

3. I went back to Intellij: edit configurations -> node parameters -> and added: C:\Users\AlinC\AppData\Roaming\npm\node_modules\supervisor\lib\cli-wrapper.js –no-restart-on error

Phenylamine

To stop on breakpoint you should add this: --debug-brk and complete string is C:\Users\<username>\AppData\Roaming\npm\node_modules\supervisor\lib\cli-wrapper.js no-restart-on error --debug-brk Check from jetbrains jetbrains.com/phpstorm/webhelp/… address – Rainarainah

Couldn't get nodemon working on Windows 8 with Webstorm 9, this worked like a charm tho – Anamorphic

Works for me (Webstorm 11 on Windows) but the breakpoints don't work. I tried adding --debug-brk but no luck. – Supranational

Start nodemon with --inspect flag and then attach a debugger to it. – Steamer

Answer 5

For those interested for the solution in Windows 10, here is my configuration. It does not show "Terminate Batch" thing and works perfectly.

You press debug ONCE and than you can save change files whatever and the server will restart in debug mode. All brakepoints are working perfectly

Muskrat

this is working answer for debug. I set only node parameters. node parameters as text (change username): c:\users\username\AppData\Roaming\npm\node_modules\nodemon\bin\nodemon.js --debug=3001 – Resolve

This didn't work for me. Adding the --debug=3001 parameter crashed nodemon – Lessee

Thanks.The basic run is working and also the debug without any problems!This should be TOP answer! – Catharinecatharsis

Answer 6

For windows users set:

Node Interpreter: Path of the node.exe i.e. c:\program files\node\node.exe

Node parameter: C:\Users\YOURUSER\AppData\Roaming\npm\node_modules\nodemon\bin\nodemon.js

Nicholasnichole

This worked for me! Debugging and break points work perfectly. Node version 10.15.1 nodemon version 1.18.10 Webstorm 2018.3.5 – Lessee

Answer 7

You can also make it work with nvm and debugging still works.

Tested with Node.js 8.1.0 and Webstorm 2017.2

First make sure you are on the right version (in my case v8.1.0) and install nodemon globally -

nvm use v8.1.0
npm install -g nodemon

Then, open Run/Debug configurations and create a new one with the correct node interpreter.

Node parameters should be:

MAC

/Users/[YOUR_USER]/.nvm/versions/node/v8.1.0/bin/nodemon --inspect=3001

LINUX

/usr/local/nvm/versions/node/v8.1.0/bin/nodemon --inspect=3001

Save and debug respponsibally :)

Bullhorn

Answer 8

In case you've installed nodemon like a global library, just set in node parameters:

C:\Users\${yourUser}\AppData\Roaming\npm\node_modules\nodemon\bin\nodemon.js

Depository

Works like a charm through nvm and npm 14.7.0 – Kalli

Answer 9

This is the only thing that worked for me:

1. Add a new package.json node run script command:

2. Create an NPM CONFIG (not a node config)
3. Select "start-watch" as the command

For me this worked for debugging / breakpoints without issues or additional headache.

Skutchan

Seems if you do this, "break on exception" does not break on exceptions:( – Glaucoma

It worked like a charm for me on MacOS 13.1, node 18. Stops at breakpoints very well. On the contrary, using Node configuration (as in most top answers) doesn't start. – Defraud

Answer 10

Here's the configuration that works for me on Windows 7 + WebStorm 8.0.4. If I put nodemon.cmd as the node interpreter I kept getting "Terminate batch job (Y/N)?".

Incommodity

see my answer regarding this question on Windows, I think you were pointing to the wrong nodemon.cmd file – Conviction

Answer 11

Just add new script to package.json called nodemon (or choose your own name)

"scripts": {
  ...
  "nodemon": "nodemon ./bin/www"
}

Then go to Run/Debug Configuration and add npm configuration. Set

• Command to "run"
• Script to "nodemon" (name you chose in package.json)

Pico

Answer 12

1. Do a npm install nodmemon -g

2. Only change the Path to Node to the nodemon.cmd, in my case (C:\Users\Rohit Taneja\AppData\Roaming\npm\nodemon.cmd), you'll also get this path after your installion of nodemon finishes.

3. You're good to go

Pieter

Answer 13

some of these answers appear to only work for Mac. For Windows, this configuration seems to work (my user name on Windows 7 is denman).

main.js is the starting point file for my Express application.

Conviction

Answer 14

I have a development in mac and as OdkoPP indicates I made it work

"scripts": {
"build": "tsc",
"dev": "nodemon src/index.ts --exec ts-node"
},

Run/Debug Configurations npm:

Spermicide

Answer 15

Per @bernhardw comment, as this was the answer for me -

All is needed is /usr/local/bin/nodemon under node parameters Works for run and debug as it restarts upon changes, but debugging with breakpoint does not work.

Bonus: add -e for more extension e.g /usr/local/bin/nodemon -e js,html,jade

(osx 10.10.5, rubymine 7.1.4)

HTH

Bott

Answer 16

npm install -g nodemon

1* goto run->Edit Configurations->Press'+' at left corner and choose Node.js

2* Select Node.js and Press '+' 

3* Name as Nodemon, add path in javaScript file: C:\Users\Your_User_Name\AppData\Roaming\npm\node_modules\nodemon\bin\nodemon.js

4* Click Apply and Ok

5* Run the Nodemon

Caddaric

Answer 17

Script in package.json: "start": "nodemon --inspect -r babel-register src",

First pic: Run debug and it will start

Second pic: attaching to existing running node

Haft

Answer 18

Here is a fix for an error I was getting...

If you are using a Windows + NodeJS + nodemon. With an IntelliJ - Run Configuration.

ERROR: starting inspector on failed: address already in use

When I use nodemon version 1.19.1, I get the error. When I use nodemon version 1.18.11, it works!

Good luck...

Siddra

Answer 19

This is how I am running

1. Installed nodemon package

   npm install -g nodemon # OR using yarn: yarn global add nodemon

2. From Webstorm terminal, run

   nodemon index.js

This is how it will show running in terminal

Pam