1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>npm-token</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-token">npm-token</h1>
140<span class="description">Manage your authentication tokens</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="#description">Description</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#read-only"><code>read-only</code></a></li><li><a href="#cidr"><code>cidr</code></a></li><li><a href="#registry"><code>registry</code></a></li><li><a href="#otp"><code>otp</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 token list
150npm token revoke &lt;id|token&gt;
151npm token create [--read-only] [--cidr=list]
152</code></pre>
153<p>Note: This command is unaware of workspaces.</p>
154<h3 id="description">Description</h3>
155<p>This lets you list, create and revoke authentication tokens.</p>
156<ul>
157<li><code>npm token list</code>:
158Shows a table of all active authentication tokens. You can request
159this as JSON with <code>--json</code> or tab-separated values with <code>--parseable</code>.</li>
160</ul>
161<pre><code class="language-bash">+--------+---------+------------+----------+----------------+
162| id     | token   | created    | read-only | CIDR whitelist |
163+--------+---------+------------+----------+----------------+
164| 7f3134 | 1fa9ba… | 2017-10-02 | yes      |                |
165+--------+---------+------------+----------+----------------+
166| c03241 | af7aef… | 2017-10-02 | no       | 192.168.0.1/24 |
167+--------+---------+------------+----------+----------------+
168| e0cf92 | 3a436a… | 2017-10-02 | no       |                |
169+--------+---------+------------+----------+----------------+
170| 63eb9d | 74ef35… | 2017-09-28 | no       |                |
171+--------+---------+------------+----------+----------------+
172| 2daaa8 | cbad5f… | 2017-09-26 | no       |                |
173+--------+---------+------------+----------+----------------+
174| 68c2fe | 127e51… | 2017-09-23 | no       |                |
175+--------+---------+------------+----------+----------------+
176| 6334e1 | 1dadd1… | 2017-09-23 | no       |                |
177+--------+---------+------------+----------+----------------+
178</code></pre>
179<ul>
180<li>
181<p><code>npm token create [--read-only] [--cidr=&lt;cidr-ranges&gt;]</code>:
182Create a new authentication token. It can be <code>--read-only</code>, or accept
183a list of
184<a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">CIDR</a>
185ranges with which to limit use of this token. This will prompt you for
186your password, and, if you have two-factor authentication enabled, an
187otp.</p>
188<p>Currently, the cli can not generate automation tokens. Please refer to
189the <a href="https://docs.npmjs.com/creating-and-viewing-access-tokens">docs
190website</a>
191for more information on generating automation tokens.</p>
192</li>
193</ul>
194<pre><code class="language-bash">+----------------+--------------------------------------+
195| token          | a73c9572-f1b9-8983-983d-ba3ac3cc913d |
196+----------------+--------------------------------------+
197| cidr_whitelist |                                      |
198+----------------+--------------------------------------+
199| readonly       | false                                |
200+----------------+--------------------------------------+
201| created        | 2017-10-02T07:52:24.838Z             |
202+----------------+--------------------------------------+
203</code></pre>
204<ul>
205<li><code>npm token revoke &lt;token|id&gt;</code>:
206Immediately removes an authentication token from the registry.  You
207will no longer be able to use it.  This can accept both complete
208tokens (such as those you get back from <code>npm token create</code>, and those
209found in your <code>.npmrc</code>), and ids as seen in the parseable or json
210output of <code>npm token list</code>.  This will NOT accept the truncated token
211found in the normal <code>npm token list</code> output.</li>
212</ul>
213<h3 id="configuration">Configuration</h3>
214<h4 id="read-only"><code>read-only</code></h4>
215<ul>
216<li>Default: false</li>
217<li>Type: Boolean</li>
218</ul>
219<p>This is used to mark a token as unable to publish when configuring limited
220access tokens with the <code>npm token create</code> command.</p>
221<h4 id="cidr"><code>cidr</code></h4>
222<ul>
223<li>Default: null</li>
224<li>Type: null or String (can be set multiple times)</li>
225</ul>
226<p>This is a list of CIDR address to be used when configuring limited access
227tokens with the <code>npm token create</code> command.</p>
228<h4 id="registry"><code>registry</code></h4>
229<ul>
230<li>Default: "<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>"</li>
231<li>Type: URL</li>
232</ul>
233<p>The base URL of the npm registry.</p>
234<h4 id="otp"><code>otp</code></h4>
235<ul>
236<li>Default: null</li>
237<li>Type: null or String</li>
238</ul>
239<p>This is a one-time password from a two-factor authenticator. It's needed
240when publishing or changing package permissions with <code>npm access</code>.</p>
241<p>If not set, and a registry response fails with a challenge for a one-time
242password, npm will prompt on the command line for one.</p>
243<h3 id="see-also">See Also</h3>
244<ul>
245<li><a href="../commands/npm-adduser.html">npm adduser</a></li>
246<li><a href="../using-npm/registry.html">npm registry</a></li>
247<li><a href="../commands/npm-config.html">npm config</a></li>
248<li><a href="../configuring-npm/npmrc.html">npmrc</a></li>
249<li><a href="../commands/npm-owner.html">npm owner</a></li>
250<li><a href="../commands/npm-whoami.html">npm whoami</a></li>
251<li><a href="../commands/npm-profile.html">npm profile</a></li>
252</ul></div>
253
254<footer id="edit">
255<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-token.md">
256<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
257<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>
258</svg>
259Edit this page on GitHub
260</a>
261</footer>
262</section>
263
264
265
266</body></html>