This repository has been archived by the owner on Aug 11, 2022. It is now read-only.
/
install.1
140 lines (139 loc) · 2.75 KB
/
install.1
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-INSTALL" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-install\fR \-\- install a package
.
.SH "SYNOPSIS"
.
.nf
npm install <tarball file>
npm install <tarball url>
npm install <folder>
npm install <pkg>
npm install <pkg>@<tag>
npm install <pkg>@<version>
npm install <pkg>@<version range>
.
.fi
.
.SH "DESCRIPTION"
This command installs a package, and any packages that it depends on\. It
resolves circular dependencies by talking to the npm registry\.
.
.IP "\(bu" 4
npm install \fB<tarball file>\fR:
Install a package that is sitting on the filesystem\. Note: if you just want
to link a dev directory into your npm root, you can do this more easily by
using \fBnpm link\fR\|\.
.
.IP
In order to distinguish between this and remote installs, the argument
must either be "\." or contain a "/" in it\.
.
.IP
Example:
.
.IP
npm install \./package\.tgz
.
.IP "\(bu" 4
npm install \fB<tarball url>\fR:
Fetch the tarball url, and then install it\. In order to distinguish between
this and other options, the argument must start with "http://" or "https://"
.
.IP
Example:
.
.IP
npm install http://github\.com/waveto/node\-crypto/tarball/v0\.0\.5
.
.IP "\(bu" 4
npm install \fB<pkg>\fR:
Do a \fB<pkg>@<tag>\fR install, where \fB<tag>\fR is the "tag" config from either your
\|\.npmrc file, or the \-\-tag argument on the command line\.
.
.IP
Example:
.
.IP
npm install sax
.
.IP "\(bu" 4
npm install \fB<pkg>@<tag>\fR:
Install the version of the package that is referenced by the specified tag\.
If the tag does not exist in the registry data for that package, then this
will fail\.
.
.IP
Example:
.
.IP
npm install sax@stable
.
.IP "\(bu" 4
npm install \fB<pkg>@<version>\fR:
Install the specified version of the package\. This will fail if the version
has not been published to the registry\.
.
.IP
Example:
.
.IP
npm install sax@0\.1\.1
.
.IP "\(bu" 4
npm install \fB<pkg>@<version range>\fR:
Install a version of the package matching the specified version range\. This
will follow the same rules for resolving dependencies described in \fBnpm help json\fR\|\.
.
.IP
Note that most version ranges must be put in quotes so that your shell will
treat it as a single argument\.
.
.IP
Example:
.
.IP
npm install sax@">=0\.1\.0 <0\.2\.0"
.
.IP "" 0
.
.P
You may combine multiple arguments, and even multiple types of arguments\. For example:
.
.IP "" 4
.
.nf
npm install sax@">=0\.1\.0 <0\.2\.0" bench supervisor
.
.fi
.
.IP "" 0
.
.P
The \fB\-\-tag\fR argument will apply to all of the specified install targets\.
.
.SH "SEE ALSO"
.
.IP "\(bu" 4
npm\-build(1)
.
.IP "\(bu" 4
npm\-registry(1)
.
.IP "\(bu" 4
npm\-build(1)
.
.IP "\(bu" 4
npm\-link(1)
.
.IP "\(bu" 4
npm\-folders(1)
.
.IP "\(bu" 4
npm\-tag(1)
.
.IP "" 0