| .TH "NPM\-DIST\-TAG" "1" "June 2016" "" "" |
| .SH "NAME" |
| \fBnpm-dist-tag\fR \- Modify package distribution tags |
| .SH SYNOPSIS |
| .P |
| .RS 2 |
| .nf |
| npm dist\-tag add <pkg>@<version> [<tag>] |
| npm dist\-tag rm <pkg> <tag> |
| npm dist\-tag ls [<pkg>] |
| |
| aliases: dist\-tags |
| .fi |
| .RE |
| .SH DESCRIPTION |
| .P |
| Add, remove, and enumerate distribution tags on a package: |
| .RS 0 |
| .IP \(bu 2 |
| add: |
| Tags the specified version of the package with the specified tag, or the |
| \fB\-\-tag\fP config if not specified\. |
| .IP \(bu 2 |
| rm: |
| Clear a tag that is no longer in use from the package\. |
| .IP \(bu 2 |
| ls: |
| Show all of the dist\-tags for a package, defaulting to the package in |
| the current prefix\. |
| |
| .RE |
| .P |
| A tag can be used when installing packages as a reference to a version instead |
| of using a specific version number: |
| .P |
| .RS 2 |
| .nf |
| npm install <name>@<tag> |
| .fi |
| .RE |
| .P |
| When installing dependencies, a preferred tagged version may be specified: |
| .P |
| .RS 2 |
| .nf |
| npm install \-\-tag <tag> |
| .fi |
| .RE |
| .P |
| This also applies to \fBnpm dedupe\fP\|\. |
| .P |
| Publishing a package sets the \fBlatest\fP tag to the published version unless the |
| \fB\-\-tag\fP option is used\. For example, \fBnpm publish \-\-tag=beta\fP\|\. |
| .P |
| By default, \fBnpm install <pkg>\fP (without any \fB@<version>\fP or \fB@<tag>\fP |
| specifier) installs the \fBlatest\fP tag\. |
| .SH PURPOSE |
| .P |
| Tags can be used to provide an alias instead of version numbers\. |
| .P |
| For example, a project might choose to have multiple streams of development |
| and use a different tag for each stream, |
| e\.g\., \fBstable\fP, \fBbeta\fP, \fBdev\fP, \fBcanary\fP\|\. |
| .P |
| By default, the \fBlatest\fP tag is used by npm to identify the current version of |
| a package, and \fBnpm install <pkg>\fP (without any \fB@<version>\fP or \fB@<tag>\fP |
| specifier) installs the \fBlatest\fP tag\. Typically, projects only use the \fBlatest\fP |
| tag for stable release versions, and use other tags for unstable versions such |
| as prereleases\. |
| .P |
| The \fBnext\fP tag is used by some projects to identify the upcoming version\. |
| .P |
| By default, other than \fBlatest\fP, no tag has any special significance to npm |
| itself\. |
| .SH CAVEATS |
| .P |
| This command used to be known as \fBnpm tag\fP, which only created new tags, and so |
| had a different syntax\. |
| .P |
| Tags must share a namespace with version numbers, because they are specified in |
| the same slot: \fBnpm install <pkg>@<version>\fP vs \fBnpm install <pkg>@<tag>\fP\|\. |
| .P |
| Tags that can be interpreted as valid semver ranges will be rejected\. For |
| example, \fBv1\.4\fP cannot be used as a tag, because it is interpreted by semver as |
| \fB>=1\.4\.0 <1\.5\.0\fP\|\. See https://github\.com/npm/npm/issues/6082\|\. |
| .P |
| The simplest way to avoid semver problems with tags is to use tags that do not |
| begin with a number or the letter \fBv\fP\|\. |
| .SH SEE ALSO |
| .RS 0 |
| .IP \(bu 2 |
| npm help tag |
| .IP \(bu 2 |
| npm help publish |
| .IP \(bu 2 |
| npm help install |
| .IP \(bu 2 |
| npm help dedupe |
| .IP \(bu 2 |
| npm help 7 registry |
| .IP \(bu 2 |
| npm help config |
| .IP \(bu 2 |
| npm help 7 config |
| .IP \(bu 2 |
| npm help 5 npmrc |
| |
| .RE |
| |