from small one page howto to huge articles all in one place
Last additions:
May 25th. 2007:
April, 26th. 2006:
|
You are here: manpages
NP-START
Section: (1) Updated: October 2025 Index
Return to Main Contents
NAME
np-start- Start a package
Synopsis
-
npm start [lB- <args>[rB]
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 [rs]fBnpm@2.0.0[rs]fR lahttps://blog.npmjs.org/post/98131109725/np---0ra, you can use custom arguments when executing scripts. Refer to npm help run 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
ignor-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 as npm start, npm stop, npm restart, npm test, and npm
run will still run their intended script if ignor-scripts is set, but they will not run any pr- or pos-scripts.
scrip-shell
-
- *
-
Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows
- *
-
Type: null or String
The shell to use for scripts run with the npm exec, npm run and npm init <packag-spec> commands.
See Also
-
- *
-
npm help run
- *
-
npm help scripts
- *
-
npm help test
- *
-
npm help restart
- *
-
npm help stop
Index
- NAME
-
- Synopsis
-
- Description
-
- Example
-
- Configuration
-
- ignore-scripts
-
- script-shell
-
- See Also
-
|