1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>npm-login</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-login">npm-login</h1>
140<span class="description">Login to a registry user account</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="#configuration">Configuration</a></li><ul><li><a href="#registry"><code>registry</code></a></li><li><a href="#scope"><code>scope</code></a></li><li><a href="#auth-type"><code>auth-type</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 login
150</code></pre>
151<p>Note: This command is unaware of workspaces.</p>
152<h3 id="description">Description</h3>
153<p>Verify a user in the specified registry, and save the credentials to the
154<code>.npmrc</code> file. If no registry is specified, the default registry will be
155used (see <a href="../using-npm/config.html"><code>config</code></a>).</p>
156<p>When using <code>legacy</code> for your <code>auth-type</code>, the username and password, are
157read in from prompts.</p>
158<p>To reset your password, go to <a href="https://www.npmjs.com/forgot">https://www.npmjs.com/forgot</a></p>
159<p>To change your email address, go to <a href="https://www.npmjs.com/email-edit">https://www.npmjs.com/email-edit</a></p>
160<p>You may use this command multiple times with the same user account to
161authorize on a new machine.  When authenticating on a new machine,
162the username, password and email address must all match with
163your existing record.</p>
164<h3 id="configuration">Configuration</h3>
165<h4 id="registry"><code>registry</code></h4>
166<ul>
167<li>Default: "<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>"</li>
168<li>Type: URL</li>
169</ul>
170<p>The base URL of the npm registry.</p>
171<h4 id="scope"><code>scope</code></h4>
172<ul>
173<li>Default: the scope of the current project, if any, or ""</li>
174<li>Type: String</li>
175</ul>
176<p>Associate an operation with a scope for a scoped registry.</p>
177<p>Useful when logging in to or out of a private registry:</p>
178<pre><code># log in, linking the scope to the custom registry
179npm login --scope=@mycorp --registry=https://registry.mycorp.com
180
181# log out, removing the link and the auth token
182npm logout --scope=@mycorp
183</code></pre>
184<p>This will cause <code>@mycorp</code> to be mapped to the registry for future
185installation of packages specified according to the pattern
186<code>@mycorp/package</code>.</p>
187<p>This will also cause <code>npm init</code> to create a scoped package.</p>
188<pre><code># accept all defaults, and create a package named "@foo/whatever",
189# instead of just named "whatever"
190npm init --scope=@foo --yes
191</code></pre>
192<h4 id="auth-type"><code>auth-type</code></h4>
193<ul>
194<li>Default: "web"</li>
195<li>Type: "legacy" or "web"</li>
196</ul>
197<p>What authentication strategy to use with <code>login</code>. Note that if an <code>otp</code>
198config is given, this value will always be set to <code>legacy</code>.</p>
199<h3 id="see-also">See Also</h3>
200<ul>
201<li><a href="../using-npm/registry.html">npm registry</a></li>
202<li><a href="../commands/npm-config.html">npm config</a></li>
203<li><a href="../configuring-npm/npmrc.html">npmrc</a></li>
204<li><a href="../commands/npm-owner.html">npm owner</a></li>
205<li><a href="../commands/npm-whoami.html">npm whoami</a></li>
206<li><a href="../commands/npm-token.html">npm token</a></li>
207<li><a href="../commands/npm-profile.html">npm profile</a></li>
208</ul></div>
209
210<footer id="edit">
211<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-login.md">
212<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
213<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>
214</svg>
215Edit this page on GitHub
216</a>
217</footer>
218</section>
219
220
221
222</body></html>