npm CLI
CLI Commands
npmnpm accessnpm addusernpm auditnpm bugsnpm cachenpm cinpm completionnpm confignpm dedupenpm deprecatenpm diffnpm dist-tagnpm docsnpm doctornpm editnpm execnpm explainnpm explorenpm find-dupesnpm fundnpm helpnpm help-searchnpm hooknpm initnpm installnpm install-ci-testnpm install-testnpm linknpm loginnpm logoutnpm lsnpm orgnpm outdatednpm ownernpm packnpm pingnpm pkgnpm prefixnpm profilenpm prunenpm publishnpm querynpm rebuildnpm reponpm restartnpm rootnpm run-scriptnpm searchnpm shrinkwrapnpm starnpm starsnpm startnpm stopnpm teamnpm testnpm tokennpm uninstallnpm unpublishnpm unstarnpm updatenpm versionnpm viewnpm whoaminpx
npm-adduser
Add a registry user accountTable of contents
Table of contents
Synopsis
npm adduseralias: add-user
Note: This command is unaware of workspaces.
Description
Create a new user in the specified registry, and save the credentials to
the .npmrc
file. If no registry is specified, the default registry
will be used (see registry
).
When using legacy
for your auth-type
, the username, password, and
email are read in from prompts.
Configuration
registry
- Default: "https://registry.npmjs.org/"
- Type: URL
The base URL of the npm registry.
scope
- Default: the scope of the current project, if any, or ""
- Type: String
Associate an operation with a scope for a scoped registry.
Useful when logging in to or out of a private registry:
# log in, linking the scope to the custom registrynpm login --scope=@mycorp --registry=https://registry.mycorp.com# log out, removing the link and the auth tokennpm logout --scope=@mycorp
This will cause @mycorp
to be mapped to the registry for future
installation of packages specified according to the pattern
@mycorp/package
.
This will also cause npm init
to create a scoped package.
# accept all defaults, and create a package named "@foo/whatever",# instead of just named "whatever"npm init --scope=@foo --yes
auth-type
- Default: "web"
- Type: "legacy" or "web"
What authentication strategy to use with login
.