"NPM-PROFILE" "1" "July 2023" "" ""
"NAME"
npm-profile - Change settings on your registry profile
"Synopsis"
npm profile enable-2fa \[lB]auth-only|auth-and-writes\[rB]
npm profile disable-2fa
npm profile get \[lB]<key>\[rB]
npm profile set <key> <value>
Note: This command is unaware of workspaces.
"Description"
Change your profile information on the registry. Note that this command depends on the registry implementation, so third-party registries may not support this interface.
\(bu 4
npm profile get \[lB]<property>\[rB]: 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 |
+-----------------+---------------------------+
\(bu 4
npm profile set <property> <value>: Set the value of a profile property. You can set the following properties this way: email, fullname, homepage, freenode, twitter, github
\(bu 4
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 authentication enabled.
\(bu 4
npm profile enable-2fa \[lB]auth-and-writes|auth-only\[rB]: Enables two-factor authentication. Defaults to
auth-and-writes mode. Modes are:
\(bu 4
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.
\(bu 4
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.
\(bu 4
npm profile disable-2fa: Disables two-factor authentication.
"Details"
Some of these commands may not be available on non npmjs.com registries.
"Configuration"
"registry"
\(bu 4
Default: "https://registry.npmjs.org/"
\(bu 4
Type: URL
The base URL of the npm registry.
"json"
\(bu 4
Default: false
\(bu 4
Type: Boolean
Whether or not to output JSON data, rather than the normal output.
\(bu 4
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.
"parseable"
\(bu 4
Default: false
\(bu 4
Type: Boolean
Output parseable results from commands that write to standard output. For npm search, this will be tab-separated table format.
"otp"
\(bu 4
Default: null
\(bu 4
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.
"See Also"
\(bu 4
npm help adduser
\(bu 4
npm help registry
\(bu 4
npm help config
\(bu 4
npm help npmrc
\(bu 4
npm help owner
\(bu 4
npm help whoami
\(bu 4
npm help token