codekingpro/portable-devtools

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
116header.title .version {
117    font-size: 0.8em;
118    color: #666666;
119}
120
121footer#edit {
122    border-top: solid 1px #e1e4e8;
123    margin: 3em 0 4em 0;
124    padding-top: 2em;
125}
126
127table {
128    width: 100%;
129    margin: 1em 0;
130    border-radius: 6px;
131    border: 1px solid #e1e4e8;
132    overflow: hidden;
133    border-collapse: separate;
134    border-spacing: 0;
135}
136
137table thead {
138    background-color: #f6f8fa;
139}
140
141table tbody {
142    background-color: #ffffff;
143}
144
145table th,
146table td {
147    padding: 0.75em;
148    text-align: left;
149    border-right: 1px solid #e1e4e8;
150    border-bottom: 1px solid #e1e4e8;
151}
152
153table th:last-child,
154table td:last-child {
155    border-right: none;
156}
157
158table tbody tr:last-child td {
159    border-bottom: none;
160}
161
162table th {
163    font-weight: 600;
164    background-color: #f6f8fa;
165}
166
167table code {
168    white-space: nowrap;
169}
170
171</style>
172</head>
173<body>
174<div id="banner">
175<div id="rainbar"></div>
176<div id="logobar">
177<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
178<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
179<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
180</svg>
181<div class="title">
182npm command-line interface
183</div>
184</div>
185</div>
186
187<section id="content">
188<header class="title">
189<h1 id="----npm-rebuild----11130">
190    <span>npm-rebuild</span>
191    <span class="version">@11.13.0</span>
192</h1>
193<span class="description">Rebuild a package</span>
194</header>
195
196<section id="table_of_contents">
197<h2 id="table-of-contents">Table of contents</h2>
198<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>
199</section>
200
201<div id="_content"><h3 id="synopsis">Synopsis</h3>
202<pre><code class="language-bash">npm rebuild [&lt;package-spec&gt;] ...]
203
204alias: rb
205</code></pre>
206<h3 id="description">Description</h3>
207<p>This command does the following:</p>
208<ol>
209<li>Execute lifecycle scripts (<code>preinstall</code>, <code>install</code>, <code>postinstall</code>, <code>prepare</code>)</li>
210<li>Links bins depending on whether bin links are enabled</li>
211</ol>
212<p>This command is particularly useful in scenarios including but not limited to:</p>
213<ol>
214<li>Installing a new version of <strong>node.js</strong>, where you need to recompile all your C++ add-ons with the updated binary.</li>
215<li>Installing with <code>--ignore-scripts</code> and <code>--no-bin-links</code>, to explicitly choose which packages to build and/or link bins.</li>
216</ol>
217<p>If one or more package specs are provided, then only packages with a name and version matching one of the specifiers will be rebuilt.</p>
218<p>Usually, you should not need to run <code>npm rebuild</code> as it is already done for you as part of npm install (unless you suppressed these steps with <code>--ignore-scripts</code> or <code>--no-bin-links</code>).</p>
219<p>If there is a <code>binding.gyp</code> file in the root of your package, then npm will use a default install hook:</p>
220<pre><code>"scripts": {
221    "install": "node-gyp rebuild"
222}
223</code></pre>
224<p>This default behavior is suppressed if the <code>package.json</code> has its own <code>install</code> or <code>preinstall</code> scripts.
225It is also suppressed if the package specifies <code>"gypfile": false</code></p>
226<h3 id="configuration">Configuration</h3>
227<h4 id="global"><code>global</code></h4>
228<ul>
229<li>Default: false</li>
230<li>Type: Boolean</li>
231</ul>
232<p>Operates in "global" mode, so that packages are installed into the <code>prefix</code>
233folder instead of the current working directory. See
234<a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p>
235<ul>
236<li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead
237of the current working directory.</li>
238<li>bin files are linked to <code>{prefix}/bin</code></li>
239<li>man pages are linked to <code>{prefix}/share/man</code></li>
240</ul>
241<h4 id="bin-links"><code>bin-links</code></h4>
242<ul>
243<li>Default: true</li>
244<li>Type: Boolean</li>
245</ul>
246<p>Tells npm to create symlinks (or <code>.cmd</code> shims on Windows) for package
247executables.</p>
248<p>Set to false to have it not do this. This can be used to work around the
249fact that some file systems don't support symlinks, even on ostensibly Unix
250systems.</p>
251<h4 id="foreground-scripts"><code>foreground-scripts</code></h4>
252<ul>
253<li>Default: <code>false</code> unless when using <code>npm pack</code> or <code>npm publish</code> where it
254defaults to <code>true</code></li>
255<li>Type: Boolean</li>
256</ul>
257<p>Run all build scripts (ie, <code>preinstall</code>, <code>install</code>, and <code>postinstall</code>)
258scripts for installed packages in the foreground process, sharing standard
259input, output, and error with the main npm process.</p>
260<p>Note that this will generally make installs run slower, and be much noisier,
261but can be useful for debugging.</p>
262<h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
263<ul>
264<li>Default: false</li>
265<li>Type: Boolean</li>
266</ul>
267<p>If true, npm does not run scripts specified in package.json files.</p>
268<p>Note that commands explicitly intended to run a particular script, such as
269<code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run</code> will still
270run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em>
271run any pre- or post-scripts.</p>
272<h4 id="workspace"><code>workspace</code></h4>
273<ul>
274<li>Default:</li>
275<li>Type: String (can be set multiple times)</li>
276</ul>
277<p>Enable running a command in the context of the configured workspaces of the
278current project while filtering by running only the workspaces defined by
279this configuration option.</p>
280<p>Valid values for the <code>workspace</code> config are either:</p>
281<ul>
282<li>Workspace names</li>
283<li>Path to a workspace directory</li>
284<li>Path to a parent workspace directory (will result in selecting all
285workspaces within that folder)</li>
286</ul>
287<p>When set for the <code>npm init</code> command, this may be set to the folder of a
288workspace which does not yet exist, to create the folder and set it up as a
289brand new workspace within the project.</p>
290<p>This value is not exported to the environment for child processes.</p>
291<h4 id="workspaces"><code>workspaces</code></h4>
292<ul>
293<li>Default: null</li>
294<li>Type: null or Boolean</li>
295</ul>
296<p>Set to true to run the command in the context of <strong>all</strong> configured
297workspaces.</p>
298<p>Explicitly setting this to false will cause commands like <code>install</code> to
299ignore workspaces altogether. When not set explicitly:</p>
300<ul>
301<li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
302will link workspaces into the <code>node_modules</code> folder. - Commands that do
303other things (test, exec, publish, etc.) will operate on the root project,
304<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
305</ul>
306<p>This value is not exported to the environment for child processes.</p>
307<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
308<ul>
309<li>Default: false</li>
310<li>Type: Boolean</li>
311</ul>
312<p>Include the workspace root when workspaces are enabled for a command.</p>
313<p>When false, specifying individual workspaces via the <code>workspace</code> config, or
314all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
315the specified workspaces, and not on the root project.</p>
316<p>This value is not exported to the environment for child processes.</p>
317<h4 id="install-links"><code>install-links</code></h4>
318<ul>
319<li>Default: false</li>
320<li>Type: Boolean</li>
321</ul>
322<p>When set file: protocol dependencies will be packed and installed as regular
323dependencies instead of creating a symlink. This option has no effect on
324workspaces.</p>
325<h3 id="see-also">See Also</h3>
326<ul>
327<li><a href="../using-npm/package-spec.html">package spec</a></li>
328<li><a href="../commands/npm-install.html">npm install</a></li>
329</ul></div>
330
331<footer id="edit">
332<a href="https://github.com/npm/cli/edit/latest/docs/lib/content/commands/npm-rebuild.md">
333<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
334<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>
335</svg>
336Edit this page on GitHub
337</a>
338</footer>
339</section>
340
341
342
343</body></html>