codekingpro/portable-devtools
114k
1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>npm-cache</title>
4<style>
5body {
6 background-color: #ffffff;
7 color: #24292e;
8
9 margin: 0;
10
11 line-height: 1.5;
12
13 font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
14}
15#rainbar {
16 height: 10px;
17 background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
18}
19
20a {
21 text-decoration: none;
22 color: #0366d6;
23}
24a:hover {
25 text-decoration: underline;
26}
27
28pre {
29 margin: 1em 0px;
30 padding: 1em;
31 border: solid 1px #e1e4e8;
32 border-radius: 6px;
33
34 display: block;
35 overflow: auto;
36
37 white-space: pre;
38
39 background-color: #f6f8fa;
40 color: #393a34;
41}
42code {
43 font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
44 font-size: 85%;
45 padding: 0.2em 0.4em;
46 background-color: #f6f8fa;
47 color: #393a34;
48}
49pre > code {
50 padding: 0;
51 background-color: inherit;
52 color: inherit;
53}
54h1, h2, h3 {
55 font-weight: 600;
56}
57
58#logobar {
59 background-color: #333333;
60 margin: 0 auto;
61 padding: 1em 4em;
62}
63#logobar .logo {
64 float: left;
65}
66#logobar .title {
67 font-weight: 600;
68 color: #dddddd;
69 float: left;
70 margin: 5px 0 0 1em;
71}
72#logobar:after {
73 content: "";
74 display: block;
75 clear: both;
76}
77
78#content {
79 margin: 0 auto;
80 padding: 0 4em;
81}
82
83#table_of_contents > h2 {
84 font-size: 1.17em;
85}
86#table_of_contents ul:first-child {
87 border: solid 1px #e1e4e8;
88 border-radius: 6px;
89 padding: 1em;
90 background-color: #f6f8fa;
91 color: #393a34;
92}
93#table_of_contents ul {
94 list-style-type: none;
95 padding-left: 1.5em;
96}
97#table_of_contents li {
98 font-size: 0.9em;
99}
100#table_of_contents li a {
101 color: #000000;
102}
103
104header.title {
105 border-bottom: solid 1px #e1e4e8;
106}
107header.title > h1 {
108 margin-bottom: 0.25em;
109}
110header.title > .description {
111 display: block;
112 margin-bottom: 0.5em;
113 line-height: 1;
114}
115
116header.title .version {
117 font-size: 0.8em;
118 color: #666666;
119}
120
121footer#edit {
122 border-top: solid 1px #e1e4e8;
123 margin: 3em 0 4em 0;
124 padding-top: 2em;
125}
126
127table {
128 width: 100%;
129 margin: 1em 0;
130 border-radius: 6px;
131 border: 1px solid #e1e4e8;
132 overflow: hidden;
133 border-collapse: separate;
134 border-spacing: 0;
135}
136
137table thead {
138 background-color: #f6f8fa;
139}
140
141table tbody {
142 background-color: #ffffff;
143}
144
145table th,
146table td {
147 padding: 0.75em;
148 text-align: left;
149 border-right: 1px solid #e1e4e8;
150 border-bottom: 1px solid #e1e4e8;
151}
152
153table th:last-child,
154table td:last-child {
155 border-right: none;
156}
157
158table tbody tr:last-child td {
159 border-bottom: none;
160}
161
162table th {
163 font-weight: 600;
164 background-color: #f6f8fa;
165}
166
167table code {
168 white-space: nowrap;
169}
170
171</style>
172</head>
173<body>
174<div id="banner">
175<div id="rainbar"></div>
176<div id="logobar">
177<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
178<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
179<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
180</svg>
181<div class="title">
182npm command-line interface
183</div>
184</div>
185</div>
186
187<section id="content">
188<header class="title">
189<h1 id="----npm-cache----11130">
190 <span>npm-cache</span>
191 <span class="version">@11.13.0</span>
192</h1>
193<span class="description">Manipulates packages cache</span>
194</header>
195
196<section id="table_of_contents">
197<h2 id="table-of-contents">Table of contents</h2>
198<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><ul><li><a href="#npm-cache"><code>npm cache</code></a></li><li><a href="#npm-cache-npx"><code>npm cache npx</code></a></li></ul><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>
199</section>
200
201<div id="_content"><h3 id="synopsis">Synopsis</h3>
202<pre><code class="language-bash">npm cache add <package-spec>
203npm cache clean [<key>]
204npm cache ls [<name>@<version>]
205npm cache verify
206npm cache npx ls
207npm cache npx rm [<key>...]
208npm cache npx info <key>...
209</code></pre>
210<p>Note: This command is unaware of workspaces.</p>
211<h3 id="description">Description</h3>
212<p>Used to add, list, or clean the <code>npm cache</code> folder.
213Also used to view info about entries in the <code>npm exec</code> (aka <code>npx</code>) cache folder.</p>
214<h4 id="npm-cache"><code>npm cache</code></h4>
215<ul>
216<li>
217<p>add:
218Add the specified packages to the local cache.
219This command is primarily intended to be used internally by npm, but it can provide a way to add data to the local installation cache explicitly.</p>
220</li>
221<li>
222<p>clean:
223Delete a single entry or all entries out of the cache folder.
224Note that this is typically unnecessary, as npm's cache is self-healing and resistant to data corruption issues.</p>
225</li>
226<li>
227<p>ls:
228List given entries or all entries in the local cache.</p>
229</li>
230<li>
231<p>verify:
232Verify the contents of the cache folder, garbage collecting any unneeded data, and verifying the integrity of the cache index and all cached data.</p>
233</li>
234</ul>
235<h4 id="npm-cache-npx"><code>npm cache npx</code></h4>
236<ul>
237<li>
238<p>ls:
239List all entries in the npx cache.</p>
240</li>
241<li>
242<p>rm:
243Remove given entries or all entries from the npx cache.</p>
244</li>
245<li>
246<p>info:
247Get detailed information about given entries in the npx cache.</p>
248</li>
249</ul>
250<h3 id="details">Details</h3>
251<p>npm stores cache data in an opaque directory within the configured <code>cache</code>, named <code>_cacache</code>.
252This directory is a <a href="http://npm.im/cacache"><code>cacache</code></a>-based content-addressable cache that stores all http request data as well as other package-related data.
253This directory is primarily accessed through <code>pacote</code>, the library responsible for all package fetching as of npm@5.</p>
254<p>All data that passes through the cache is fully verified for integrity on both insertion and extraction.
255Cache corruption will either trigger an error, or signal to <code>pacote</code> that the data must be refetched, which it will do automatically.
256For this reason, it should never be necessary to clear the cache for any reason other than reclaiming disk space, thus why <code>clean</code> now requires <code>--force</code> to run.</p>
257<p>There is currently no method exposed through npm to inspect or directly manage the contents of this cache.
258In order to access it, <code>cacache</code> must be used directly.</p>
259<p>npm will not remove data by itself: the cache will grow as new packages are installed.</p>
260<h3 id="a-note-about-the-caches-design">A note about the cache's design</h3>
261<p>The npm cache is strictly a cache: it should not be relied upon as a persistent and reliable data store for package data.
262npm makes no guarantee that a previously-cached piece of data will be available later, and will automatically delete corrupted contents.
263The primary guarantee that the cache makes is that, if it does return data, that data will be exactly the data that was inserted.</p>
264<p>To run an offline verification of existing cache contents, use <code>npm cache verify</code>.</p>
265<h3 id="configuration">Configuration</h3>
266<h4 id="cache"><code>cache</code></h4>
267<ul>
268<li>Default: Windows: <code>%LocalAppData%\npm-cache</code>, Posix: <code>~/.npm</code></li>
269<li>Type: Path</li>
270</ul>
271<p>The location of npm's cache directory.</p>
272<h3 id="see-also">See Also</h3>
273<ul>
274<li><a href="../using-npm/package-spec.html">package spec</a></li>
275<li><a href="../configuring-npm/folders.html">npm folders</a></li>
276<li><a href="../commands/npm-config.html">npm config</a></li>
277<li><a href="../configuring-npm/npmrc.html">npmrc</a></li>
278<li><a href="../commands/npm-install.html">npm install</a></li>
279<li><a href="../commands/npm-publish.html">npm publish</a></li>
280<li><a href="../commands/npm-pack.html">npm pack</a></li>
281<li><a href="../commands/npm-exec.html">npm exec</a></li>
282<li><a href="https://npm.im/cacache">https://npm.im/cacache</a></li>
283<li><a href="https://npm.im/pacote">https://npm.im/pacote</a></li>
284<li><a href="https://npm.im/@npmcli/arborist">https://npm.im/@npmcli/arborist</a></li>
285<li><a href="https://npm.im/make-fetch-happen">https://npm.im/make-fetch-happen</a></li>
286</ul></div>
287
288<footer id="edit">
289<a href="https://github.com/npm/cli/edit/latest/docs/lib/content/commands/npm-cache.md">
290<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
291<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>
292</svg>
293Edit this page on GitHub
294</a>
295</footer>
296</section>
297
298
299
300</body></html>