1<!DOCTYPE html><html><head> 2<meta charset="utf-8"> 3<title>npm-rebuild</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-rebuild">npm-rebuild</h1> 140<span class="description">Rebuild 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="#configuration">Configuration</a></li><ul><li><a href="#global"><code>global</code></a></li><li><a href="#bin-links"><code>bin-links</code></a></li><li><a href="#foreground-scripts"><code>foreground-scripts</code></a></li><li><a href="#ignore-scripts"><code>ignore-scripts</code></a></li><li><a href="#workspace"><code>workspace</code></a></li><li><a href="#workspaces"><code>workspaces</code></a></li><li><a href="#include-workspace-root"><code>include-workspace-root</code></a></li><li><a href="#install-links"><code>install-links</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 rebuild [<package-spec>] ...] 150 151alias: rb 152</code></pre> 153<h3 id="description">Description</h3> 154<p>This command runs the <code>npm build</code> command on the matched folders. This is 155useful when you install a new version of node, and must recompile all your 156C++ addons with the new binary. It is also useful when installing with 157<code>--ignore-scripts</code> and <code>--no-bin-links</code>, to explicitly choose which 158packages to build and/or link bins.</p> 159<p>If one or more package specs are provided, then only packages with a 160name and version matching one of the specifiers will be rebuilt.</p> 161<h3 id="configuration">Configuration</h3> 162<h4 id="global"><code>global</code></h4> 163<ul> 164<li>Default: false</li> 165<li>Type: Boolean</li> 166</ul> 167<p>Operates in "global" mode, so that packages are installed into the <code>prefix</code> 168folder instead of the current working directory. See 169<a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p> 170<ul> 171<li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead 172of the current working directory.</li> 173<li>bin files are linked to <code>{prefix}/bin</code></li> 174<li>man pages are linked to <code>{prefix}/share/man</code></li> 175</ul> 176<h4 id="bin-links"><code>bin-links</code></h4> 177<ul> 178<li>Default: true</li> 179<li>Type: Boolean</li> 180</ul> 181<p>Tells npm to create symlinks (or <code>.cmd</code> shims on Windows) for package 182executables.</p> 183<p>Set to false to have it not do this. This can be used to work around the 184fact that some file systems don't support symlinks, even on ostensibly Unix 185systems.</p> 186<h4 id="foreground-scripts"><code>foreground-scripts</code></h4> 187<ul> 188<li>Default: false</li> 189<li>Type: Boolean</li> 190</ul> 191<p>Run all build scripts (ie, <code>preinstall</code>, <code>install</code>, and <code>postinstall</code>) 192scripts for installed packages in the foreground process, sharing standard 193input, output, and error with the main npm process.</p> 194<p>Note that this will generally make installs run slower, and be much noisier, 195but can be useful for debugging.</p> 196<h4 id="ignore-scripts"><code>ignore-scripts</code></h4> 197<ul> 198<li>Default: false</li> 199<li>Type: Boolean</li> 200</ul> 201<p>If true, npm does not run scripts specified in package.json files.</p> 202<p>Note that commands explicitly intended to run a particular script, such as 203<code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code> 204will still run their intended script if <code>ignore-scripts</code> is set, but they 205will <em>not</em> run any pre- or post-scripts.</p> 206<h4 id="workspace"><code>workspace</code></h4> 207<ul> 208<li>Default:</li> 209<li>Type: String (can be set multiple times)</li> 210</ul> 211<p>Enable running a command in the context of the configured workspaces of the 212current project while filtering by running only the workspaces defined by 213this configuration option.</p> 214<p>Valid values for the <code>workspace</code> config are either:</p> 215<ul> 216<li>Workspace names</li> 217<li>Path to a workspace directory</li> 218<li>Path to a parent workspace directory (will result in selecting all 219workspaces within that folder)</li> 220</ul> 221<p>When set for the <code>npm init</code> command, this may be set to the folder of a 222workspace which does not yet exist, to create the folder and set it up as a 223brand new workspace within the project.</p> 224<p>This value is not exported to the environment for child processes.</p> 225<h4 id="workspaces"><code>workspaces</code></h4> 226<ul> 227<li>Default: null</li> 228<li>Type: null or Boolean</li> 229</ul> 230<p>Set to true to run the command in the context of <strong>all</strong> configured 231workspaces.</p> 232<p>Explicitly setting this to false will cause commands like <code>install</code> to 233ignore workspaces altogether. When not set explicitly:</p> 234<ul> 235<li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.) 236will link workspaces into the <code>node_modules</code> folder. - Commands that do 237other things (test, exec, publish, etc.) will operate on the root project, 238<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li> 239</ul> 240<p>This value is not exported to the environment for child processes.</p> 241<h4 id="include-workspace-root"><code>include-workspace-root</code></h4> 242<ul> 243<li>Default: false</li> 244<li>Type: Boolean</li> 245</ul> 246<p>Include the workspace root when workspaces are enabled for a command.</p> 247<p>When false, specifying individual workspaces via the <code>workspace</code> config, or 248all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on 249the specified workspaces, and not on the root project.</p> 250<p>This value is not exported to the environment for child processes.</p> 251<h4 id="install-links"><code>install-links</code></h4> 252<ul> 253<li>Default: false</li> 254<li>Type: Boolean</li> 255</ul> 256<p>When set file: protocol dependencies will be packed and installed as regular 257dependencies instead of creating a symlink. This option has no effect on 258workspaces.</p> 259<h3 id="see-also">See Also</h3> 260<ul> 261<li><a href="../using-npm/package-spec.html">package spec</a></li> 262<li><a href="../commands/npm-install.html">npm install</a></li> 263</ul></div> 264 265<footer id="edit"> 266<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-rebuild.md"> 267<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;"> 268<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> 269</svg> 270Edit this page on GitHub 271</a> 272</footer> 273</section> 274 275 276 277</body></html>