Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, February 9, 2022
 
 

npm-profile (1)

Name

npm-profile - Change settings on your registry profile Synopsis npm profile get [--json|--parseable] [<property>] npm profile set [--json|--parseable] <property> <value> npm profile set password npm profile enable-2fa [auth-and-writes|auth-only] npm profile disable-2fa Note: This command is unaware of workspaces. Description Change your profile information on the registry. Note that this com- mand depends on the registry implementation, so third-party registries may not support this interface. o npm profile get [<property>]: Display all of the properties of your profile, or one or more specific properties. It looks like: +-----------------+---------------------------+ | name | example | +-----------------+---------------------------+ | email | me@example.com (verified) | +-----------------+---------------------------+ | two factor auth | auth-and-writes | +-----------------+---------------------------+ | fullname | Example User | +-----------------+---------------------------+ | homepage | | +-----------------+---------------------------+ | freenode | | +-----------------+---------------------------+ | twitter | | +-----------------+---------------------------+ | github | | +-----------------+---------------------------+ | created | 2015-02-26T01:38:35.892Z | +-----------------+---------------------------+ | updated | 2017-10-02T21:29:45.922Z | +-----------------+---------------------------+ o npm profile set <property> <value>: Set the value of a profile prop- erty. You can set the following properties this way: email, fullname, homepage, freenode, twitter, github o npm profile set password: Change your password. This is interactive, you'll be prompted for your current password and a new password. You'll also be prompted for an OTP if you have two-factor authentica- tion enabled. o npm profile enable-2fa [auth-and-writes|auth-only]: Enables two-fac- tor authentication. Defaults to auth-and-writes mode. Modes are: o auth-only: Require an OTP when logging in or making changes to your account's authentication. The OTP will be required on both the website and the command line. o auth-and-writes: Requires an OTP at all the times auth-only does, and also requires one when publishing a module, setting the latest dist-tag, or changing access via npm access and npm owner. o npm profile disable-2fa: Disables two-factor authentication. Details Some of these commands may not be available on non npmjs.com reg- istries. Configuration <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- 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 --> json o Default: false o Type: Boolean Whether or not to output JSON data, rather than the normal output. o In npm pkg set it enables parsing set values with JSON.parse() before saving them to your package.json. Not supported by all npm commands. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js --> parseable o Default: false o Type: Boolean Output parseable results from commands that write to standard output. For npm search, this will be tab-separated table format. <!-- automat- ically generated, do not edit manually --> <!-- see lib/utils/con- fig/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 token

Synopsis

Please see following description for synopsis

Description

NPM-PROFILE(1)                                                  NPM-PROFILE(1)



NAME
       npm-profile - Change settings on your registry profile

   Synopsis
         npm profile get [--json|--parseable] [<property>]
         npm profile set [--json|--parseable] <property> <value>
         npm profile set password
         npm profile enable-2fa [auth-and-writes|auth-only]
         npm profile disable-2fa

       Note: This command is unaware of workspaces.

   Description
       Change  your  profile information on the registry.  Note that this com-
       mand depends on the registry implementation, so third-party  registries
       may not support this interface.

       o npm  profile  get [<property>]: Display all of the properties of your
         profile, or one or more specific properties.  It looks like:


         +-----------------+---------------------------+
         | name            | example                   |
         +-----------------+---------------------------+
         | email           | me@example.com (verified) |
         +-----------------+---------------------------+
         | two factor auth | auth-and-writes           |
         +-----------------+---------------------------+
         | fullname        | Example User              |
         +-----------------+---------------------------+
         | homepage        |                           |
         +-----------------+---------------------------+
         | freenode        |                           |
         +-----------------+---------------------------+
         | twitter         |                           |
         +-----------------+---------------------------+
         | github          |                           |
         +-----------------+---------------------------+
         | created         | 2015-02-26T01:38:35.892Z  |
         +-----------------+---------------------------+
         | updated         | 2017-10-02T21:29:45.922Z  |
         +-----------------+---------------------------+

       o npm profile set <property> <value>: Set the value of a profile  prop-
         erty. You can set the following properties this way: email, fullname,
         homepage, freenode, twitter, github

       o npm profile set password: Change your password.  This is interactive,
         you'll  be  prompted  for  your  current password and a new password.
         You'll also be prompted for an OTP if you have two-factor authentica-
         tion enabled.

       o npm  profile enable-2fa [auth-and-writes|auth-only]: Enables two-fac-
         tor authentication. Defaults to auth-and-writes mode. Modes are:

         o auth-only: Require an OTP when logging in or making changes to your
           account's  authentication.   The  OTP  will be required on both the
           website and the command line.

         o auth-and-writes: Requires an OTP at all the times  auth-only  does,
           and  also requires one when publishing a module, setting the latest
           dist-tag, or changing access via npm access and npm owner.


       o npm profile disable-2fa: Disables two-factor authentication.


   Details
       Some of these commands may not  be  available  on  non  npmjs.com  reg-
       istries.

   Configuration
       <!--  AUTOGENERATED  CONFIG  DESCRIPTIONS  START --> <!-- 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 -->


   json
       o Default: false

       o Type: Boolean


       Whether or not to output JSON data, rather than the normal output.

       o In npm pkg set it enables parsing set values with JSON.parse() before
         saving them to your package.json.


       Not  supported  by  all npm commands.  <!-- automatically generated, do
       not edit manually --> <!-- see lib/utils/config/definitions.js -->


   parseable
       o Default: false

       o Type: Boolean


       Output parseable results from commands that write to  standard  output.
       For npm search, this will be tab-separated table format.  <!-- automat-
       ically generated, do not edit  manually  -->  <!--  see  lib/utils/con-
       fig/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 token




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-PROFILE(1)