| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343 |
- <!DOCTYPE html><html><head>
- <meta charset="utf-8">
- <title>npm-rebuild</title>
- <style>
- body {
- background-color: #ffffff;
- color: #24292e;
- margin: 0;
- line-height: 1.5;
- font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
- }
- #rainbar {
- height: 10px;
- background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
- }
- a {
- text-decoration: none;
- color: #0366d6;
- }
- a:hover {
- text-decoration: underline;
- }
- pre {
- margin: 1em 0px;
- padding: 1em;
- border: solid 1px #e1e4e8;
- border-radius: 6px;
- display: block;
- overflow: auto;
- white-space: pre;
- background-color: #f6f8fa;
- color: #393a34;
- }
- code {
- font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
- font-size: 85%;
- padding: 0.2em 0.4em;
- background-color: #f6f8fa;
- color: #393a34;
- }
- pre > code {
- padding: 0;
- background-color: inherit;
- color: inherit;
- }
- h1, h2, h3 {
- font-weight: 600;
- }
- #logobar {
- background-color: #333333;
- margin: 0 auto;
- padding: 1em 4em;
- }
- #logobar .logo {
- float: left;
- }
- #logobar .title {
- font-weight: 600;
- color: #dddddd;
- float: left;
- margin: 5px 0 0 1em;
- }
- #logobar:after {
- content: "";
- display: block;
- clear: both;
- }
- #content {
- margin: 0 auto;
- padding: 0 4em;
- }
- #table_of_contents > h2 {
- font-size: 1.17em;
- }
- #table_of_contents ul:first-child {
- border: solid 1px #e1e4e8;
- border-radius: 6px;
- padding: 1em;
- background-color: #f6f8fa;
- color: #393a34;
- }
- #table_of_contents ul {
- list-style-type: none;
- padding-left: 1.5em;
- }
- #table_of_contents li {
- font-size: 0.9em;
- }
- #table_of_contents li a {
- color: #000000;
- }
- header.title {
- border-bottom: solid 1px #e1e4e8;
- }
- header.title > h1 {
- margin-bottom: 0.25em;
- }
- header.title > .description {
- display: block;
- margin-bottom: 0.5em;
- line-height: 1;
- }
- header.title .version {
- font-size: 0.8em;
- color: #666666;
- }
- footer#edit {
- border-top: solid 1px #e1e4e8;
- margin: 3em 0 4em 0;
- padding-top: 2em;
- }
- table {
- width: 100%;
- margin: 1em 0;
- border-radius: 6px;
- border: 1px solid #e1e4e8;
- overflow: hidden;
- border-collapse: separate;
- border-spacing: 0;
- }
- table thead {
- background-color: #f6f8fa;
- }
- table tbody {
- background-color: #ffffff;
- }
- table th,
- table td {
- padding: 0.75em;
- text-align: left;
- border-right: 1px solid #e1e4e8;
- border-bottom: 1px solid #e1e4e8;
- }
- table th:last-child,
- table td:last-child {
- border-right: none;
- }
- table tbody tr:last-child td {
- border-bottom: none;
- }
- table th {
- font-weight: 600;
- background-color: #f6f8fa;
- }
- table code {
- white-space: nowrap;
- }
- </style>
- </head>
- <body>
- <div id="banner">
- <div id="rainbar"></div>
- <div id="logobar">
- <svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
- <polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
- <polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
- </svg>
- <div class="title">
- npm command-line interface
- </div>
- </div>
- </div>
- <section id="content">
- <header class="title">
- <h1 id="----npm-rebuild----11120">
- <span>npm-rebuild</span>
- <span class="version">@11.12.0</span>
- </h1>
- <span class="description">Rebuild a package</span>
- </header>
- <section id="table_of_contents">
- <h2 id="table-of-contents">Table of contents</h2>
- <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>
- </section>
- <div id="_content"><h3 id="synopsis">Synopsis</h3>
- <pre><code class="language-bash">npm rebuild [<package-spec>] ...]
- alias: rb
- </code></pre>
- <h3 id="description">Description</h3>
- <p>This command does the following:</p>
- <ol>
- <li>Execute lifecycle scripts (<code>preinstall</code>, <code>install</code>, <code>postinstall</code>, <code>prepare</code>)</li>
- <li>Links bins depending on whether bin links are enabled</li>
- </ol>
- <p>This command is particularly useful in scenarios including but not limited to:</p>
- <ol>
- <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>
- <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>
- </ol>
- <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>
- <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>
- <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>
- <pre><code>"scripts": {
- "install": "node-gyp rebuild"
- }
- </code></pre>
- <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>
- <h3 id="configuration">Configuration</h3>
- <h4 id="global"><code>global</code></h4>
- <ul>
- <li>Default: false</li>
- <li>Type: Boolean</li>
- </ul>
- <p>Operates in "global" mode, so that packages are installed into the <code>prefix</code>
- folder instead of the current working directory. See
- <a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p>
- <ul>
- <li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead
- of the current working directory.</li>
- <li>bin files are linked to <code>{prefix}/bin</code></li>
- <li>man pages are linked to <code>{prefix}/share/man</code></li>
- </ul>
- <h4 id="bin-links"><code>bin-links</code></h4>
- <ul>
- <li>Default: true</li>
- <li>Type: Boolean</li>
- </ul>
- <p>Tells npm to create symlinks (or <code>.cmd</code> shims on Windows) for package
- executables.</p>
- <p>Set to false to have it not do this. This can be used to work around the
- fact that some file systems don't support symlinks, even on ostensibly Unix
- systems.</p>
- <h4 id="foreground-scripts"><code>foreground-scripts</code></h4>
- <ul>
- <li>Default: <code>false</code> unless when using <code>npm pack</code> or <code>npm publish</code> where it
- defaults to <code>true</code></li>
- <li>Type: Boolean</li>
- </ul>
- <p>Run all build scripts (ie, <code>preinstall</code>, <code>install</code>, and <code>postinstall</code>)
- scripts for installed packages in the foreground process, sharing standard
- input, output, and error with the main npm process.</p>
- <p>Note that this will generally make installs run slower, and be much noisier,
- but can be useful for debugging.</p>
- <h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
- <ul>
- <li>Default: false</li>
- <li>Type: Boolean</li>
- </ul>
- <p>If true, npm does not run scripts specified in package.json files.</p>
- <p>Note that commands explicitly intended to run a particular script, such as
- <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run</code> will still
- run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em>
- run any pre- or post-scripts.</p>
- <h4 id="workspace"><code>workspace</code></h4>
- <ul>
- <li>Default:</li>
- <li>Type: String (can be set multiple times)</li>
- </ul>
- <p>Enable running a command in the context of the configured workspaces of the
- current project while filtering by running only the workspaces defined by
- this configuration option.</p>
- <p>Valid values for the <code>workspace</code> config are either:</p>
- <ul>
- <li>Workspace names</li>
- <li>Path to a workspace directory</li>
- <li>Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)</li>
- </ul>
- <p>When set for the <code>npm init</code> command, this may be set to the folder of a
- workspace which does not yet exist, to create the folder and set it up as a
- brand new workspace within the project.</p>
- <p>This value is not exported to the environment for child processes.</p>
- <h4 id="workspaces"><code>workspaces</code></h4>
- <ul>
- <li>Default: null</li>
- <li>Type: null or Boolean</li>
- </ul>
- <p>Set to true to run the command in the context of <strong>all</strong> configured
- workspaces.</p>
- <p>Explicitly setting this to false will cause commands like <code>install</code> to
- ignore workspaces altogether. When not set explicitly:</p>
- <ul>
- <li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
- will link workspaces into the <code>node_modules</code> folder. - Commands that do
- other things (test, exec, publish, etc.) will operate on the root project,
- <em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
- </ul>
- <p>This value is not exported to the environment for child processes.</p>
- <h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
- <ul>
- <li>Default: false</li>
- <li>Type: Boolean</li>
- </ul>
- <p>Include the workspace root when workspaces are enabled for a command.</p>
- <p>When false, specifying individual workspaces via the <code>workspace</code> config, or
- all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
- the specified workspaces, and not on the root project.</p>
- <p>This value is not exported to the environment for child processes.</p>
- <h4 id="install-links"><code>install-links</code></h4>
- <ul>
- <li>Default: false</li>
- <li>Type: Boolean</li>
- </ul>
- <p>When set file: protocol dependencies will be packed and installed as regular
- dependencies instead of creating a symlink. This option has no effect on
- workspaces.</p>
- <h3 id="see-also">See Also</h3>
- <ul>
- <li><a href="../using-npm/package-spec.html">package spec</a></li>
- <li><a href="../commands/npm-install.html">npm install</a></li>
- </ul></div>
- <footer id="edit">
- <a href="https://github.com/npm/cli/edit/latest/docs/lib/content/commands/npm-rebuild.md">
- <svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
- <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>
- </svg>
- Edit this page on GitHub
- </a>
- </footer>
- </section>
- </body></html>
|