npm-rebuild.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343
  1. <!DOCTYPE html><html><head>
  2. <meta charset="utf-8">
  3. <title>npm-rebuild</title>
  4. <style>
  5. body {
  6. background-color: #ffffff;
  7. color: #24292e;
  8. margin: 0;
  9. line-height: 1.5;
  10. font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
  11. }
  12. #rainbar {
  13. height: 10px;
  14. background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
  15. }
  16. a {
  17. text-decoration: none;
  18. color: #0366d6;
  19. }
  20. a:hover {
  21. text-decoration: underline;
  22. }
  23. pre {
  24. margin: 1em 0px;
  25. padding: 1em;
  26. border: solid 1px #e1e4e8;
  27. border-radius: 6px;
  28. display: block;
  29. overflow: auto;
  30. white-space: pre;
  31. background-color: #f6f8fa;
  32. color: #393a34;
  33. }
  34. code {
  35. font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
  36. font-size: 85%;
  37. padding: 0.2em 0.4em;
  38. background-color: #f6f8fa;
  39. color: #393a34;
  40. }
  41. pre > code {
  42. padding: 0;
  43. background-color: inherit;
  44. color: inherit;
  45. }
  46. h1, h2, h3 {
  47. font-weight: 600;
  48. }
  49. #logobar {
  50. background-color: #333333;
  51. margin: 0 auto;
  52. padding: 1em 4em;
  53. }
  54. #logobar .logo {
  55. float: left;
  56. }
  57. #logobar .title {
  58. font-weight: 600;
  59. color: #dddddd;
  60. float: left;
  61. margin: 5px 0 0 1em;
  62. }
  63. #logobar:after {
  64. content: "";
  65. display: block;
  66. clear: both;
  67. }
  68. #content {
  69. margin: 0 auto;
  70. padding: 0 4em;
  71. }
  72. #table_of_contents > h2 {
  73. font-size: 1.17em;
  74. }
  75. #table_of_contents ul:first-child {
  76. border: solid 1px #e1e4e8;
  77. border-radius: 6px;
  78. padding: 1em;
  79. background-color: #f6f8fa;
  80. color: #393a34;
  81. }
  82. #table_of_contents ul {
  83. list-style-type: none;
  84. padding-left: 1.5em;
  85. }
  86. #table_of_contents li {
  87. font-size: 0.9em;
  88. }
  89. #table_of_contents li a {
  90. color: #000000;
  91. }
  92. header.title {
  93. border-bottom: solid 1px #e1e4e8;
  94. }
  95. header.title > h1 {
  96. margin-bottom: 0.25em;
  97. }
  98. header.title > .description {
  99. display: block;
  100. margin-bottom: 0.5em;
  101. line-height: 1;
  102. }
  103. header.title .version {
  104. font-size: 0.8em;
  105. color: #666666;
  106. }
  107. footer#edit {
  108. border-top: solid 1px #e1e4e8;
  109. margin: 3em 0 4em 0;
  110. padding-top: 2em;
  111. }
  112. table {
  113. width: 100%;
  114. margin: 1em 0;
  115. border-radius: 6px;
  116. border: 1px solid #e1e4e8;
  117. overflow: hidden;
  118. border-collapse: separate;
  119. border-spacing: 0;
  120. }
  121. table thead {
  122. background-color: #f6f8fa;
  123. }
  124. table tbody {
  125. background-color: #ffffff;
  126. }
  127. table th,
  128. table td {
  129. padding: 0.75em;
  130. text-align: left;
  131. border-right: 1px solid #e1e4e8;
  132. border-bottom: 1px solid #e1e4e8;
  133. }
  134. table th:last-child,
  135. table td:last-child {
  136. border-right: none;
  137. }
  138. table tbody tr:last-child td {
  139. border-bottom: none;
  140. }
  141. table th {
  142. font-weight: 600;
  143. background-color: #f6f8fa;
  144. }
  145. table code {
  146. white-space: nowrap;
  147. }
  148. </style>
  149. </head>
  150. <body>
  151. <div id="banner">
  152. <div id="rainbar"></div>
  153. <div id="logobar">
  154. <svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
  155. <polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
  156. <polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
  157. </svg>
  158. <div class="title">
  159. npm command-line interface
  160. </div>
  161. </div>
  162. </div>
  163. <section id="content">
  164. <header class="title">
  165. <h1 id="----npm-rebuild----11120">
  166. <span>npm-rebuild</span>
  167. <span class="version">@11.12.0</span>
  168. </h1>
  169. <span class="description">Rebuild a package</span>
  170. </header>
  171. <section id="table_of_contents">
  172. <h2 id="table-of-contents">Table of contents</h2>
  173. <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>
  174. </section>
  175. <div id="_content"><h3 id="synopsis">Synopsis</h3>
  176. <pre><code class="language-bash">npm rebuild [&lt;package-spec&gt;] ...]
  177. alias: rb
  178. </code></pre>
  179. <h3 id="description">Description</h3>
  180. <p>This command does the following:</p>
  181. <ol>
  182. <li>Execute lifecycle scripts (<code>preinstall</code>, <code>install</code>, <code>postinstall</code>, <code>prepare</code>)</li>
  183. <li>Links bins depending on whether bin links are enabled</li>
  184. </ol>
  185. <p>This command is particularly useful in scenarios including but not limited to:</p>
  186. <ol>
  187. <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>
  188. <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>
  189. </ol>
  190. <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>
  191. <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>
  192. <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>
  193. <pre><code>"scripts": {
  194. "install": "node-gyp rebuild"
  195. }
  196. </code></pre>
  197. <p>This default behavior is suppressed if the <code>package.json</code> has its own <code>install</code> or <code>preinstall</code> scripts.
  198. It is also suppressed if the package specifies <code>"gypfile": false</code></p>
  199. <h3 id="configuration">Configuration</h3>
  200. <h4 id="global"><code>global</code></h4>
  201. <ul>
  202. <li>Default: false</li>
  203. <li>Type: Boolean</li>
  204. </ul>
  205. <p>Operates in "global" mode, so that packages are installed into the <code>prefix</code>
  206. folder instead of the current working directory. See
  207. <a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p>
  208. <ul>
  209. <li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead
  210. of the current working directory.</li>
  211. <li>bin files are linked to <code>{prefix}/bin</code></li>
  212. <li>man pages are linked to <code>{prefix}/share/man</code></li>
  213. </ul>
  214. <h4 id="bin-links"><code>bin-links</code></h4>
  215. <ul>
  216. <li>Default: true</li>
  217. <li>Type: Boolean</li>
  218. </ul>
  219. <p>Tells npm to create symlinks (or <code>.cmd</code> shims on Windows) for package
  220. executables.</p>
  221. <p>Set to false to have it not do this. This can be used to work around the
  222. fact that some file systems don't support symlinks, even on ostensibly Unix
  223. systems.</p>
  224. <h4 id="foreground-scripts"><code>foreground-scripts</code></h4>
  225. <ul>
  226. <li>Default: <code>false</code> unless when using <code>npm pack</code> or <code>npm publish</code> where it
  227. defaults to <code>true</code></li>
  228. <li>Type: Boolean</li>
  229. </ul>
  230. <p>Run all build scripts (ie, <code>preinstall</code>, <code>install</code>, and <code>postinstall</code>)
  231. scripts for installed packages in the foreground process, sharing standard
  232. input, output, and error with the main npm process.</p>
  233. <p>Note that this will generally make installs run slower, and be much noisier,
  234. but can be useful for debugging.</p>
  235. <h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
  236. <ul>
  237. <li>Default: false</li>
  238. <li>Type: Boolean</li>
  239. </ul>
  240. <p>If true, npm does not run scripts specified in package.json files.</p>
  241. <p>Note that commands explicitly intended to run a particular script, such as
  242. <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run</code> will still
  243. run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em>
  244. run any pre- or post-scripts.</p>
  245. <h4 id="workspace"><code>workspace</code></h4>
  246. <ul>
  247. <li>Default:</li>
  248. <li>Type: String (can be set multiple times)</li>
  249. </ul>
  250. <p>Enable running a command in the context of the configured workspaces of the
  251. current project while filtering by running only the workspaces defined by
  252. this configuration option.</p>
  253. <p>Valid values for the <code>workspace</code> config are either:</p>
  254. <ul>
  255. <li>Workspace names</li>
  256. <li>Path to a workspace directory</li>
  257. <li>Path to a parent workspace directory (will result in selecting all
  258. workspaces within that folder)</li>
  259. </ul>
  260. <p>When set for the <code>npm init</code> command, this may be set to the folder of a
  261. workspace which does not yet exist, to create the folder and set it up as a
  262. brand new workspace within the project.</p>
  263. <p>This value is not exported to the environment for child processes.</p>
  264. <h4 id="workspaces"><code>workspaces</code></h4>
  265. <ul>
  266. <li>Default: null</li>
  267. <li>Type: null or Boolean</li>
  268. </ul>
  269. <p>Set to true to run the command in the context of <strong>all</strong> configured
  270. workspaces.</p>
  271. <p>Explicitly setting this to false will cause commands like <code>install</code> to
  272. ignore workspaces altogether. When not set explicitly:</p>
  273. <ul>
  274. <li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
  275. will link workspaces into the <code>node_modules</code> folder. - Commands that do
  276. other things (test, exec, publish, etc.) will operate on the root project,
  277. <em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
  278. </ul>
  279. <p>This value is not exported to the environment for child processes.</p>
  280. <h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
  281. <ul>
  282. <li>Default: false</li>
  283. <li>Type: Boolean</li>
  284. </ul>
  285. <p>Include the workspace root when workspaces are enabled for a command.</p>
  286. <p>When false, specifying individual workspaces via the <code>workspace</code> config, or
  287. all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
  288. the specified workspaces, and not on the root project.</p>
  289. <p>This value is not exported to the environment for child processes.</p>
  290. <h4 id="install-links"><code>install-links</code></h4>
  291. <ul>
  292. <li>Default: false</li>
  293. <li>Type: Boolean</li>
  294. </ul>
  295. <p>When set file: protocol dependencies will be packed and installed as regular
  296. dependencies instead of creating a symlink. This option has no effect on
  297. workspaces.</p>
  298. <h3 id="see-also">See Also</h3>
  299. <ul>
  300. <li><a href="../using-npm/package-spec.html">package spec</a></li>
  301. <li><a href="../commands/npm-install.html">npm install</a></li>
  302. </ul></div>
  303. <footer id="edit">
  304. <a href="https://github.com/npm/cli/edit/latest/docs/lib/content/commands/npm-rebuild.md">
  305. <svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
  306. <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>
  307. </svg>
  308. Edit this page on GitHub
  309. </a>
  310. </footer>
  311. </section>
  312. </body></html>