npm-run-script(1) [netbsd man page]
NPM-RUN-SCRIPT(1) NPM-RUN-SCRIPT(1) NAME
npm-run-script - Run arbitrary package scripts SYNOPSIS
npm run-script <command> [--silent] [-- <args>...] alias: npm run 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. As of ` https://blog.npmjs.org/post/98131109725/npm-2-0-0, you can use custom arguments when executing scripts. The special option -- is used by getopt https://goo.gl/KxMmtG to delimit the end of the options. npm will pass all the arguments after the -- directly to your script: 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 run- time. 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"} to run your tests. 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 the cmd.exe. The actual shell referred to by /bin/sh also depends on the system. As of ` https://github.com/npm/npm/releases/tag/v5.1.0 you can customize the shell with the script-shell configuration. Scripts are run from the root of the module, regardless of what your current working directory is when you call npm run. 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. Also, if the --scripts-prepend-node-path is passed, the directory within which node resides is added to the PATH. If --scripts-prepend-node-path=auto is passed (which has been the default in npm v3), this is only performed when that node executable is not found in the PATH. 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. You can use the --silent flag to prevent showing npm ERR! output on error. You can use the --if-present flag to avoid exiting with a non-zero exit code when the script is undefined. This lets you run potentially undefined scripts without breaking the execution chain. SEE ALSO
o npm help 7 scripts o npm help test o npm help start o npm help restart o npm help stop o npm help 7 config January 2019 NPM-RUN-SCRIPT(1)
Check Out this Related Man Page
NPX(1) User Commands NPX(1) NAME
npx - execute npm package binaries SYNOPSIS
npx [options] <command>[@version] [command-arg]... npx [options] [-p|--package <pkg>]... <command> [command-arg]... npx [options] -c '<command-string>' npx --shell-auto-fallback [shell] INSTALL
npm install -g npx DESCRIPTION
Executes <command> either from a local node_modules/.bin, or from a central cache, installing any packages needed in order for <command> to run. By default, npx will check whether <command> exists in $PATH, or in the local project binaries, and execute that. If <command> is not found, it will be installed prior to execution. Unless a --package option is specified, npx will try to guess the name of the binary to invoke depending on the specifier provided. All package specifiers understood by npm may be used with npx, including git specifiers, remote tarballs, local directories, or scoped pack- ages. If a full specifier is included, or if --package is used, npx will always use a freshly-installed, temporary version of the package. This can also be forced with the --ignore-existing flag. o -p, --package <package> - define the package to be installed. This defaults to the value of <command>. This is only needed for packages with multiple binaries if you want to call one of the other executables, or where the binary name does not match the package name. If this option is provided <command> will be executed as-is, without interpreting @version if it's there. Multiple --package options may be provided, and all the packages specified will be installed. o --no-install - If passed to npx, it will only try to run <command> if it already exists in the current path or in $prefix/node_mod- ules/.bin. It won't try to install missing commands. o --cache <path> - set the location of the npm cache. Defaults to npm's own cache settings. o --userconfig <path> - path to the user configuration file to pass to npm. Defaults to whatever npm's current default is. o -c <string> - Execute <string> inside an npm run-script-like shell environment, with all the usual environment variables available. Only the first item in <string> will be automatically used as <command>. Any others must use -p. o --shell <string> - The shell to invoke the command with, if any. o --shell-auto-fallback [<shell>] - Generates shell code to override your shell's "command not found" handler with one that calls npx. Tries to figure out your shell, or you can pass its name (either bash, fish, or zsh) as an option. See below for how to install. o --ignore-existing - If this flag is set, npx will not look in $PATH, or in the current package's node_modules/.bin for an existing ver- sion before deciding whether to install. Binaries in those paths will still be available for execution, but will be shadowed by any pack- ages requested by this install. o -q, --quiet - Suppressed any output from npx itself (progress bars, error messages, install reports). Subcommand output itself will not be silenced. o -n, --node-arg - Extra node argument to supply to node when binary is a node script. You can supply this option multiple times to add more arguments. o -v, --version - Show the current npx version. EXAMPLES
Running a project-local bin $ npm i -D webpack $ npx webpack ... One-off invocation without local installation $ npm rm webpack $ npx webpack -- ... $ cat package.json ...webpack not in "devDependencies"... Invoking a command from a github repository $ npx github:piuccio/cowsay ...or... $ npx git+ssh://my.hosted.git:cowsay.git#semver:^1 ...etc... Execute a full shell command using one npx call w/ multiple packages $ npx -p lolcatjs -p cowsay -c 'echo "$npm_package_name@$npm_package_version" | cowsay | lolcatjs' ... _____ < your-cool-package@1.2.3 > ----- ^__^ (oo)\_______ (__) )/ ||----w | || || Run node binary with --inspect $ npx --node-arg=--inspect cowsay Debugger listening on ws://127.0.0.1:9229/.... Specify a node version to run npm scripts (or anything else!) npx -p node@8 npm run build SHELL AUTO FALLBACK
You can configure npx to run as your default fallback command when you type something in the command line with an @ but the command is not found. This includes installing packages that were not found in the local prefix either. For example: $ npm@4 --version (stderr) npm@4 not found. Trying with npx... 4.6.1 $ asdfasdfasf zsh: command not found: asfdasdfasdf Currently, zsh, bash (>= 4), and fish are supported. You can access these completion scripts using npx --shell-auto-fallback <shell>. To install permanently, add the relevant line below to your ~/.bashrc, ~/.zshrc, ~/.config/fish/config.fish, or as needed. To install just for the shell session, simply run the line. You can optionally pass through --no-install when generating the fallback to prevent it from installing packages if the command is missing. For bash@>=4: $ source <(npx --shell-auto-fallback bash) For zsh: $ source <(npx --shell-auto-fallback zsh) For fish: $ source (npx --shell-auto-fallback fish | psub) ACKNOWLEDGEMENTS
Huge thanks to Kwyn Meagher https://blog.kwyn.io for generously donating the package name in the main npm registry. Previously npx was used for a Tessel board Neopixels library, which can now be found under npx-tessel https://npm.im/npx-tessel. AUTHOR
Written by Kat Marchan https://github.com/zkat. REPORTING BUGS
Please file any relevant issues on Github. https://github.com/zkat/npx LICENSE
This work is released by its authors into the public domain under CC0-1.0. See LICENSE.md for details. SEE ALSO
o npm(1) o npm-run-script(1) o npm-config(7) npx@10.1.1 April 2018 NPX(1)