npm-start - Start a package Synopsis npm start [-- <args>] Description This runs a predefined command specified in the "start" property of a package's "scripts" object. If the "scripts" object does not define a "start" property, npm will run node server.js. Note that this is different from the default node behavior of running the file specified in a package's "main" attribute when evoking with node . As of npm@2.0.0 https://blog.npmjs.org/post/98131109725/npm-2-0-0, you can use custom arguments when executing scripts. Refer to npm help run-script for more details. Example { "scripts": { "start": "node foo.js" } } npm start > npm@x.x.x start > node foo.js (foo.js output would be here) Configuration ignore-scripts o Default: false o 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 as npm start, npm stop, npm restart, npm test, and npm run-script will still run their intended script if ignore-scripts is set, but they will not run any pre- or post-scripts. script-shell o Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows o Type: null or String The shell to use for scripts run with the npm exec, npm run and npm init <pkg> commands. See Also o npm help run-script o npm help scripts o npm help test o npm help restart o npm help stop
Please see following description for synopsis
NPM-START(1) NPM-START(1)
NAME
npm-start - Start a package
Synopsis
npm start [-- <args>]
Description
This runs a predefined command specified in the "start" property of a
package's "scripts" object.
If the "scripts" object does not define a "start" property, npm will
run node server.js.
Note that this is different from the default node behavior of running
the file specified in a package's "main" attribute when evoking with
node .
As of npm@2.0.0 https://blog.npmjs.org/post/98131109725/npm-2-0-0, you
can use custom arguments when executing scripts. Refer to npm help
run-script for more details.
Example
{
"scripts": {
"start": "node foo.js"
}
}
npm start
> npm@x.x.x start
> node foo.js
(foo.js output would be here)
Configuration
ignore-scripts
o Default: false
o 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
as npm start, npm stop, npm restart, npm test, and npm run-script will
still run their intended script if ignore-scripts is set, but they will
not run any pre- or post-scripts.
script-shell
o Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows
o Type: null or String
The shell to use for scripts run with the npm exec, npm run and npm
init <pkg> commands.
See Also
o npm help run-script
o npm help scripts
o npm help test
o npm help restart
o npm help stop
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+--------------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+--------------------------+
|Availability | runtime/nodejs/nodejs-18 |
+---------------+--------------------------+
|Stability | Pass-thru volatile |
+---------------+--------------------------+
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://github.com/nodejs/node/ar-
chive/v18.1.0.zip.
Further information about this software can be found on the open source
community website at https://github.com/nodejs/node.
April 2022 NPM-START(1)