npm-cache.html 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246
  1. <html><head>
  2. <title>npm-cache</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-cache">npm-cache</h1>
  125. <span class="description">Manipulates packages cache</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="#details">Details</a></li><li><a href="#a-note-about-the-caches-design">A note about the cache’s design</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#cache"><code>cache</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 cache add &lt;tarball file&gt;...
  133. npm cache add &lt;folder&gt;...
  134. npm cache add &lt;tarball url&gt;...
  135. npm cache add &lt;name&gt;@&lt;version&gt;...
  136. npm cache clean
  137. aliases: npm cache clear, npm cache rm
  138. npm cache verify
  139. </code></pre>
  140. <p>Note: This command is unaware of workspaces.</p>
  141. <h3 id="description">Description</h3>
  142. <p>Used to add, list, or clean the npm cache folder.</p>
  143. <ul>
  144. <li>
  145. <p>add:
  146. Add the specified packages to the local cache. This command is primarily
  147. intended to be used internally by npm, but it can provide a way to
  148. add data to the local installation cache explicitly.</p>
  149. </li>
  150. <li>
  151. <p>clean:
  152. Delete all data out of the cache folder. Note that this is typically
  153. unnecessary, as npm’s cache is self-healing and resistant to data
  154. corruption issues.</p>
  155. </li>
  156. <li>
  157. <p>verify:
  158. Verify the contents of the cache folder, garbage collecting any unneeded
  159. data, and verifying the integrity of the cache index and all cached data.</p>
  160. </li>
  161. </ul>
  162. <h3 id="details">Details</h3>
  163. <p>npm stores cache data in an opaque directory within the configured <code>cache</code>,
  164. named <code>_cacache</code>. This directory is a
  165. <a href="http://npm.im/cacache"><code>cacache</code></a>-based content-addressable cache that
  166. stores all http request data as well as other package-related data. This
  167. directory is primarily accessed through <code>pacote</code>, the library responsible
  168. for all package fetching as of npm@5.</p>
  169. <p>All data that passes through the cache is fully verified for integrity on
  170. both insertion and extraction. Cache corruption will either trigger an
  171. error, or signal to <code>pacote</code> that the data must be refetched, which it will
  172. do automatically. For this reason, it should never be necessary to clear
  173. the cache for any reason other than reclaiming disk space, thus why <code>clean</code>
  174. now requires <code>--force</code> to run.</p>
  175. <p>There is currently no method exposed through npm to inspect or directly
  176. manage the contents of this cache. In order to access it, <code>cacache</code> must be
  177. used directly.</p>
  178. <p>npm will not remove data by itself: the cache will grow as new packages are
  179. installed.</p>
  180. <h3 id="a-note-about-the-caches-design">A note about the cache’s design</h3>
  181. <p>The npm cache is strictly a cache: it should not be relied upon as a
  182. persistent and reliable data store for package data. npm makes no guarantee
  183. that a previously-cached piece of data will be available later, and will
  184. automatically delete corrupted contents. The primary guarantee that the
  185. cache makes is that, if it does return data, that data will be exactly the
  186. data that was inserted.</p>
  187. <p>To run an offline verification of existing cache contents, use <code>npm cache verify</code>.</p>
  188. <h3 id="configuration">Configuration</h3>
  189. <!-- raw HTML omitted -->
  190. <!-- raw HTML omitted -->
  191. <!-- raw HTML omitted -->
  192. <h4 id="cache"><code>cache</code></h4>
  193. <ul>
  194. <li>Default: Windows: <code>%LocalAppData%\npm-cache</code>, Posix: <code>~/.npm</code></li>
  195. <li>Type: Path</li>
  196. </ul>
  197. <p>The location of npm’s cache directory. See <a href="../commands/npm-cache.html"><code>npm cache</code></a></p>
  198. <!-- raw HTML omitted -->
  199. <!-- raw HTML omitted -->
  200. <!-- raw HTML omitted -->
  201. <h3 id="see-also">See Also</h3>
  202. <ul>
  203. <li><a href="../configuring-npm/folders.html">npm folders</a></li>
  204. <li><a href="../commands/npm-config.html">npm config</a></li>
  205. <li><a href="../configuring-npm/npmrc.html">npmrc</a></li>
  206. <li><a href="../commands/npm-install.html">npm install</a></li>
  207. <li><a href="../commands/npm-publish.html">npm publish</a></li>
  208. <li><a href="../commands/npm-pack.html">npm pack</a></li>
  209. <li><a href="https://npm.im/cacache">https://npm.im/cacache</a></li>
  210. <li><a href="https://npm.im/pacote">https://npm.im/pacote</a></li>
  211. <li><a href="https://npm.im/@npmcli/arborist">https://npm.im/@npmcli/arborist</a></li>
  212. <li><a href="https://npm.im/make-fetch-happen">https://npm.im/make-fetch-happen</a></li>
  213. </ul>
  214. </div>
  215. <footer id="edit">
  216. <a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-cache.md">
  217. <svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
  218. <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>
  219. </svg>
  220. Edit this page on GitHub
  221. </a>
  222. </footer>
  223. </section>
  224. </body></html>