mirror of
https://github.com/nodejs/node.git
synced 2025-05-13 16:39:33 +00:00
dc05c70c8f
PR-URL: https://github.com/nodejs/node/pull/35908 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Ruy Adorno <ruyadorno@github.com> Reviewed-By: Guy Bedford <guybedford@gmail.com>
92 lines
2.8 KiB
Markdown
92 lines
2.8 KiB
Markdown
---
|
|
title: npm-adduser
|
|
section: 1
|
|
description: Add a registry user account
|
|
---
|
|
|
|
### Synopsis
|
|
|
|
```bash
|
|
npm adduser [--registry=url] [--scope=@orgname] [--always-auth] [--auth-type=legacy]
|
|
|
|
aliases: login, add-user
|
|
```
|
|
|
|
### Description
|
|
|
|
Create or verify a user named `<username>` in the specified registry, and
|
|
save the credentials to the `.npmrc` file. If no registry is specified,
|
|
the default registry will be used (see [`config`](/using-npm/config)).
|
|
|
|
The username, password, and email are read in from prompts.
|
|
|
|
To reset your password, go to <https://www.npmjs.com/forgot>
|
|
|
|
To change your email address, go to <https://www.npmjs.com/email-edit>
|
|
|
|
You may use this command multiple times with the same user account to
|
|
authorize on a new machine. When authenticating on a new machine,
|
|
the username, password and email address must all match with
|
|
your existing record.
|
|
|
|
`npm login` is an alias to `adduser` and behaves exactly the same way.
|
|
|
|
### Configuration
|
|
|
|
#### registry
|
|
|
|
Default: https://registry.npmjs.org/
|
|
|
|
The base URL of the npm package registry. If `scope` is also specified,
|
|
this registry will only be used for packages with that scope. `scope` defaults
|
|
to the scope of the project directory you're currently in, if any. See [`scope`](/using-npm/scope).
|
|
|
|
#### scope
|
|
|
|
Default: none
|
|
|
|
If specified, the user and login credentials given will be associated
|
|
with the specified scope. See [`scope`](/using-npm/scope). You can use both at the same time,
|
|
e.g.
|
|
|
|
```bash
|
|
npm adduser --registry=http://myregistry.example.com --scope=@myco
|
|
```
|
|
|
|
This will set a registry for the given scope and login or create a user for
|
|
that registry at the same time.
|
|
|
|
#### always-auth
|
|
|
|
Default: false
|
|
|
|
If specified, save configuration indicating that all requests to the given
|
|
registry should include authorization information. Useful for private
|
|
registries. Can be used with `--registry` and / or `--scope`, e.g.
|
|
|
|
```bash
|
|
npm adduser --registry=http://private-registry.example.com --always-auth
|
|
```
|
|
|
|
This will ensure that all requests to that registry (including for tarballs)
|
|
include an authorization header. This setting may be necessary for use with
|
|
private registries where metadata and package tarballs are stored on hosts with
|
|
different hostnames. See `always-auth` in [`config`](/using-npm/config) for more details on always-auth. Registry-specific configuration of `always-auth` takes precedence over any global configuration.
|
|
|
|
#### auth-type
|
|
|
|
* Default: `'legacy'`
|
|
* Type: `'legacy'`, `'sso'`, `'saml'`, `'oauth'`
|
|
|
|
What authentication strategy to use with `adduser`/`login`. Some npm registries
|
|
(for example, npmE) might support alternative auth strategies besides classic
|
|
username/password entry in legacy npm.
|
|
|
|
### See Also
|
|
|
|
* [npm registry](/using-npm/registry)
|
|
* [npm config](/commands/npm-config)
|
|
* [npmrc](/configuring-npm/npmrc)
|
|
* [npm owner](/commands/npm-owner)
|
|
* [npm whoami](/commands/npm-whoami)
|