11cb0ef41Sopenharmony_ci<!DOCTYPE html><html><head>
21cb0ef41Sopenharmony_ci<meta charset="utf-8">
31cb0ef41Sopenharmony_ci<title>npm-rebuild</title>
41cb0ef41Sopenharmony_ci<style>
51cb0ef41Sopenharmony_cibody {
61cb0ef41Sopenharmony_ci    background-color: #ffffff;
71cb0ef41Sopenharmony_ci    color: #24292e;
81cb0ef41Sopenharmony_ci
91cb0ef41Sopenharmony_ci    margin: 0;
101cb0ef41Sopenharmony_ci
111cb0ef41Sopenharmony_ci    line-height: 1.5;
121cb0ef41Sopenharmony_ci
131cb0ef41Sopenharmony_ci    font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
141cb0ef41Sopenharmony_ci}
151cb0ef41Sopenharmony_ci#rainbar {
161cb0ef41Sopenharmony_ci    height: 10px;
171cb0ef41Sopenharmony_ci    background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
181cb0ef41Sopenharmony_ci}
191cb0ef41Sopenharmony_ci
201cb0ef41Sopenharmony_cia {
211cb0ef41Sopenharmony_ci    text-decoration: none;
221cb0ef41Sopenharmony_ci    color: #0366d6;
231cb0ef41Sopenharmony_ci}
241cb0ef41Sopenharmony_cia:hover {
251cb0ef41Sopenharmony_ci    text-decoration: underline;
261cb0ef41Sopenharmony_ci}
271cb0ef41Sopenharmony_ci
281cb0ef41Sopenharmony_cipre {
291cb0ef41Sopenharmony_ci    margin: 1em 0px;
301cb0ef41Sopenharmony_ci    padding: 1em;
311cb0ef41Sopenharmony_ci    border: solid 1px #e1e4e8;
321cb0ef41Sopenharmony_ci    border-radius: 6px;
331cb0ef41Sopenharmony_ci
341cb0ef41Sopenharmony_ci    display: block;
351cb0ef41Sopenharmony_ci    overflow: auto;
361cb0ef41Sopenharmony_ci
371cb0ef41Sopenharmony_ci    white-space: pre;
381cb0ef41Sopenharmony_ci
391cb0ef41Sopenharmony_ci    background-color: #f6f8fa;
401cb0ef41Sopenharmony_ci    color: #393a34;
411cb0ef41Sopenharmony_ci}
421cb0ef41Sopenharmony_cicode {
431cb0ef41Sopenharmony_ci    font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
441cb0ef41Sopenharmony_ci    font-size: 85%;
451cb0ef41Sopenharmony_ci    padding: 0.2em 0.4em;
461cb0ef41Sopenharmony_ci    background-color: #f6f8fa;
471cb0ef41Sopenharmony_ci    color: #393a34;
481cb0ef41Sopenharmony_ci}
491cb0ef41Sopenharmony_cipre > code {
501cb0ef41Sopenharmony_ci    padding: 0;
511cb0ef41Sopenharmony_ci    background-color: inherit;
521cb0ef41Sopenharmony_ci    color: inherit;
531cb0ef41Sopenharmony_ci}
541cb0ef41Sopenharmony_cih1, h2, h3 {
551cb0ef41Sopenharmony_ci    font-weight: 600;
561cb0ef41Sopenharmony_ci}
571cb0ef41Sopenharmony_ci
581cb0ef41Sopenharmony_ci#logobar {
591cb0ef41Sopenharmony_ci    background-color: #333333;
601cb0ef41Sopenharmony_ci    margin: 0 auto;
611cb0ef41Sopenharmony_ci    padding: 1em 4em;
621cb0ef41Sopenharmony_ci}
631cb0ef41Sopenharmony_ci#logobar .logo {
641cb0ef41Sopenharmony_ci    float: left;
651cb0ef41Sopenharmony_ci}
661cb0ef41Sopenharmony_ci#logobar .title {
671cb0ef41Sopenharmony_ci    font-weight: 600;
681cb0ef41Sopenharmony_ci    color: #dddddd;
691cb0ef41Sopenharmony_ci    float: left;
701cb0ef41Sopenharmony_ci    margin: 5px 0 0 1em;
711cb0ef41Sopenharmony_ci}
721cb0ef41Sopenharmony_ci#logobar:after {
731cb0ef41Sopenharmony_ci    content: "";
741cb0ef41Sopenharmony_ci    display: block;
751cb0ef41Sopenharmony_ci    clear: both;
761cb0ef41Sopenharmony_ci}
771cb0ef41Sopenharmony_ci
781cb0ef41Sopenharmony_ci#content {
791cb0ef41Sopenharmony_ci    margin: 0 auto;
801cb0ef41Sopenharmony_ci    padding: 0 4em;
811cb0ef41Sopenharmony_ci}
821cb0ef41Sopenharmony_ci
831cb0ef41Sopenharmony_ci#table_of_contents > h2 {
841cb0ef41Sopenharmony_ci    font-size: 1.17em;
851cb0ef41Sopenharmony_ci}
861cb0ef41Sopenharmony_ci#table_of_contents ul:first-child {
871cb0ef41Sopenharmony_ci    border: solid 1px #e1e4e8;
881cb0ef41Sopenharmony_ci    border-radius: 6px;
891cb0ef41Sopenharmony_ci    padding: 1em;
901cb0ef41Sopenharmony_ci    background-color: #f6f8fa;
911cb0ef41Sopenharmony_ci    color: #393a34;
921cb0ef41Sopenharmony_ci}
931cb0ef41Sopenharmony_ci#table_of_contents ul {
941cb0ef41Sopenharmony_ci    list-style-type: none;
951cb0ef41Sopenharmony_ci    padding-left: 1.5em;
961cb0ef41Sopenharmony_ci}
971cb0ef41Sopenharmony_ci#table_of_contents li {
981cb0ef41Sopenharmony_ci    font-size: 0.9em;
991cb0ef41Sopenharmony_ci}
1001cb0ef41Sopenharmony_ci#table_of_contents li a {
1011cb0ef41Sopenharmony_ci    color: #000000;
1021cb0ef41Sopenharmony_ci}
1031cb0ef41Sopenharmony_ci
1041cb0ef41Sopenharmony_ciheader.title {
1051cb0ef41Sopenharmony_ci    border-bottom: solid 1px #e1e4e8;
1061cb0ef41Sopenharmony_ci}
1071cb0ef41Sopenharmony_ciheader.title > h1 {
1081cb0ef41Sopenharmony_ci    margin-bottom: 0.25em;
1091cb0ef41Sopenharmony_ci}
1101cb0ef41Sopenharmony_ciheader.title > .description {
1111cb0ef41Sopenharmony_ci    display: block;
1121cb0ef41Sopenharmony_ci    margin-bottom: 0.5em;
1131cb0ef41Sopenharmony_ci    line-height: 1;
1141cb0ef41Sopenharmony_ci}
1151cb0ef41Sopenharmony_ci
1161cb0ef41Sopenharmony_cifooter#edit {
1171cb0ef41Sopenharmony_ci    border-top: solid 1px #e1e4e8;
1181cb0ef41Sopenharmony_ci    margin: 3em 0 4em 0;
1191cb0ef41Sopenharmony_ci    padding-top: 2em;
1201cb0ef41Sopenharmony_ci}
1211cb0ef41Sopenharmony_ci</style>
1221cb0ef41Sopenharmony_ci</head>
1231cb0ef41Sopenharmony_ci<body>
1241cb0ef41Sopenharmony_ci<div id="banner">
1251cb0ef41Sopenharmony_ci<div id="rainbar"></div>
1261cb0ef41Sopenharmony_ci<div id="logobar">
1271cb0ef41Sopenharmony_ci<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
1281cb0ef41Sopenharmony_ci<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
1291cb0ef41Sopenharmony_ci<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
1301cb0ef41Sopenharmony_ci</svg>
1311cb0ef41Sopenharmony_ci<div class="title">
1321cb0ef41Sopenharmony_cinpm command-line interface
1331cb0ef41Sopenharmony_ci</div>
1341cb0ef41Sopenharmony_ci</div>
1351cb0ef41Sopenharmony_ci</div>
1361cb0ef41Sopenharmony_ci
1371cb0ef41Sopenharmony_ci<section id="content">
1381cb0ef41Sopenharmony_ci<header class="title">
1391cb0ef41Sopenharmony_ci<h1 id="npm-rebuild">npm-rebuild</h1>
1401cb0ef41Sopenharmony_ci<span class="description">Rebuild a package</span>
1411cb0ef41Sopenharmony_ci</header>
1421cb0ef41Sopenharmony_ci
1431cb0ef41Sopenharmony_ci<section id="table_of_contents">
1441cb0ef41Sopenharmony_ci<h2 id="table-of-contents">Table of contents</h2>
1451cb0ef41Sopenharmony_ci<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>
1461cb0ef41Sopenharmony_ci</section>
1471cb0ef41Sopenharmony_ci
1481cb0ef41Sopenharmony_ci<div id="_content"><h3 id="synopsis">Synopsis</h3>
1491cb0ef41Sopenharmony_ci<pre><code class="language-bash">npm rebuild [&lt;package-spec&gt;] ...]
1501cb0ef41Sopenharmony_ci
1511cb0ef41Sopenharmony_cialias: rb
1521cb0ef41Sopenharmony_ci</code></pre>
1531cb0ef41Sopenharmony_ci<h3 id="description">Description</h3>
1541cb0ef41Sopenharmony_ci<p>This command does the following:</p>
1551cb0ef41Sopenharmony_ci<ol>
1561cb0ef41Sopenharmony_ci<li>Execute lifecycle scripts (<code>preinstall</code>, <code>install</code>, <code>postinstall</code>, <code>prepare</code>)</li>
1571cb0ef41Sopenharmony_ci<li>Links bins depending on whether bin links are enabled</li>
1581cb0ef41Sopenharmony_ci</ol>
1591cb0ef41Sopenharmony_ci<p>This command is particularly useful in scenarios including but not limited to:</p>
1601cb0ef41Sopenharmony_ci<ol>
1611cb0ef41Sopenharmony_ci<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>
1621cb0ef41Sopenharmony_ci<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>
1631cb0ef41Sopenharmony_ci</ol>
1641cb0ef41Sopenharmony_ci<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>
1651cb0ef41Sopenharmony_ci<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>
1661cb0ef41Sopenharmony_ci<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>
1671cb0ef41Sopenharmony_ci<pre><code>"scripts": {
1681cb0ef41Sopenharmony_ci    "install": "node-gyp rebuild"
1691cb0ef41Sopenharmony_ci}
1701cb0ef41Sopenharmony_ci</code></pre>
1711cb0ef41Sopenharmony_ci<p>This default behavior is suppressed if the <code>package.json</code> has its own <code>install</code> or <code>preinstall</code> scripts. It is also suppressed if the package specifies <code>"gypfile": false</code></p>
1721cb0ef41Sopenharmony_ci<h3 id="configuration">Configuration</h3>
1731cb0ef41Sopenharmony_ci<h4 id="global"><code>global</code></h4>
1741cb0ef41Sopenharmony_ci<ul>
1751cb0ef41Sopenharmony_ci<li>Default: false</li>
1761cb0ef41Sopenharmony_ci<li>Type: Boolean</li>
1771cb0ef41Sopenharmony_ci</ul>
1781cb0ef41Sopenharmony_ci<p>Operates in "global" mode, so that packages are installed into the <code>prefix</code>
1791cb0ef41Sopenharmony_cifolder instead of the current working directory. See
1801cb0ef41Sopenharmony_ci<a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p>
1811cb0ef41Sopenharmony_ci<ul>
1821cb0ef41Sopenharmony_ci<li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead
1831cb0ef41Sopenharmony_ciof the current working directory.</li>
1841cb0ef41Sopenharmony_ci<li>bin files are linked to <code>{prefix}/bin</code></li>
1851cb0ef41Sopenharmony_ci<li>man pages are linked to <code>{prefix}/share/man</code></li>
1861cb0ef41Sopenharmony_ci</ul>
1871cb0ef41Sopenharmony_ci<h4 id="bin-links"><code>bin-links</code></h4>
1881cb0ef41Sopenharmony_ci<ul>
1891cb0ef41Sopenharmony_ci<li>Default: true</li>
1901cb0ef41Sopenharmony_ci<li>Type: Boolean</li>
1911cb0ef41Sopenharmony_ci</ul>
1921cb0ef41Sopenharmony_ci<p>Tells npm to create symlinks (or <code>.cmd</code> shims on Windows) for package
1931cb0ef41Sopenharmony_ciexecutables.</p>
1941cb0ef41Sopenharmony_ci<p>Set to false to have it not do this. This can be used to work around the
1951cb0ef41Sopenharmony_cifact that some file systems don't support symlinks, even on ostensibly Unix
1961cb0ef41Sopenharmony_cisystems.</p>
1971cb0ef41Sopenharmony_ci<h4 id="foreground-scripts"><code>foreground-scripts</code></h4>
1981cb0ef41Sopenharmony_ci<ul>
1991cb0ef41Sopenharmony_ci<li>Default: <code>false</code> unless when using <code>npm pack</code> or <code>npm publish</code> where it
2001cb0ef41Sopenharmony_cidefaults to <code>true</code></li>
2011cb0ef41Sopenharmony_ci<li>Type: Boolean</li>
2021cb0ef41Sopenharmony_ci</ul>
2031cb0ef41Sopenharmony_ci<p>Run all build scripts (ie, <code>preinstall</code>, <code>install</code>, and <code>postinstall</code>)
2041cb0ef41Sopenharmony_ciscripts for installed packages in the foreground process, sharing standard
2051cb0ef41Sopenharmony_ciinput, output, and error with the main npm process.</p>
2061cb0ef41Sopenharmony_ci<p>Note that this will generally make installs run slower, and be much noisier,
2071cb0ef41Sopenharmony_cibut can be useful for debugging.</p>
2081cb0ef41Sopenharmony_ci<h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
2091cb0ef41Sopenharmony_ci<ul>
2101cb0ef41Sopenharmony_ci<li>Default: false</li>
2111cb0ef41Sopenharmony_ci<li>Type: Boolean</li>
2121cb0ef41Sopenharmony_ci</ul>
2131cb0ef41Sopenharmony_ci<p>If true, npm does not run scripts specified in package.json files.</p>
2141cb0ef41Sopenharmony_ci<p>Note that commands explicitly intended to run a particular script, such as
2151cb0ef41Sopenharmony_ci<code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code>
2161cb0ef41Sopenharmony_ciwill still run their intended script if <code>ignore-scripts</code> is set, but they
2171cb0ef41Sopenharmony_ciwill <em>not</em> run any pre- or post-scripts.</p>
2181cb0ef41Sopenharmony_ci<h4 id="workspace"><code>workspace</code></h4>
2191cb0ef41Sopenharmony_ci<ul>
2201cb0ef41Sopenharmony_ci<li>Default:</li>
2211cb0ef41Sopenharmony_ci<li>Type: String (can be set multiple times)</li>
2221cb0ef41Sopenharmony_ci</ul>
2231cb0ef41Sopenharmony_ci<p>Enable running a command in the context of the configured workspaces of the
2241cb0ef41Sopenharmony_cicurrent project while filtering by running only the workspaces defined by
2251cb0ef41Sopenharmony_cithis configuration option.</p>
2261cb0ef41Sopenharmony_ci<p>Valid values for the <code>workspace</code> config are either:</p>
2271cb0ef41Sopenharmony_ci<ul>
2281cb0ef41Sopenharmony_ci<li>Workspace names</li>
2291cb0ef41Sopenharmony_ci<li>Path to a workspace directory</li>
2301cb0ef41Sopenharmony_ci<li>Path to a parent workspace directory (will result in selecting all
2311cb0ef41Sopenharmony_ciworkspaces within that folder)</li>
2321cb0ef41Sopenharmony_ci</ul>
2331cb0ef41Sopenharmony_ci<p>When set for the <code>npm init</code> command, this may be set to the folder of a
2341cb0ef41Sopenharmony_ciworkspace which does not yet exist, to create the folder and set it up as a
2351cb0ef41Sopenharmony_cibrand new workspace within the project.</p>
2361cb0ef41Sopenharmony_ci<p>This value is not exported to the environment for child processes.</p>
2371cb0ef41Sopenharmony_ci<h4 id="workspaces"><code>workspaces</code></h4>
2381cb0ef41Sopenharmony_ci<ul>
2391cb0ef41Sopenharmony_ci<li>Default: null</li>
2401cb0ef41Sopenharmony_ci<li>Type: null or Boolean</li>
2411cb0ef41Sopenharmony_ci</ul>
2421cb0ef41Sopenharmony_ci<p>Set to true to run the command in the context of <strong>all</strong> configured
2431cb0ef41Sopenharmony_ciworkspaces.</p>
2441cb0ef41Sopenharmony_ci<p>Explicitly setting this to false will cause commands like <code>install</code> to
2451cb0ef41Sopenharmony_ciignore workspaces altogether. When not set explicitly:</p>
2461cb0ef41Sopenharmony_ci<ul>
2471cb0ef41Sopenharmony_ci<li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
2481cb0ef41Sopenharmony_ciwill link workspaces into the <code>node_modules</code> folder. - Commands that do
2491cb0ef41Sopenharmony_ciother things (test, exec, publish, etc.) will operate on the root project,
2501cb0ef41Sopenharmony_ci<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
2511cb0ef41Sopenharmony_ci</ul>
2521cb0ef41Sopenharmony_ci<p>This value is not exported to the environment for child processes.</p>
2531cb0ef41Sopenharmony_ci<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
2541cb0ef41Sopenharmony_ci<ul>
2551cb0ef41Sopenharmony_ci<li>Default: false</li>
2561cb0ef41Sopenharmony_ci<li>Type: Boolean</li>
2571cb0ef41Sopenharmony_ci</ul>
2581cb0ef41Sopenharmony_ci<p>Include the workspace root when workspaces are enabled for a command.</p>
2591cb0ef41Sopenharmony_ci<p>When false, specifying individual workspaces via the <code>workspace</code> config, or
2601cb0ef41Sopenharmony_ciall workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
2611cb0ef41Sopenharmony_cithe specified workspaces, and not on the root project.</p>
2621cb0ef41Sopenharmony_ci<p>This value is not exported to the environment for child processes.</p>
2631cb0ef41Sopenharmony_ci<h4 id="install-links"><code>install-links</code></h4>
2641cb0ef41Sopenharmony_ci<ul>
2651cb0ef41Sopenharmony_ci<li>Default: false</li>
2661cb0ef41Sopenharmony_ci<li>Type: Boolean</li>
2671cb0ef41Sopenharmony_ci</ul>
2681cb0ef41Sopenharmony_ci<p>When set file: protocol dependencies will be packed and installed as regular
2691cb0ef41Sopenharmony_cidependencies instead of creating a symlink. This option has no effect on
2701cb0ef41Sopenharmony_ciworkspaces.</p>
2711cb0ef41Sopenharmony_ci<h3 id="see-also">See Also</h3>
2721cb0ef41Sopenharmony_ci<ul>
2731cb0ef41Sopenharmony_ci<li><a href="../using-npm/package-spec.html">package spec</a></li>
2741cb0ef41Sopenharmony_ci<li><a href="../commands/npm-install.html">npm install</a></li>
2751cb0ef41Sopenharmony_ci</ul></div>
2761cb0ef41Sopenharmony_ci
2771cb0ef41Sopenharmony_ci<footer id="edit">
2781cb0ef41Sopenharmony_ci<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-rebuild.md">
2791cb0ef41Sopenharmony_ci<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
2801cb0ef41Sopenharmony_ci<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>
2811cb0ef41Sopenharmony_ci</svg>
2821cb0ef41Sopenharmony_ciEdit this page on GitHub
2831cb0ef41Sopenharmony_ci</a>
2841cb0ef41Sopenharmony_ci</footer>
2851cb0ef41Sopenharmony_ci</section>
2861cb0ef41Sopenharmony_ci
2871cb0ef41Sopenharmony_ci
2881cb0ef41Sopenharmony_ci
2891cb0ef41Sopenharmony_ci</body></html>