npm-rebuild.html 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274
  1. <html><head>
  2. <title>npm-rebuild</title>
  3. <style>
  4. body {
  5. background-color: #ffffff;
  6. color: #24292e;
  7. margin: 0;
  8. line-height: 1.5;
  9. font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
  10. }
  11. #rainbar {
  12. height: 10px;
  13. background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
  14. }
  15. a {
  16. text-decoration: none;
  17. color: #0366d6;
  18. }
  19. a:hover {
  20. text-decoration: underline;
  21. }
  22. pre {
  23. margin: 1em 0px;
  24. padding: 1em;
  25. border: solid 1px #e1e4e8;
  26. border-radius: 6px;
  27. display: block;
  28. overflow: auto;
  29. white-space: pre;
  30. background-color: #f6f8fa;
  31. color: #393a34;
  32. }
  33. code {
  34. font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
  35. font-size: 85%;
  36. padding: 0.2em 0.4em;
  37. background-color: #f6f8fa;
  38. color: #393a34;
  39. }
  40. pre > code {
  41. padding: 0;
  42. background-color: inherit;
  43. color: inherit;
  44. }
  45. h1, h2, h3 {
  46. font-weight: 600;
  47. }
  48. #logobar {
  49. background-color: #333333;
  50. margin: 0 auto;
  51. padding: 1em 4em;
  52. }
  53. #logobar .logo {
  54. float: left;
  55. }
  56. #logobar .title {
  57. font-weight: 600;
  58. color: #dddddd;
  59. float: left;
  60. margin: 5px 0 0 1em;
  61. }
  62. #logobar:after {
  63. content: "";
  64. display: block;
  65. clear: both;
  66. }
  67. #content {
  68. margin: 0 auto;
  69. padding: 0 4em;
  70. }
  71. #table_of_contents > h2 {
  72. font-size: 1.17em;
  73. }
  74. #table_of_contents ul:first-child {
  75. border: solid 1px #e1e4e8;
  76. border-radius: 6px;
  77. padding: 1em;
  78. background-color: #f6f8fa;
  79. color: #393a34;
  80. }
  81. #table_of_contents ul {
  82. list-style-type: none;
  83. padding-left: 1.5em;
  84. }
  85. #table_of_contents li {
  86. font-size: 0.9em;
  87. }
  88. #table_of_contents li a {
  89. color: #000000;
  90. }
  91. header.title {
  92. border-bottom: solid 1px #e1e4e8;
  93. }
  94. header.title > h1 {
  95. margin-bottom: 0.25em;
  96. }
  97. header.title > .description {
  98. display: block;
  99. margin-bottom: 0.5em;
  100. line-height: 1;
  101. }
  102. footer#edit {
  103. border-top: solid 1px #e1e4e8;
  104. margin: 3em 0 4em 0;
  105. padding-top: 2em;
  106. }
  107. </style>
  108. </head>
  109. <body>
  110. <div id="banner">
  111. <div id="rainbar"></div>
  112. <div id="logobar">
  113. <svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
  114. <polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
  115. <polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
  116. </svg>
  117. <div class="title">
  118. npm command-line interface
  119. </div>
  120. </div>
  121. </div>
  122. <section id="content">
  123. <header class="title">
  124. <h1 id="npm-rebuild">npm-rebuild</h1>
  125. <span class="description">Rebuild a package</span>
  126. </header>
  127. <section id="table_of_contents">
  128. <h2 id="table-of-contents">Table of contents</h2>
  129. <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="#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></ul><li><a href="#see-also">See Also</a></li></ul></div>
  130. </section>
  131. <div id="_content"><h3 id="synopsis">Synopsis</h3>
  132. <pre lang="bash"><code>npm rebuild [[&lt;@scope&gt;/]&lt;name&gt;[@&lt;version&gt;] ...]
  133. alias: rb
  134. </code></pre>
  135. <h3 id="description">Description</h3>
  136. <p>This command runs the <code>npm build</code> command on the matched folders. This is
  137. useful when you install a new version of node, and must recompile all your
  138. C++ addons with the new binary. It is also useful when installing with
  139. <code>--ignore-scripts</code> and <code>--no-bin-links</code>, to explicitly choose which
  140. packages to build and/or link bins.</p>
  141. <p>If one or more package names (and optionally version ranges) are provided,
  142. then only packages with a name and version matching one of the specifiers
  143. will be rebuilt.</p>
  144. <h3 id="configuration">Configuration</h3>
  145. <!-- raw HTML omitted -->
  146. <!-- raw HTML omitted -->
  147. <!-- raw HTML omitted -->
  148. <h4 id="global"><code>global</code></h4>
  149. <ul>
  150. <li>Default: false</li>
  151. <li>Type: Boolean</li>
  152. </ul>
  153. <p>Operates in “global” mode, so that packages are installed into the <code>prefix</code>
  154. folder instead of the current working directory. See
  155. <a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p>
  156. <ul>
  157. <li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead
  158. of the current working directory.</li>
  159. <li>bin files are linked to <code>{prefix}/bin</code></li>
  160. <li>man pages are linked to <code>{prefix}/share/man</code></li>
  161. </ul>
  162. <!-- raw HTML omitted -->
  163. <!-- raw HTML omitted -->
  164. <h4 id="bin-links"><code>bin-links</code></h4>
  165. <ul>
  166. <li>Default: true</li>
  167. <li>Type: Boolean</li>
  168. </ul>
  169. <p>Tells npm to create symlinks (or <code>.cmd</code> shims on Windows) for package
  170. executables.</p>
  171. <p>Set to false to have it not do this. This can be used to work around the
  172. fact that some file systems don’t support symlinks, even on ostensibly Unix
  173. systems.</p>
  174. <!-- raw HTML omitted -->
  175. <!-- raw HTML omitted -->
  176. <h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
  177. <ul>
  178. <li>Default: false</li>
  179. <li>Type: Boolean</li>
  180. </ul>
  181. <p>If true, npm does not run scripts specified in package.json files.</p>
  182. <p>Note that commands explicitly intended to run a particular script, such as
  183. <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code>
  184. will still run their intended script if <code>ignore-scripts</code> is set, but they
  185. will <em>not</em> run any pre- or post-scripts.</p>
  186. <!-- raw HTML omitted -->
  187. <!-- raw HTML omitted -->
  188. <h4 id="workspace"><code>workspace</code></h4>
  189. <ul>
  190. <li>Default:</li>
  191. <li>Type: String (can be set multiple times)</li>
  192. </ul>
  193. <p>Enable running a command in the context of the configured workspaces of the
  194. current project while filtering by running only the workspaces defined by
  195. this configuration option.</p>
  196. <p>Valid values for the <code>workspace</code> config are either:</p>
  197. <ul>
  198. <li>Workspace names</li>
  199. <li>Path to a workspace directory</li>
  200. <li>Path to a parent workspace directory (will result in selecting all
  201. workspaces within that folder)</li>
  202. </ul>
  203. <p>When set for the <code>npm init</code> command, this may be set to the folder of a
  204. workspace which does not yet exist, to create the folder and set it up as a
  205. brand new workspace within the project.</p>
  206. <p>This value is not exported to the environment for child processes.</p>
  207. <!-- raw HTML omitted -->
  208. <!-- raw HTML omitted -->
  209. <h4 id="workspaces"><code>workspaces</code></h4>
  210. <ul>
  211. <li>Default: null</li>
  212. <li>Type: null or Boolean</li>
  213. </ul>
  214. <p>Set to true to run the command in the context of <strong>all</strong> configured
  215. workspaces.</p>
  216. <p>Explicitly setting this to false will cause commands like <code>install</code> to
  217. ignore workspaces altogether. When not set explicitly:</p>
  218. <ul>
  219. <li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
  220. will link workspaces into the <code>node_modules</code> folder. - Commands that do
  221. other things (test, exec, publish, etc.) will operate on the root project,
  222. <em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
  223. </ul>
  224. <p>This value is not exported to the environment for child processes.</p>
  225. <!-- raw HTML omitted -->
  226. <!-- raw HTML omitted -->
  227. <h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
  228. <ul>
  229. <li>Default: false</li>
  230. <li>Type: Boolean</li>
  231. </ul>
  232. <p>Include the workspace root when workspaces are enabled for a command.</p>
  233. <p>When false, specifying individual workspaces via the <code>workspace</code> config, or
  234. all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
  235. the specified workspaces, and not on the root project.</p>
  236. <!-- raw HTML omitted -->
  237. <!-- raw HTML omitted -->
  238. <!-- raw HTML omitted -->
  239. <h3 id="see-also">See Also</h3>
  240. <ul>
  241. <li><a href="../commands/npm-install.html">npm install</a></li>
  242. </ul>
  243. </div>
  244. <footer id="edit">
  245. <a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-rebuild.md">
  246. <svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
  247. <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>
  248. </svg>
  249. Edit this page on GitHub
  250. </a>
  251. </footer>
  252. </section>
  253. </body></html>