1NPM-PROFILE(1)                                                  NPM-PROFILE(1)
2
3
4

NAME

6       npm-profile - Change settings on your registry profile
7
8   Synopsis
9         npm profile enable-2fa [auth-only|auth-and-writes]
10         npm profile disable-2fa
11         npm profile get [<key>]
12         npm profile set <key> <value>
13
14       Note: This command is unaware of workspaces.
15
16   Description
17       Change your profile information on the registry. Note that this command
18       depends on the registry implementation, so third-party  registries  may
19       not support this interface.
20
21       •   npm profile get [<property>]: Display all of the properties of your
22           profile, or one or more specific properties. It looks like:
23
24
25         +-----------------+---------------------------+
26         | name            | example                   |
27         +-----------------+---------------------------+
28         | email           | me@example.com (verified) |
29         +-----------------+---------------------------+
30         | two factor auth | auth-and-writes           |
31         +-----------------+---------------------------+
32         | fullname        | Example User              |
33         +-----------------+---------------------------+
34         | homepage        |                           |
35         +-----------------+---------------------------+
36         | freenode        |                           |
37         +-----------------+---------------------------+
38         | twitter         |                           |
39         +-----------------+---------------------------+
40         | github          |                           |
41         +-----------------+---------------------------+
42         | created         | 2015-02-26T01:38:35.892Z  |
43         +-----------------+---------------------------+
44         | updated         | 2017-10-02T21:29:45.922Z  |
45         +-----------------+---------------------------+
46
47       •   npm profile set <property> <value>: Set  the  value  of  a  profile
48           property.  You  can  set  the following properties this way: email,
49           fullname, homepage, freenode, twitter, github
50
51       •   npm profile set password: Change your password.  This  is  interac‐
52           tive,  you'll be prompted for your current password and a new pass‐
53           word. You'll also be prompted for an OTP if you have two-factor au‐
54           thentication enabled.
55
56       •   npm  profile  enable-2fa  [auth-and-writes|auth-only]: Enables two-
57           factor authentication. Defaults to auth-and-writes mode. Modes are:
58
59           •   auth-only: Require an OTP when logging in or making changes  to
60               your account's authentication. The OTP will be required on both
61               the website and the command line.
62
63           •   auth-and-writes: Requires an OTP at  all  the  times  auth-only
64               does,  and  also requires one when publishing a module, setting
65               the latest dist-tag, or changing access via npm access and  npm
66               owner.
67
68
69       •   npm profile disable-2fa: Disables two-factor authentication.
70
71
72   Details
73       Some  of  these  commands  may  not  be available on non npmjs.com reg‐
74       istries.
75
76   Configuration
77   registry
78       •   Default: "https://registry.npmjs.org/"
79
80       •   Type: URL
81
82
83       The base URL of the npm registry.
84
85   json
86       •   Default: false
87
88       •   Type: Boolean
89
90
91       Whether or not to output JSON data, rather than the normal output.
92
93       •   In npm pkg set it enables parsing set values with JSON.parse()  be‐
94           fore saving them to your package.json.
95
96
97       Not supported by all npm commands.
98
99   parseable
100       •   Default: false
101
102       •   Type: Boolean
103
104
105       Output  parseable  results from commands that write to standard output.
106       For npm search, this will be tab-separated table format.
107
108   otp
109       •   Default: null
110
111       •   Type: null or String
112
113
114       This is a one-time  password  from  a  two-factor  authenticator.  It's
115       needed when publishing or changing package permissions with npm access.
116
117       If  not  set, and a registry response fails with a challenge for a one-
118       time password, npm will prompt on the command line for one.
119
120   See Also
121       •   npm help adduser
122
123       •   npm help registry
124
125       •   npm help config
126
127       •   npm help npmrc
128
129       •   npm help owner
130
131       •   npm help whoami
132
133       •   npm help token
134
135
136
137                                 November 2023                  NPM-PROFILE(1)
Impressum