Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, February 9, 2022
 
 

npm-token (1)

Name

npm-token - Manage your authentication tokens Synopsis npm token list [--json|--parseable] npm token create [--read-only] [--cidr=1.1.1.1/24,2.2.2.2/16] npm token revoke <id|token> Note: This command is unaware of workspaces. Description This lets you list, create and revoke authentication tokens. o npm token list: Shows a table of all active authentication tokens. You can request this as JSON with --json or tab-separated values with --parseable. +--------+---------+------------+----------+----------------+ | id | token | created | read-only | CIDR whitelist | +--------+---------+------------+----------+----------------+ | 7f3134 | 1fa9ba | 2017-10-02 | yes | | +--------+---------+------------+----------+----------------+ | c03241 | af7aef | 2017-10-02 | no | 192.168.0.1/24 | +--------+---------+------------+----------+----------------+ | e0cf92 | 3a436a | 2017-10-02 | no | | +--------+---------+------------+----------+----------------+ | 63eb9d | 74ef35 | 2017-09-28 | no | | +--------+---------+------------+----------+----------------+ | 2daaa8 | cbad5f | 2017-09-26 | no | | +--------+---------+------------+----------+----------------+ | 68c2fe | 127e51 | 2017-09-23 | no | | +--------+---------+------------+----------+----------------+ | 6334e1 | 1dadd1 | 2017-09-23 | no | | +--------+---------+------------+----------+----------------+ o npm token create [--read-only] [--cidr=<cidr-ranges>]: Create a new authentication token. It can be --read-only, or accept a list of CIDR https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing ranges with which to limit use of this token. This will prompt you for your password, and, if you have two-factor authentication enabled, an otp. Currently, the cli can not generate automation tokens. Please refer to the docs website https://docs.npmjs.com/creating-and-view- ing-access-tokens for more information on generating automation tokens. +----------------+--------------------------------------+ | token | a73c9572-f1b9-8983-983d-ba3ac3cc913d | +----------------+--------------------------------------+ | cidr_whitelist | | +----------------+--------------------------------------+ | readonly | false | +----------------+--------------------------------------+ | created | 2017-10-02T07:52:24.838Z | +----------------+--------------------------------------+ o npm token revoke <token|id>: Immediately removes an authentication token from the registry. You will no longer be able to use it. This can accept both complete tokens (such as those you get back from npm token create, and those found in your .npmrc), and ids as seen in the parseable or json output of npm token list. This will NOT accept the truncated token found in the normal npm token list output. Configuration <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/defini- tions.js --> read-only o Default: false o Type: Boolean This is used to mark a token as unable to publish when configuring lim- ited access tokens with the npm token create command. <!-- automati- cally generated, do not edit manually --> <!-- see lib/utils/con- fig/definitions.js --> cidr o Default: null o Type: null or String (can be set multiple times) This is a list of CIDR address to be used when configuring limited access tokens with the npm token create command. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/defini- tions.js --> registry o Default: "https://registry.npmjs.org/" o Type: URL The base URL of the npm registry. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js --> otp o Default: null o Type: null or String This is a one-time password from a two-factor authenticator. It's needed when publishing or changing package permissions with npm access. If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js --> <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> See Also o npm help adduser o npm help registry o npm help config o npm help npmrc o npm help owner o npm help whoami o npm help profile

Synopsis

Please see following description for synopsis

Description

NPM-TOKEN(1)                                                      NPM-TOKEN(1)



