summaryrefslogtreecommitdiff
path: root/deps/npm/man/man1/npm-dist-tag.1
blob: 4c8e977ac5db7999d1228f29e8ac8e14014d4e59 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
.TH "NPM\-DIST\-TAG" "1" "June 2015" "" ""
.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>]
.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\fR 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\fR\|\.
.P
Publishing a package sets the "latest" tag to the published version unless the
\fB\-\-tag\fR option is used\. For example, \fBnpm publish \-\-tag=beta\fR\|\.
.SH PURPOSE
.P
Tags can be used to provide an alias instead of version numbers\.  For
example, \fBnpm\fR currently uses the tag "next" to identify the upcoming
version, and the tag "latest" to identify the current version\.
.P
A project might choose to have multiple streams of development, e\.g\.,
"stable", "canary"\.
.SH CAVEATS
.P
This command used to be known as \fBnpm tag\fR, 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>\fR vs \fBnpm install <pkg>@<tag>\fR\|\.
.P
Tags that can be interpreted as valid semver ranges will be rejected\. For
example, \fBv1\.4\fR cannot be used as a tag, because it is interpreted by semver as
\fB>=1\.4\.0 <1\.5\.0\fR\|\.  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\fR\|\.
.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 apihelp tag
.IP \(bu 2
npm help 5 npmrc

.RE