npm-token.html 9.1 KB

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