11cb0ef41Sopenharmony_ci<!DOCTYPE html><html><head>
21cb0ef41Sopenharmony_ci<meta charset="utf-8">
31cb0ef41Sopenharmony_ci<title>npm-cache</title>
41cb0ef41Sopenharmony_ci<style>
51cb0ef41Sopenharmony_cibody {
61cb0ef41Sopenharmony_ci    background-color: #ffffff;
71cb0ef41Sopenharmony_ci    color: #24292e;
81cb0ef41Sopenharmony_ci
91cb0ef41Sopenharmony_ci    margin: 0;
101cb0ef41Sopenharmony_ci
111cb0ef41Sopenharmony_ci    line-height: 1.5;
121cb0ef41Sopenharmony_ci
131cb0ef41Sopenharmony_ci    font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
141cb0ef41Sopenharmony_ci}
151cb0ef41Sopenharmony_ci#rainbar {
161cb0ef41Sopenharmony_ci    height: 10px;
171cb0ef41Sopenharmony_ci    background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
181cb0ef41Sopenharmony_ci}
191cb0ef41Sopenharmony_ci
201cb0ef41Sopenharmony_cia {
211cb0ef41Sopenharmony_ci    text-decoration: none;
221cb0ef41Sopenharmony_ci    color: #0366d6;
231cb0ef41Sopenharmony_ci}
241cb0ef41Sopenharmony_cia:hover {
251cb0ef41Sopenharmony_ci    text-decoration: underline;
261cb0ef41Sopenharmony_ci}
271cb0ef41Sopenharmony_ci
281cb0ef41Sopenharmony_cipre {
291cb0ef41Sopenharmony_ci    margin: 1em 0px;
301cb0ef41Sopenharmony_ci    padding: 1em;
311cb0ef41Sopenharmony_ci    border: solid 1px #e1e4e8;
321cb0ef41Sopenharmony_ci    border-radius: 6px;
331cb0ef41Sopenharmony_ci
341cb0ef41Sopenharmony_ci    display: block;
351cb0ef41Sopenharmony_ci    overflow: auto;
361cb0ef41Sopenharmony_ci
371cb0ef41Sopenharmony_ci    white-space: pre;
381cb0ef41Sopenharmony_ci
391cb0ef41Sopenharmony_ci    background-color: #f6f8fa;
401cb0ef41Sopenharmony_ci    color: #393a34;
411cb0ef41Sopenharmony_ci}
421cb0ef41Sopenharmony_cicode {
431cb0ef41Sopenharmony_ci    font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
441cb0ef41Sopenharmony_ci    font-size: 85%;
451cb0ef41Sopenharmony_ci    padding: 0.2em 0.4em;
461cb0ef41Sopenharmony_ci    background-color: #f6f8fa;
471cb0ef41Sopenharmony_ci    color: #393a34;
481cb0ef41Sopenharmony_ci}
491cb0ef41Sopenharmony_cipre > code {
501cb0ef41Sopenharmony_ci    padding: 0;
511cb0ef41Sopenharmony_ci    background-color: inherit;
521cb0ef41Sopenharmony_ci    color: inherit;
531cb0ef41Sopenharmony_ci}
541cb0ef41Sopenharmony_cih1, h2, h3 {
551cb0ef41Sopenharmony_ci    font-weight: 600;
561cb0ef41Sopenharmony_ci}
571cb0ef41Sopenharmony_ci
581cb0ef41Sopenharmony_ci#logobar {
591cb0ef41Sopenharmony_ci    background-color: #333333;
601cb0ef41Sopenharmony_ci    margin: 0 auto;
611cb0ef41Sopenharmony_ci    padding: 1em 4em;
621cb0ef41Sopenharmony_ci}
631cb0ef41Sopenharmony_ci#logobar .logo {
641cb0ef41Sopenharmony_ci    float: left;
651cb0ef41Sopenharmony_ci}
661cb0ef41Sopenharmony_ci#logobar .title {
671cb0ef41Sopenharmony_ci    font-weight: 600;
681cb0ef41Sopenharmony_ci    color: #dddddd;
691cb0ef41Sopenharmony_ci    float: left;
701cb0ef41Sopenharmony_ci    margin: 5px 0 0 1em;
711cb0ef41Sopenharmony_ci}
721cb0ef41Sopenharmony_ci#logobar:after {
731cb0ef41Sopenharmony_ci    content: "";
741cb0ef41Sopenharmony_ci    display: block;
751cb0ef41Sopenharmony_ci    clear: both;
761cb0ef41Sopenharmony_ci}
771cb0ef41Sopenharmony_ci
781cb0ef41Sopenharmony_ci#content {
791cb0ef41Sopenharmony_ci    margin: 0 auto;
801cb0ef41Sopenharmony_ci    padding: 0 4em;
811cb0ef41Sopenharmony_ci}
821cb0ef41Sopenharmony_ci
831cb0ef41Sopenharmony_ci#table_of_contents > h2 {
841cb0ef41Sopenharmony_ci    font-size: 1.17em;
851cb0ef41Sopenharmony_ci}
861cb0ef41Sopenharmony_ci#table_of_contents ul:first-child {
871cb0ef41Sopenharmony_ci    border: solid 1px #e1e4e8;
881cb0ef41Sopenharmony_ci    border-radius: 6px;
891cb0ef41Sopenharmony_ci    padding: 1em;
901cb0ef41Sopenharmony_ci    background-color: #f6f8fa;
911cb0ef41Sopenharmony_ci    color: #393a34;
921cb0ef41Sopenharmony_ci}
931cb0ef41Sopenharmony_ci#table_of_contents ul {
941cb0ef41Sopenharmony_ci    list-style-type: none;
951cb0ef41Sopenharmony_ci    padding-left: 1.5em;
961cb0ef41Sopenharmony_ci}
971cb0ef41Sopenharmony_ci#table_of_contents li {
981cb0ef41Sopenharmony_ci    font-size: 0.9em;
991cb0ef41Sopenharmony_ci}
1001cb0ef41Sopenharmony_ci#table_of_contents li a {
1011cb0ef41Sopenharmony_ci    color: #000000;
1021cb0ef41Sopenharmony_ci}
1031cb0ef41Sopenharmony_ci
1041cb0ef41Sopenharmony_ciheader.title {
1051cb0ef41Sopenharmony_ci    border-bottom: solid 1px #e1e4e8;
1061cb0ef41Sopenharmony_ci}
1071cb0ef41Sopenharmony_ciheader.title > h1 {
1081cb0ef41Sopenharmony_ci    margin-bottom: 0.25em;
1091cb0ef41Sopenharmony_ci}
1101cb0ef41Sopenharmony_ciheader.title > .description {
1111cb0ef41Sopenharmony_ci    display: block;
1121cb0ef41Sopenharmony_ci    margin-bottom: 0.5em;
1131cb0ef41Sopenharmony_ci    line-height: 1;
1141cb0ef41Sopenharmony_ci}
1151cb0ef41Sopenharmony_ci
1161cb0ef41Sopenharmony_cifooter#edit {
1171cb0ef41Sopenharmony_ci    border-top: solid 1px #e1e4e8;
1181cb0ef41Sopenharmony_ci    margin: 3em 0 4em 0;
1191cb0ef41Sopenharmony_ci    padding-top: 2em;
1201cb0ef41Sopenharmony_ci}
1211cb0ef41Sopenharmony_ci</style>
1221cb0ef41Sopenharmony_ci</head>
1231cb0ef41Sopenharmony_ci<body>
1241cb0ef41Sopenharmony_ci<div id="banner">
1251cb0ef41Sopenharmony_ci<div id="rainbar"></div>
1261cb0ef41Sopenharmony_ci<div id="logobar">
1271cb0ef41Sopenharmony_ci<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
1281cb0ef41Sopenharmony_ci<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
1291cb0ef41Sopenharmony_ci<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
1301cb0ef41Sopenharmony_ci</svg>
1311cb0ef41Sopenharmony_ci<div class="title">
1321cb0ef41Sopenharmony_cinpm command-line interface
1331cb0ef41Sopenharmony_ci</div>
1341cb0ef41Sopenharmony_ci</div>
1351cb0ef41Sopenharmony_ci</div>
1361cb0ef41Sopenharmony_ci
1371cb0ef41Sopenharmony_ci<section id="content">
1381cb0ef41Sopenharmony_ci<header class="title">
1391cb0ef41Sopenharmony_ci<h1 id="npm-cache">npm-cache</h1>
1401cb0ef41Sopenharmony_ci<span class="description">Manipulates packages cache</span>
1411cb0ef41Sopenharmony_ci</header>
1421cb0ef41Sopenharmony_ci
1431cb0ef41Sopenharmony_ci<section id="table_of_contents">
1441cb0ef41Sopenharmony_ci<h2 id="table-of-contents">Table of contents</h2>
1451cb0ef41Sopenharmony_ci<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>
1461cb0ef41Sopenharmony_ci</section>
1471cb0ef41Sopenharmony_ci
1481cb0ef41Sopenharmony_ci<div id="_content"><h3 id="synopsis">Synopsis</h3>
1491cb0ef41Sopenharmony_ci<pre><code class="language-bash">npm cache add &lt;package-spec&gt;
1501cb0ef41Sopenharmony_cinpm cache clean [&lt;key&gt;]
1511cb0ef41Sopenharmony_cinpm cache ls [&lt;name&gt;@&lt;version&gt;]
1521cb0ef41Sopenharmony_cinpm cache verify
1531cb0ef41Sopenharmony_ci</code></pre>
1541cb0ef41Sopenharmony_ci<p>Note: This command is unaware of workspaces.</p>
1551cb0ef41Sopenharmony_ci<h3 id="description">Description</h3>
1561cb0ef41Sopenharmony_ci<p>Used to add, list, or clean the npm cache folder.</p>
1571cb0ef41Sopenharmony_ci<ul>
1581cb0ef41Sopenharmony_ci<li>
1591cb0ef41Sopenharmony_ci<p>add:
1601cb0ef41Sopenharmony_ciAdd the specified packages to the local cache.  This command is primarily
1611cb0ef41Sopenharmony_ciintended to be used internally by npm, but it can provide a way to
1621cb0ef41Sopenharmony_ciadd data to the local installation cache explicitly.</p>
1631cb0ef41Sopenharmony_ci</li>
1641cb0ef41Sopenharmony_ci<li>
1651cb0ef41Sopenharmony_ci<p>clean:
1661cb0ef41Sopenharmony_ciDelete all data out of the cache folder.  Note that this is typically
1671cb0ef41Sopenharmony_ciunnecessary, as npm's cache is self-healing and resistant to data
1681cb0ef41Sopenharmony_cicorruption issues.</p>
1691cb0ef41Sopenharmony_ci</li>
1701cb0ef41Sopenharmony_ci<li>
1711cb0ef41Sopenharmony_ci<p>verify:
1721cb0ef41Sopenharmony_ciVerify the contents of the cache folder, garbage collecting any unneeded
1731cb0ef41Sopenharmony_cidata, and verifying the integrity of the cache index and all cached data.</p>
1741cb0ef41Sopenharmony_ci</li>
1751cb0ef41Sopenharmony_ci</ul>
1761cb0ef41Sopenharmony_ci<h3 id="details">Details</h3>
1771cb0ef41Sopenharmony_ci<p>npm stores cache data in an opaque directory within the configured <code>cache</code>,
1781cb0ef41Sopenharmony_cinamed <code>_cacache</code>. This directory is a
1791cb0ef41Sopenharmony_ci<a href="http://npm.im/cacache"><code>cacache</code></a>-based content-addressable cache that
1801cb0ef41Sopenharmony_cistores all http request data as well as other package-related data. This
1811cb0ef41Sopenharmony_cidirectory is primarily accessed through <code>pacote</code>, the library responsible
1821cb0ef41Sopenharmony_cifor all package fetching as of npm@5.</p>
1831cb0ef41Sopenharmony_ci<p>All data that passes through the cache is fully verified for integrity on
1841cb0ef41Sopenharmony_ciboth insertion and extraction. Cache corruption will either trigger an
1851cb0ef41Sopenharmony_cierror, or signal to <code>pacote</code> that the data must be refetched, which it will
1861cb0ef41Sopenharmony_cido automatically. For this reason, it should never be necessary to clear
1871cb0ef41Sopenharmony_cithe cache for any reason other than reclaiming disk space, thus why <code>clean</code>
1881cb0ef41Sopenharmony_cinow requires <code>--force</code> to run.</p>
1891cb0ef41Sopenharmony_ci<p>There is currently no method exposed through npm to inspect or directly
1901cb0ef41Sopenharmony_cimanage the contents of this cache. In order to access it, <code>cacache</code> must be
1911cb0ef41Sopenharmony_ciused directly.</p>
1921cb0ef41Sopenharmony_ci<p>npm will not remove data by itself: the cache will grow as new packages are
1931cb0ef41Sopenharmony_ciinstalled.</p>
1941cb0ef41Sopenharmony_ci<h3 id="a-note-about-the-caches-design">A note about the cache's design</h3>
1951cb0ef41Sopenharmony_ci<p>The npm cache is strictly a cache: it should not be relied upon as a
1961cb0ef41Sopenharmony_cipersistent and reliable data store for package data. npm makes no guarantee
1971cb0ef41Sopenharmony_cithat a previously-cached piece of data will be available later, and will
1981cb0ef41Sopenharmony_ciautomatically delete corrupted contents. The primary guarantee that the
1991cb0ef41Sopenharmony_cicache makes is that, if it does return data, that data will be exactly the
2001cb0ef41Sopenharmony_cidata that was inserted.</p>
2011cb0ef41Sopenharmony_ci<p>To run an offline verification of existing cache contents, use <code>npm cache verify</code>.</p>
2021cb0ef41Sopenharmony_ci<h3 id="configuration">Configuration</h3>
2031cb0ef41Sopenharmony_ci<h4 id="cache"><code>cache</code></h4>
2041cb0ef41Sopenharmony_ci<ul>
2051cb0ef41Sopenharmony_ci<li>Default: Windows: <code>%LocalAppData%\npm-cache</code>, Posix: <code>~/.npm</code></li>
2061cb0ef41Sopenharmony_ci<li>Type: Path</li>
2071cb0ef41Sopenharmony_ci</ul>
2081cb0ef41Sopenharmony_ci<p>The location of npm's cache directory.</p>
2091cb0ef41Sopenharmony_ci<h3 id="see-also">See Also</h3>
2101cb0ef41Sopenharmony_ci<ul>
2111cb0ef41Sopenharmony_ci<li><a href="../using-npm/package-spec.html">package spec</a></li>
2121cb0ef41Sopenharmony_ci<li><a href="../configuring-npm/folders.html">npm folders</a></li>
2131cb0ef41Sopenharmony_ci<li><a href="../commands/npm-config.html">npm config</a></li>
2141cb0ef41Sopenharmony_ci<li><a href="../configuring-npm/npmrc.html">npmrc</a></li>
2151cb0ef41Sopenharmony_ci<li><a href="../commands/npm-install.html">npm install</a></li>
2161cb0ef41Sopenharmony_ci<li><a href="../commands/npm-publish.html">npm publish</a></li>
2171cb0ef41Sopenharmony_ci<li><a href="../commands/npm-pack.html">npm pack</a></li>
2181cb0ef41Sopenharmony_ci<li><a href="https://npm.im/cacache">https://npm.im/cacache</a></li>
2191cb0ef41Sopenharmony_ci<li><a href="https://npm.im/pacote">https://npm.im/pacote</a></li>
2201cb0ef41Sopenharmony_ci<li><a href="https://npm.im/@npmcli/arborist">https://npm.im/@npmcli/arborist</a></li>
2211cb0ef41Sopenharmony_ci<li><a href="https://npm.im/make-fetch-happen">https://npm.im/make-fetch-happen</a></li>
2221cb0ef41Sopenharmony_ci</ul></div>
2231cb0ef41Sopenharmony_ci
2241cb0ef41Sopenharmony_ci<footer id="edit">
2251cb0ef41Sopenharmony_ci<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-cache.md">
2261cb0ef41Sopenharmony_ci<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
2271cb0ef41Sopenharmony_ci<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>
2281cb0ef41Sopenharmony_ci</svg>
2291cb0ef41Sopenharmony_ciEdit this page on GitHub
2301cb0ef41Sopenharmony_ci</a>
2311cb0ef41Sopenharmony_ci</footer>
2321cb0ef41Sopenharmony_ci</section>
2331cb0ef41Sopenharmony_ci
2341cb0ef41Sopenharmony_ci
2351cb0ef41Sopenharmony_ci
2361cb0ef41Sopenharmony_ci</body></html>