NAME
       npm-token - Manage your authentication tokens

   Synopsis
           npm token list [--json|--parseable]
           npm token create [--read-only] [--cidr=1.1.1.1/24,2.2.2.2/16]
           npm token revoke <id|token>

       Note: This command is unaware of workspaces.

   Description
       This lets you list, create and revoke authentication tokens.

       o npm  token  list:  Shows a table of all active authentication tokens.
         You can request this as JSON with --json or tab-separated values with
         --parseable.


         +--------+---------+------------+----------+----------------+
         | id     | token   | created    | read-only | CIDR whitelist |
         +--------+---------+------------+----------+----------------+
         | 7f3134 | 1fa9ba | 2017-10-02 | yes      |                |
         +--------+---------+------------+----------+----------------+
         | c03241 | af7aef | 2017-10-02 | no       | 192.168.0.1/24 |
         +--------+---------+------------+----------+----------------+
         | e0cf92 | 3a436a | 2017-10-02 | no       |                |
         +--------+---------+------------+----------+----------------+
         | 63eb9d | 74ef35 | 2017-09-28 | no       |                |
         +--------+---------+------------+----------+----------------+
         | 2daaa8 | cbad5f | 2017-09-26 | no       |                |
         +--------+---------+------------+----------+----------------+
         | 68c2fe | 127e51 | 2017-09-23 | no       |                |
         +--------+---------+------------+----------+----------------+
         | 6334e1 | 1dadd1 | 2017-09-23 | no       |                |
         +--------+---------+------------+----------+----------------+

       o npm  token  create [--read-only] [--cidr=<cidr-ranges>]: Create a new
         authentication token. It can be --read-only, or accept a list of CIDR
         https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing   ranges
         with which to limit use of this token. This will prompt you for  your
         password, and, if you have two-factor authentication enabled, an otp.
         Currently, the cli can not generate automation tokens.  Please  refer
         to   the   docs   website   https://docs.npmjs.com/creating-and-view-
         ing-access-tokens  for  more  information  on  generating  automation
         tokens.


         +----------------+--------------------------------------+
         | token          | a73c9572-f1b9-8983-983d-ba3ac3cc913d |
         +----------------+--------------------------------------+
         | cidr_whitelist |                                      |
         +----------------+--------------------------------------+
         | readonly       | false                                |
         +----------------+--------------------------------------+
         | created        | 2017-10-02T07:52:24.838Z             |
         +----------------+--------------------------------------+

       o npm  token  revoke  <token|id>: Immediately removes an authentication
         token from the registry.  You will no longer be able to use it.  This
         can  accept both complete tokens (such as those you get back from npm
         token create, and those found in your .npmrc), and ids as seen in the
         parseable or json output of npm token list.  This will NOT accept the
         truncated token found in the normal npm token list output.


   Configuration
       <!-- AUTOGENERATED CONFIG DESCRIPTIONS  START  -->  <!--  automatically
       generated,  do  not edit manually --> <!-- see lib/utils/config/defini-
       tions.js -->

   read-only
       o Default: false

       o Type: Boolean


       This is used to mark a token as unable to publish when configuring lim-
       ited  access  tokens with the npm token create command.  <!-- automati-
       cally generated, do not  edit  manually  -->  <!--  see  lib/utils/con-
       fig/definitions.js -->


   cidr
       o Default: null

       o Type: null or String (can be set multiple times)


       This  is  a  list  of  CIDR address to be used when configuring limited
       access tokens with the npm token create  command.   <!--  automatically
       generated,  do  not edit manually --> <!-- see lib/utils/config/defini-
       tions.js -->


   registry
       o Default: "https://registry.npmjs.org/"

       o Type: URL


       The base URL of the npm registry.  <!-- automatically generated, do not
       edit manually --> <!-- see lib/utils/config/definitions.js -->


   otp
       o Default: null

       o Type: null or String


       This  is  a  one-time  password  from  a two-factor authenticator. It's
       needed when publishing or changing package permissions with npm access.

       If not set, and a registry  response  fails  with  a  challenge  for  a
       one-time  password,  npm will prompt on the command line for one.  <!--
       automatically  generated,  do  not   edit   manually   -->   <!--   see
       lib/utils/config/definitions.js -->

       <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->


   See Also
       o npm help adduser

       o npm help registry

       o npm help config

       o npm help npmrc

       o npm help owner

       o npm help whoami

       o npm help profile




ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | runtime/nodejs/nodejs-16 |
       +---------------+--------------------------+
       |Stability      | Pass-thru volatile       |
       +---------------+--------------------------+

NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was   downloaded   from    https://github.com/nodejs/node/ar-
       chive/v16.11.1.zip.

       Further information about this software can be found on the open source
       community website at https://github.com/nodejs/node.



                                 October 2021                     NPM-TOKEN(1)