Man page - npm-run-script(1)

Packages contains this manual

Package:  npm
apt-get install npm

Manuals in package:
• npm-root(1)
• npm-explain(1)
• npm-whoami(1)
• npm-pack(1)
• npm-bugs(1)
• npm-view(1)
• npm-outdated(1)
• npm-update(1)
• npm-query(1)
• npm-logout(1)
• npm-deprecate(1)
• npm-exec(1)
• npm-ping(1)
• npm-shrinkwrap-json(5)
• npm-help(1)
• npm-prefix(1)
• npm-diff(1)
• npm-owner(1)
• npm-install(1)
• npmrc(5)
• npm-uninstall(1)
• npm-hook(1)
• npm-unstar(1)
• npm-docs(1)
• pacote(1)
• npm-restart(1)
• npm-star(1)
• npm-link(1)
• npm-test(1)
• npm-token(1)
• npm-arborist(1)
• npm-profile(1)
• npm-team(1)
• npx(1)
• npm-stars(1)
• npm-adduser(1)
• npm-cache(1)
• npm-edit(1)
• npm-doctor(1)
• npm-help-search(1)
• arborist(1)
• npm-rebuild(1)
• npm-repo(1)
• npm-publish(1)
• npm-start(1)
• npm-unpublish(1)
• npm-dedupe(1)
• npm-init(1)
• npm-dist-tag(1)
• npm-login(1)
• npm-config(1)
• npm(1)
• npm-search(1)
• npm-version(1)
• npm-org(1)
• npm-shrinkwrap(1)
• npm-ls(1)
• package-json(5)
• npm-stop(1)
• npm-install-test(1)
• npm-completion(1)
• npm-run-script(1)
• npm-prune(1)
• npm-access(1)
• npm-ci(1)
• npm-audit(1)
• npm-find-dupes(1)
• npm-install-ci-test(1)
• package-lock-json(5)
• npm-fund(1)
• npm-explore(1)
• npm-pkg(1)
Documentations in package:
• node-pacote
• node-npmcli-mock-registry
• node-npmcli-node-gyp
• node-libnpmorg
• npm
• node-libnpmteam
• node-npmcli-promise-spawn
• node-libnpmdiff
• node-npmcli-run-script
• node-npmcli-metavuln-calculator
• node-npmcli-smoke-tests
• node-libnpmpublish
• node-qrcode-terminal
• node-npmcli-config
• node-npmcli-git
• node-libnpmaccess
• node-npm-packlist
• node-npmcli-disparity-colors
• node-libnpmexec
• node-npmcli-installed-package-contents
• node-libnpmpack
• node-npmcli-map-workspaces
• node-npmcli-query
• node-npmcli-arborist
• node-npmcli-package-json
• node-libnpmhook
• node-npmcli-name-from-folder
• node-libnpmversion
• node-libnpmfund
• node-libnpmsearch

Manual

NPM-RUN-SCRIPT

NAME
Synopsis
Description
Workspaces support
Filtering workspaces
Configuration
See Also

---

NAME

npm-run-script

Synopsis

<!-- AUTOGENERATED USAGE DESCRIPTIONS -->

Description

This runs an arbitrary command from a package’s &quot;scripts&quot; object. If no
&quot;command&quot; 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 run test -- --grep="pattern"

The arguments will only be passed to the script specified after npm run
and not to any pre or post script.

The env 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-existing PATH , npm run adds
node_modules/.bin to the PATH provided to scripts. Any binaries
provided by locally-installed dependencies can be used without the
node_modules/.bin prefix. For example, if there is a devDependency on
tap 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 is
cmd.exe .
The actual shell referred to by /bin/sh also depends on the system.
You can customize the shell with the
script-shell config.

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

npm run sets the NODE environment variable to the node executable
with which npm is executed.

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

Workspaces support

You may use the workspace or
workspaces configs in order to run an
arbitrary command from a package’s &quot;scripts&quot; object in the context of the
specified workspaces. If no &quot;command&quot; 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 level
package.json file. e.g:

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

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

npm test --workspaces

Filtering workspaces

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

npm test --workspace=a

The workspace 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 workspace config in the command line, it also possible to use -w as a
shorthand, e.g:

npm test -w a -w b

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

Configuration

<!-- AUTOGENERATED CONFIG DESCRIPTIONS -->

See Also

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

---