Synopsis

npm run-script<command>[--<args>]
aliases: run, rum, urn

Description

This runs an arbitrary command from a package's"scripts" object. If no"command" is provided, it will list the available scripts.

run[-script] 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.

Any positional arguments are passed to the specified script. Use-- to pass--prefixed flags and options which would otherwise be parsed by npm.

For example:

npm runtest ----grep="pattern"

The arguments will only be passed to the script specified afternpm run and not to anypre orpost script.

Theenv 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.

In addition to the shell's pre-existingPATH,npm run addsnode_modules/.bin to thePATH provided to scripts. Any binaries provided by locally-installed dependencies can be used without thenode_modules/.bin prefix. For example, if there is adevDependency ontap in your package, you should write:

"scripts":{"test":"tap test/*.js"}

instead of

"scripts":{"test":"node_modules/.bin/tap test/*.js"}

The actual shell your script is run within is platform dependent. By default, on Unix-like systems it is the/bin/sh command, on Windows it iscmd.exe. The actual shell referred to by/bin/sh also depends on the system. You can customize the shell with thescript-shell configuration.

Scripts are run from the root of the package folder, regardless of what the current working directory is whennpm run is called. If you want your script to use different behavior based on what subdirectory you're in, you can use theINIT_CWD environment variable, which holds the full path you were in when you rannpm run.

npm run sets theNODE environment variable to thenode executable with whichnpm is executed.

If you try to run a script without having anode_modules directory and it fails, you will be given a warning to runnpm install, just in case you've forgotten.

Workspaces support

You may use theworkspace orworkspaces configs in order to run an arbitrary command from a package's"scripts" object in the context of the specified workspaces. If no"command" is provided, it will list the available scripts for each of these configured workspaces.

Given a project with configured workspaces, e.g:

.
+-- package.json
`-- packages
   +-- a
|`-- package.json
   +-- b
|`-- package.json
`-- c
       `-- package.json

Assuming the workspace configuration is properly set up at the root levelpackage.json file. e.g:

{
"workspaces":["./packages/*"]
}

And that each of the configured workspaces has a configuredtest script, we can run tests in all of them using theworkspaces config:

Filtering workspaces

It's also possible to run a script in a single workspace using theworkspace config along with a name or directory path:

Theworkspace config can also be specified multiple times in order to run a specific script in the context of multiple workspaces. When defining values for theworkspace config in the command line, it also possible to use-w as a shorthand, e.g:

This last command will runtest in both./packages/a and./packages/b packages.

Configuration

workspace

• Default:
• Type: String (can be set multiple times)

Enable 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.

Valid values for theworkspace config are either:

• Workspace names
• Path to a workspace directory
• Path to a parent workspace directory (will result in selecting all workspaces within that folder)

When set for thenpm init 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.

This value is not exported to the environment for child processes.

workspaces

• Default: null
• Type: null or Boolean

Set to true to run the command in the context ofall configured workspaces.

Explicitly setting this to false will cause commands likeinstall to ignore workspaces altogether. When not set explicitly:

• Commands that operate on thenode_modules tree (install, update, etc.) will link workspaces into thenode_modules folder. - Commands that do other things (test, exec, publish, etc.) will operate on the root project,unless one or more workspaces are specified in theworkspace config.

This value is not exported to the environment for child processes.

include-workspace-root

• Default: false
• Type: Boolean

Include the workspace root when workspaces are enabled for a command.

When false, specifying individual workspaces via theworkspace config, or all workspaces via theworkspaces flag, will cause npm to operate only on the specified workspaces, and not on the root project.

This value is not exported to the environment for child processes.

if-present

• Default: false
• Type: Boolean

If true, npm will not exit with an error code whenrun-script is invoked for a script that isn't defined in thescripts section ofpackage.json. 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.

This value is not exported to the environment for child processes.

ignore-scripts

• Default: false
• Type: Boolean

If true, npm does not run scripts specified in package.json files.

Note that commands explicitly intended to run a particular script, such asnpm start,npm stop,npm restart,npm test, andnpm run-script will still run their intended script ifignore-scripts is set, but they willnot run any pre- or post-scripts.

foreground-scripts

• Default: false
• Type: Boolean

Run all build scripts (ie,preinstall,install, andpostinstall) scripts for installed packages in the foreground process, sharing standard input, output, and error with the main npm process.

Note that this will generally make installs run slower, and be much noisier, but can be useful for debugging.

script-shell

• Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows
• Type: null or String

The shell to use for scripts run with thenpm exec,npm run andnpm init <package-spec> commands.

See Also

• npm scripts
• npm test
• npm start
• npm restart
• npm stop
• npm config
• npm workspaces

Edit this page on GitHub

1 contributorlukekarrys

Last edited bylukekarrys onOctober 26, 2022