1<!DOCTYPE html><html><head> 2<meta charset="utf-8"> 3<title>npm-start</title> 4<style> 5body { 6 background-color: #ffffff; 7 color: #24292e; 8 9 margin: 0; 10 11 line-height: 1.5; 12 13 font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; 14} 15#rainbar { 16 height: 10px; 17 background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff); 18} 19 20a { 21 text-decoration: none; 22 color: #0366d6; 23} 24a:hover { 25 text-decoration: underline; 26} 27 28pre { 29 margin: 1em 0px; 30 padding: 1em; 31 border: solid 1px #e1e4e8; 32 border-radius: 6px; 33 34 display: block; 35 overflow: auto; 36 37 white-space: pre; 38 39 background-color: #f6f8fa; 40 color: #393a34; 41} 42code { 43 font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace; 44 font-size: 85%; 45 padding: 0.2em 0.4em; 46 background-color: #f6f8fa; 47 color: #393a34; 48} 49pre > code { 50 padding: 0; 51 background-color: inherit; 52 color: inherit; 53} 54h1, h2, h3 { 55 font-weight: 600; 56} 57 58#logobar { 59 background-color: #333333; 60 margin: 0 auto; 61 padding: 1em 4em; 62} 63#logobar .logo { 64 float: left; 65} 66#logobar .title { 67 font-weight: 600; 68 color: #dddddd; 69 float: left; 70 margin: 5px 0 0 1em; 71} 72#logobar:after { 73 content: ""; 74 display: block; 75 clear: both; 76} 77 78#content { 79 margin: 0 auto; 80 padding: 0 4em; 81} 82 83#table_of_contents > h2 { 84 font-size: 1.17em; 85} 86#table_of_contents ul:first-child { 87 border: solid 1px #e1e4e8; 88 border-radius: 6px; 89 padding: 1em; 90 background-color: #f6f8fa; 91 color: #393a34; 92} 93#table_of_contents ul { 94 list-style-type: none; 95 padding-left: 1.5em; 96} 97#table_of_contents li { 98 font-size: 0.9em; 99} 100#table_of_contents li a { 101 color: #000000; 102} 103 104header.title { 105 border-bottom: solid 1px #e1e4e8; 106} 107header.title > h1 { 108 margin-bottom: 0.25em; 109} 110header.title > .description { 111 display: block; 112 margin-bottom: 0.5em; 113 line-height: 1; 114} 115 116footer#edit { 117 border-top: solid 1px #e1e4e8; 118 margin: 3em 0 4em 0; 119 padding-top: 2em; 120} 121</style> 122</head> 123<body> 124<div id="banner"> 125<div id="rainbar"></div> 126<div id="logobar"> 127<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700"> 128<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon> 129<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon> 130</svg> 131<div class="title"> 132npm command-line interface 133</div> 134</div> 135</div> 136 137<section id="content"> 138<header class="title"> 139<h1 id="npm-start">npm-start</h1> 140<span class="description">Start a package</span> 141</header> 142 143<section id="table_of_contents"> 144<h2 id="table-of-contents">Table of contents</h2> 145<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#example">Example</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#ignore-scripts"><code>ignore-scripts</code></a></li><li><a href="#script-shell"><code>script-shell</code></a></li></ul><li><a href="#see-also">See Also</a></li></ul></div> 146</section> 147 148<div id="_content"><h3 id="synopsis">Synopsis</h3> 149<pre><code class="language-bash">npm start [-- <args>] 150</code></pre> 151<h3 id="description">Description</h3> 152<p>This runs a predefined command specified in the <code>"start"</code> property of 153a package's <code>"scripts"</code> object.</p> 154<p>If the <code>"scripts"</code> object does not define a <code>"start"</code> property, npm 155will run <code>node server.js</code>.</p> 156<p>Note that this is different from the default node behavior of running 157the file specified in a package's <code>"main"</code> attribute when evoking with 158<code>node .</code></p> 159<p>As of <a href="https://blog.npmjs.org/post/98131109725/npm-2-0-0"><code>npm@2.0.0</code></a>, you can 160use custom arguments when executing scripts. Refer to <a href="../commands/npm-run-script.html"><code>npm run-script</code></a> for more details.</p> 161<h3 id="example">Example</h3> 162<pre><code class="language-json">{ 163 "scripts": { 164 "start": "node foo.js" 165 } 166} 167</code></pre> 168<pre><code class="language-bash">npm start 169 170> npm@x.x.x start 171> node foo.js 172 173(foo.js output would be here) 174 175</code></pre> 176<h3 id="configuration">Configuration</h3> 177<h4 id="ignore-scripts"><code>ignore-scripts</code></h4> 178<ul> 179<li>Default: false</li> 180<li>Type: Boolean</li> 181</ul> 182<p>If true, npm does not run scripts specified in package.json files.</p> 183<p>Note that commands explicitly intended to run a particular script, such as 184<code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code> 185will still run their intended script if <code>ignore-scripts</code> is set, but they 186will <em>not</em> run any pre- or post-scripts.</p> 187<h4 id="script-shell"><code>script-shell</code></h4> 188<ul> 189<li>Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows</li> 190<li>Type: null or String</li> 191</ul> 192<p>The shell to use for scripts run with the <code>npm exec</code>, <code>npm run</code> and <code>npm init <package-spec></code> commands.</p> 193<h3 id="see-also">See Also</h3> 194<ul> 195<li><a href="../commands/npm-run-script.html">npm run-script</a></li> 196<li><a href="../using-npm/scripts.html">npm scripts</a></li> 197<li><a href="../commands/npm-test.html">npm test</a></li> 198<li><a href="../commands/npm-restart.html">npm restart</a></li> 199<li><a href="../commands/npm-stop.html">npm stop</a></li> 200</ul></div> 201 202<footer id="edit"> 203<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-start.md"> 204<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;"> 205<path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path> 206</svg> 207Edit this page on GitHub 208</a> 209</footer> 210</section> 211 212 213 214</body></html>