1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>npm-unpublish</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
116footer#edit {
117    border-top: solid 1px #e1e4e8;
118    margin: 3em 0 4em 0;
119    padding-top: 2em;
120}
121</style>
122</head>
123<body>
124<div id="banner">
125<div id="rainbar"></div>
126<div id="logobar">
127<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
128<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
129<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
130</svg>
131<div class="title">
132npm command-line interface
133</div>
134</div>
135</div>
136
137<section id="content">
138<header class="title">
139<h1 id="npm-unpublish">npm-unpublish</h1>
140<span class="description">Remove a package from the registry</span>
141</header>
142
143<section id="table_of_contents">
144<h2 id="table-of-contents">Table of contents</h2>
145<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#warning">Warning</a></li><li><a href="#description">Description</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#dry-run"><code>dry-run</code></a></li><li><a href="#force"><code>force</code></a></li><li><a href="#workspace"><code>workspace</code></a></li><li><a href="#workspaces"><code>workspaces</code></a></li></ul><li><a href="#see-also">See Also</a></li></ul></div>
146</section>
147
148<div id="_content"><h3 id="synopsis">Synopsis</h3>
149<pre><code class="language-bash">npm unpublish [&lt;package-spec&gt;]
150</code></pre>
151<p>To learn more about how the npm registry treats unpublish, see our
152<a href="https://docs.npmjs.com/policies/unpublish">unpublish policies</a>.</p>
153<h3 id="warning">Warning</h3>
154<p>Consider using the <a href="../commands/npm-deprecate.html"><code>deprecate</code></a> command instead,
155if your intent is to encourage users to upgrade, or if you no longer
156want to maintain a package.</p>
157<h3 id="description">Description</h3>
158<p>This removes a package version from the registry, deleting its entry and
159removing the tarball.</p>
160<p>The npm registry will return an error if you are not <a href="../commands/npm-adduser.html">logged
161in</a>.</p>
162<p>If you do not specify a package name at all, the name and version to be
163unpublished will be pulled from the project in the current directory.</p>
164<p>If you specify a package name but do not specify a version or if you
165remove all of a package's versions then the registry will remove the
166root package entry entirely.</p>
167<p>Even if you unpublish a package version, that specific name and version
168combination can never be reused. In order to publish the package again,
169you must use a new version number. If you unpublish the entire package,
170you may not publish any new versions of that package until 24 hours have
171passed.</p>
172<h3 id="configuration">Configuration</h3>
173<h4 id="dry-run"><code>dry-run</code></h4>
174<ul>
175<li>Default: false</li>
176<li>Type: Boolean</li>
177</ul>
178<p>Indicates that you don't want npm to make any changes and that it should
179only report what it would have done. This can be passed into any of the
180commands that modify your local installation, eg, <code>install</code>, <code>update</code>,
181<code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p>
182<p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>,
183<code>owner</code>, etc.</p>
184<h4 id="force"><code>force</code></h4>
185<ul>
186<li>Default: false</li>
187<li>Type: Boolean</li>
188</ul>
189<p>Removes various protections against unfortunate side effects, common
190mistakes, unnecessary performance degradation, and malicious input.</p>
191<ul>
192<li>Allow clobbering non-npm files in global installs.</li>
193<li>Allow the <code>npm version</code> command to work on an unclean git repository.</li>
194<li>Allow deleting the cache folder with <code>npm cache clean</code>.</li>
195<li>Allow installing packages that have an <code>engines</code> declaration requiring a
196different version of npm.</li>
197<li>Allow installing packages that have an <code>engines</code> declaration requiring a
198different version of <code>node</code>, even if <code>--engine-strict</code> is enabled.</li>
199<li>Allow <code>npm audit fix</code> to install modules outside your stated dependency
200range (including SemVer-major changes).</li>
201<li>Allow unpublishing all versions of a published package.</li>
202<li>Allow conflicting peerDependencies to be installed in the root project.</li>
203<li>Implicitly set <code>--yes</code> during <code>npm init</code>.</li>
204<li>Allow clobbering existing values in <code>npm pkg</code></li>
205<li>Allow unpublishing of entire packages (not just a single version).</li>
206</ul>
207<p>If you don't have a clear idea of what you want to do, it is strongly
208recommended that you do not use this option!</p>
209<h4 id="workspace"><code>workspace</code></h4>
210<ul>
211<li>Default:</li>
212<li>Type: String (can be set multiple times)</li>
213</ul>
214<p>Enable running a command in the context of the configured workspaces of the
215current project while filtering by running only the workspaces defined by
216this configuration option.</p>
217<p>Valid values for the <code>workspace</code> config are either:</p>
218<ul>
219<li>Workspace names</li>
220<li>Path to a workspace directory</li>
221<li>Path to a parent workspace directory (will result in selecting all
222workspaces within that folder)</li>
223</ul>
224<p>When set for the <code>npm init</code> command, this may be set to the folder of a
225workspace which does not yet exist, to create the folder and set it up as a
226brand new workspace within the project.</p>
227<p>This value is not exported to the environment for child processes.</p>
228<h4 id="workspaces"><code>workspaces</code></h4>
229<ul>
230<li>Default: null</li>
231<li>Type: null or Boolean</li>
232</ul>
233<p>Set to true to run the command in the context of <strong>all</strong> configured
234workspaces.</p>
235<p>Explicitly setting this to false will cause commands like <code>install</code> to
236ignore workspaces altogether. When not set explicitly:</p>
237<ul>
238<li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
239will link workspaces into the <code>node_modules</code> folder. - Commands that do
240other things (test, exec, publish, etc.) will operate on the root project,
241<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
242</ul>
243<p>This value is not exported to the environment for child processes.</p>
244<h3 id="see-also">See Also</h3>
245<ul>
246<li><a href="../using-npm/package-spec.html">package spec</a></li>
247<li><a href="../commands/npm-deprecate.html">npm deprecate</a></li>
248<li><a href="../commands/npm-publish.html">npm publish</a></li>
249<li><a href="../using-npm/registry.html">npm registry</a></li>
250<li><a href="../commands/npm-adduser.html">npm adduser</a></li>
251<li><a href="../commands/npm-owner.html">npm owner</a></li>
252<li><a href="../commands/npm-adduser.html">npm login</a></li>
253</ul></div>
254
255<footer id="edit">
256<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-unpublish.md">
257<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
258<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>
259</svg>
260Edit this page on GitHub
261</a>
262</footer>
263</section>
264
265
266
267</body></html>