File Explorer

1.TH "NPM-RUN" "1" "February 2026" "NPM@11.11.0" ""2.SH "NAME"3\fBnpm-run\fR - Run arbitrary package scripts4.SS "Synopsis"5.P6.RS 27.nf8npm run <command> \[lB]-- <args>\[rB]9 10aliases: run-script, rum, urn11.fi12.RE13.SS "Description"14.P15This runs an arbitrary command from a package's \fB"scripts"\fR object. If no \fB"command"\fR is provided, it will list the available scripts.16.P17\fBrun\[lB]-script\[rB]\fR is used by the test, start, restart, and stop commands, but can be called directly, as well. When the scripts in the package are printed out, they're separated into lifecycle (test, start, restart) and directly-run scripts.18.P19Any positional arguments are passed to the specified script. Use \fB--\fR to pass \fB-\fR-prefixed flags and options which would otherwise be parsed by npm.20.P21For example:22.P23.RS 224.nf25npm run test -- --grep="pattern"26.fi27.RE28.P29The arguments will only be passed to the script specified after \fBnpm run\fR and not to any \fBpre\fR or \fBpost\fR script.30.P31The \fBenv\fR script is a special built-in command that can be used to list environment variables that will be available to the script at runtime. If an "env" command is defined in your package, it will take precedence over the built-in.32.P33In addition to the shell's pre-existing \fBPATH\fR, \fBnpm run\fR adds \fBnode_modules/.bin\fR to the \fBPATH\fR provided to scripts. Any binaries provided by locally-installed dependencies can be used without the \fBnode_modules/.bin\fR prefix. For example, if there is a \fBdevDependency\fR on \fBtap\fR in your package, you should write:34.P35.RS 236.nf37"scripts": {"test": "tap test/*.js"}38.fi39.RE40.P41instead of42.P43.RS 244.nf45"scripts": {"test": "node_modules/.bin/tap test/*.js"}46.fi47.RE48.P49The actual shell your script is run within is platform dependent. By default, on Unix-like systems it is the \fB/bin/sh\fR command, on Windows it is \fBcmd.exe\fR. The actual shell referred to by \fB/bin/sh\fR also depends on the system. You can customize the shell with the \fB\[rs]fBscript-shell\[rs]fR config\fR \fI\(la/using-npm/config#script-shell\(ra\fR.50.P51Scripts are run from the root of the package folder, regardless of what the current working directory is when \fBnpm run\fR is called. If you want your script to use different behavior based on what subdirectory you're in, you can use the \fBINIT_CWD\fR environment variable, which holds the full path you were in when you ran \fBnpm run\fR.52.P53\fBnpm run\fR sets the \fBNODE\fR environment variable to the \fBnode\fR executable with which \fBnpm\fR is executed.54.P55If you try to run a script without having a \fBnode_modules\fR directory and it fails, you will be given a warning to run \fBnpm install\fR, just in case you've forgotten.56.SS "Workspaces support"57.P58You may use the \fB\[rs]fBworkspace\[rs]fR\fR \fI\(la/using-npm/config#workspace\(ra\fR or \fB\[rs]fBworkspaces\[rs]fR\fR \fI\(la/using-npm/config#workspaces\(ra\fR configs in order to run an arbitrary command from a package's \fB"scripts"\fR object in the context of the specified workspaces. If no \fB"command"\fR is provided, it will list the available scripts for each of these configured workspaces.59.P60Given a project with configured workspaces, e.g:61.P62.RS 263.nf64.65+-- package.json66`-- packages67   +-- a68   |   `-- package.json69   +-- b70   |   `-- package.json71   `-- c72       `-- package.json73.fi74.RE75.P76Assuming the workspace configuration is properly set up at the root level \fBpackage.json\fR file. e.g:77.P78.RS 279.nf80{81    "workspaces": \[lB] "./packages/*" \[rB]82}83.fi84.RE85.P86And that each of the configured workspaces has a configured \fBtest\fR script, we can run tests in all of them using the \fB\[rs]fBworkspaces\[rs]fR config\fR \fI\(la/using-npm/config#workspaces\(ra\fR:87.P88.RS 289.nf90npm test --workspaces91.fi92.RE93.SS "Filtering workspaces"94.P95It's also possible to run a script in a single workspace using the \fBworkspace\fR config along with a name or directory path:96.P97.RS 298.nf99npm test --workspace=a100.fi101.RE102.P103The \fBworkspace\fR config can also be specified multiple times in order to run a specific script in the context of multiple workspaces. When defining values for the \fBworkspace\fR config in the command line, it also possible to use \fB-w\fR as a shorthand, e.g:104.P105.RS 2106.nf107npm test -w a -w b108.fi109.RE110.P111This last command will run \fBtest\fR in both \fB./packages/a\fR and \fB./packages/b\fR packages.112.SS "Configuration"113.SS "\fBworkspace\fR"114.RS 0115.IP \(bu 4116Default:117.IP \(bu 4118Type: String (can be set multiple times)119.RE 0120 121.P122Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option.123.P124Valid values for the \fBworkspace\fR config are either:125.RS 0126.IP \(bu 4127Workspace names128.IP \(bu 4129Path to a workspace directory130.IP \(bu 4131Path to a parent workspace directory (will result in selecting all workspaces within that folder)132.RE 0133 134.P135When set for the \fBnpm init\fR command, this may be set to the folder of a workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.136.P137This value is not exported to the environment for child processes.138.SS "\fBworkspaces\fR"139.RS 0140.IP \(bu 4141Default: null142.IP \(bu 4143Type: null or Boolean144.RE 0145 146.P147Set to true to run the command in the context of \fBall\fR configured workspaces.148.P149Explicitly setting this to false will cause commands like \fBinstall\fR to ignore workspaces altogether. When not set explicitly:150.RS 0151.IP \(bu 4152Commands that operate on the \fBnode_modules\fR tree (install, update, etc.) will link workspaces into the \fBnode_modules\fR folder. - Commands that do other things (test, exec, publish, etc.) will operate on the root project, \fIunless\fR one or more workspaces are specified in the \fBworkspace\fR config.153.RE 0154 155.P156This value is not exported to the environment for child processes.157.SS "\fBinclude-workspace-root\fR"158.RS 0159.IP \(bu 4160Default: false161.IP \(bu 4162Type: Boolean163.RE 0164 165.P166Include the workspace root when workspaces are enabled for a command.167.P168When false, specifying individual workspaces via the \fBworkspace\fR config, or all workspaces via the \fBworkspaces\fR flag, will cause npm to operate only on the specified workspaces, and not on the root project.169.P170This value is not exported to the environment for child processes.171.SS "\fBif-present\fR"172.RS 0173.IP \(bu 4174Default: false175.IP \(bu 4176Type: Boolean177.RE 0178 179.P180If true, npm will not exit with an error code when \fBrun\fR is invoked for a script that isn't defined in the \fBscripts\fR section of \fBpackage.json\fR. This option can be used when it's desirable to optionally run a script when it's present and fail if the script fails. This is useful, for example, when running scripts that may only apply for some builds in an otherwise generic CI setup.181.P182This value is not exported to the environment for child processes.183.SS "\fBignore-scripts\fR"184.RS 0185.IP \(bu 4186Default: false187.IP \(bu 4188Type: Boolean189.RE 0190 191.P192If true, npm does not run scripts specified in package.json files.193.P194Note that commands explicitly intended to run a particular script, such as \fBnpm start\fR, \fBnpm stop\fR, \fBnpm restart\fR, \fBnpm test\fR, and \fBnpm run\fR will still run their intended script if \fBignore-scripts\fR is set, but they will \fInot\fR run any pre- or post-scripts.195.SS "\fBforeground-scripts\fR"196.RS 0197.IP \(bu 4198Default: \fBfalse\fR unless when using \fBnpm pack\fR or \fBnpm publish\fR where it defaults to \fBtrue\fR199.IP \(bu 4200Type: Boolean201.RE 0202 203.P204Run all build scripts (ie, \fBpreinstall\fR, \fBinstall\fR, and \fBpostinstall\fR) scripts for installed packages in the foreground process, sharing standard input, output, and error with the main npm process.205.P206Note that this will generally make installs run slower, and be much noisier, but can be useful for debugging.207.SS "\fBscript-shell\fR"208.RS 0209.IP \(bu 4210Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows211.IP \(bu 4212Type: null or String213.RE 0214 215.P216The shell to use for scripts run with the \fBnpm exec\fR, \fBnpm run\fR and \fBnpm217init <package-spec>\fR commands.218.SS "See Also"219.RS 0220.IP \(bu 4221npm help scripts222.IP \(bu 4223npm help test224.IP \(bu 4225npm help start226.IP \(bu 4227npm help restart228.IP \(bu 4229npm help stop230.IP \(bu 4231npm help config232.IP \(bu 4233npm help workspaces234.RE 0235