1<!DOCTYPE html><html><head> 2<meta charset="utf-8"> 3<title>npm-profile</title> 4<style> 5body { 6 background-color: #ffffff; 7 color: #24292e; 8 9 margin: 0; 10 11 line-height: 1.5; 12 13 font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; 14} 15#rainbar { 16 height: 10px; 17 background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff); 18} 19 20a { 21 text-decoration: none; 22 color: #0366d6; 23} 24a:hover { 25 text-decoration: underline; 26} 27 28pre { 29 margin: 1em 0px; 30 padding: 1em; 31 border: solid 1px #e1e4e8; 32 border-radius: 6px; 33 34 display: block; 35 overflow: auto; 36 37 white-space: pre; 38 39 background-color: #f6f8fa; 40 color: #393a34; 41} 42code { 43 font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace; 44 font-size: 85%; 45 padding: 0.2em 0.4em; 46 background-color: #f6f8fa; 47 color: #393a34; 48} 49pre > code { 50 padding: 0; 51 background-color: inherit; 52 color: inherit; 53} 54h1, h2, h3 { 55 font-weight: 600; 56} 57 58#logobar { 59 background-color: #333333; 60 margin: 0 auto; 61 padding: 1em 4em; 62} 63#logobar .logo { 64 float: left; 65} 66#logobar .title { 67 font-weight: 600; 68 color: #dddddd; 69 float: left; 70 margin: 5px 0 0 1em; 71} 72#logobar:after { 73 content: ""; 74 display: block; 75 clear: both; 76} 77 78#content { 79 margin: 0 auto; 80 padding: 0 4em; 81} 82 83#table_of_contents > h2 { 84 font-size: 1.17em; 85} 86#table_of_contents ul:first-child { 87 border: solid 1px #e1e4e8; 88 border-radius: 6px; 89 padding: 1em; 90 background-color: #f6f8fa; 91 color: #393a34; 92} 93#table_of_contents ul { 94 list-style-type: none; 95 padding-left: 1.5em; 96} 97#table_of_contents li { 98 font-size: 0.9em; 99} 100#table_of_contents li a { 101 color: #000000; 102} 103 104header.title { 105 border-bottom: solid 1px #e1e4e8; 106} 107header.title > h1 { 108 margin-bottom: 0.25em; 109} 110header.title > .description { 111 display: block; 112 margin-bottom: 0.5em; 113 line-height: 1; 114} 115 116footer#edit { 117 border-top: solid 1px #e1e4e8; 118 margin: 3em 0 4em 0; 119 padding-top: 2em; 120} 121</style> 122</head> 123<body> 124<div id="banner"> 125<div id="rainbar"></div> 126<div id="logobar"> 127<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700"> 128<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon> 129<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon> 130</svg> 131<div class="title"> 132npm command-line interface 133</div> 134</div> 135</div> 136 137<section id="content"> 138<header class="title"> 139<h1 id="npm-profile">npm-profile</h1> 140<span class="description">Change settings on your registry profile</span> 141</header> 142 143<section id="table_of_contents"> 144<h2 id="table-of-contents">Table of contents</h2> 145<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#details">Details</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#registry"><code>registry</code></a></li><li><a href="#json"><code>json</code></a></li><li><a href="#parseable"><code>parseable</code></a></li><li><a href="#otp"><code>otp</code></a></li></ul><li><a href="#see-also">See Also</a></li></ul></div> 146</section> 147 148<div id="_content"><h3 id="synopsis">Synopsis</h3> 149<pre><code class="language-bash">npm profile enable-2fa [auth-only|auth-and-writes] 150npm profile disable-2fa 151npm profile get [<key>] 152npm profile set <key> <value> 153</code></pre> 154<p>Note: This command is unaware of workspaces.</p> 155<h3 id="description">Description</h3> 156<p>Change your profile information on the registry. Note that this command 157depends on the registry implementation, so third-party registries may not 158support this interface.</p> 159<ul> 160<li><code>npm profile get [<property>]</code>: Display all of the properties of your 161profile, or one or more specific properties. It looks like:</li> 162</ul> 163<pre><code class="language-bash">+-----------------+---------------------------+ 164| name | example | 165+-----------------+---------------------------+ 166| email | me@example.com (verified) | 167+-----------------+---------------------------+ 168| two factor auth | auth-and-writes | 169+-----------------+---------------------------+ 170| fullname | Example User | 171+-----------------+---------------------------+ 172| homepage | | 173+-----------------+---------------------------+ 174| freenode | | 175+-----------------+---------------------------+ 176| twitter | | 177+-----------------+---------------------------+ 178| github | | 179+-----------------+---------------------------+ 180| created | 2015-02-26T01:38:35.892Z | 181+-----------------+---------------------------+ 182| updated | 2017-10-02T21:29:45.922Z | 183+-----------------+---------------------------+ 184</code></pre> 185<ul> 186<li> 187<p><code>npm profile set <property> <value></code>: Set the value of a profile 188property. You can set the following properties this way: email, fullname, 189homepage, freenode, twitter, github</p> 190</li> 191<li> 192<p><code>npm profile set password</code>: Change your password. This is interactive, 193you'll be prompted for your current password and a new password. You'll 194also be prompted for an OTP if you have two-factor authentication 195enabled.</p> 196</li> 197<li> 198<p><code>npm profile enable-2fa [auth-and-writes|auth-only]</code>: Enables two-factor 199authentication. Defaults to <code>auth-and-writes</code> mode. Modes are:</p> 200<ul> 201<li><code>auth-only</code>: Require an OTP when logging in or making changes to your 202account's authentication. The OTP will be required on both the website 203and the command line.</li> 204<li><code>auth-and-writes</code>: Requires an OTP at all the times <code>auth-only</code> does, 205and also requires one when publishing a module, setting the <code>latest</code> 206dist-tag, or changing access via <code>npm access</code> and <code>npm owner</code>.</li> 207</ul> 208</li> 209<li> 210<p><code>npm profile disable-2fa</code>: Disables two-factor authentication.</p> 211</li> 212</ul> 213<h3 id="details">Details</h3> 214<p>Some of these commands may not be available on non npmjs.com registries.</p> 215<h3 id="configuration">Configuration</h3> 216<h4 id="registry"><code>registry</code></h4> 217<ul> 218<li>Default: "<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>"</li> 219<li>Type: URL</li> 220</ul> 221<p>The base URL of the npm registry.</p> 222<h4 id="json"><code>json</code></h4> 223<ul> 224<li>Default: false</li> 225<li>Type: Boolean</li> 226</ul> 227<p>Whether or not to output JSON data, rather than the normal output.</p> 228<ul> 229<li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before 230saving them to your <code>package.json</code>.</li> 231</ul> 232<p>Not supported by all npm commands.</p> 233<h4 id="parseable"><code>parseable</code></h4> 234<ul> 235<li>Default: false</li> 236<li>Type: Boolean</li> 237</ul> 238<p>Output parseable results from commands that write to standard output. For 239<code>npm search</code>, this will be tab-separated table format.</p> 240<h4 id="otp"><code>otp</code></h4> 241<ul> 242<li>Default: null</li> 243<li>Type: null or String</li> 244</ul> 245<p>This is a one-time password from a two-factor authenticator. It's needed 246when publishing or changing package permissions with <code>npm access</code>.</p> 247<p>If not set, and a registry response fails with a challenge for a one-time 248password, npm will prompt on the command line for one.</p> 249<h3 id="see-also">See Also</h3> 250<ul> 251<li><a href="../commands/npm-adduser.html">npm adduser</a></li> 252<li><a href="../using-npm/registry.html">npm registry</a></li> 253<li><a href="../commands/npm-config.html">npm config</a></li> 254<li><a href="../configuring-npm/npmrc.html">npmrc</a></li> 255<li><a href="../commands/npm-owner.html">npm owner</a></li> 256<li><a href="../commands/npm-whoami.html">npm whoami</a></li> 257<li><a href="../commands/npm-token.html">npm token</a></li> 258</ul></div> 259 260<footer id="edit"> 261<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-profile.md"> 262<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;"> 263<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> 264</svg> 265Edit this page on GitHub 266</a> 267</footer> 268</section> 269 270 271 272</body></html>