-
Notifications
You must be signed in to change notification settings - Fork 0
/
install.1
199 lines (198 loc) · 4.05 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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-INSTALL" "1" "May 2011" "" ""
.
.SH "NAME"
\fBnpm-install\fR \-\- install a package
.
.SH "SYNOPSIS"
.
.nf
npm install (with no args in a package dir)
npm install <tarball file>
npm install <tarball url>
npm install <folder>
npm install <name>
npm install <name>@<tag>
npm install <name>@<version>
npm install <name>@<version range>
.
.fi
.
.SH "DESCRIPTION"
This command installs a package, and any packages that it depends on\.
.
.P
A \fBpackage\fR is:
.
.IP "\(bu" 4
a) a folder containing a program described by a package\.json file
.
.IP "\(bu" 4
b) a gzipped tarball containing (a)
.
.IP "\(bu" 4
c) a url that resolves to (b)
.
.IP "\(bu" 4
d) a \fB<name>@<version>\fR that is published on the registry with (c)
.
.IP "\(bu" 4
e) a \fB<name>@<tag>\fR that points to (d)
.
.IP "\(bu" 4
f) a \fB<name>\fR that has a "latest" tag satisfying (e)
.
.IP "" 0
.
.P
Even if you never publish your package, you can still get a lot of
benefits of using npm if you just want to write a node program (a), and
perhaps if you also want to be able to easily install it elsewhere
after packing it up into a tarball (b)\.
.
.IP "\(bu" 4
npm install (in package directory, no arguments):
Install the dependencies in the local node_modules folder\.
.
.IP
In global mode (ie, with \fB\-g\fR or \fB\-\-global\fR appended to the command),
it installs the current package context (ie, the current working
directory) as a global package\.
.
.IP "\(bu" 4
npm install \fB<folder>\fR:
Install a package that is sitting in a folder on the filesystem\.
.
.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<name>\fR:
Do a \fB<name>@<tag>\fR install, where \fB<tag>\fR is the "tag" config\. (See \fBnpm help config\fR)
.
.IP
Example:
.
.IP
npm install sax
.
.IP "\(bu" 4
npm install \fB<name>@<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<name>@<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<name>@<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\.
.
.P
The \fB\-\-force\fR argument will force npm to fetch remote resources even if a
local copy exists on disk\.
.
.IP "" 4
.
.nf
npm install sax \-\-force
.
.fi
.
.IP "" 0
.
.P
The \fB\-\-global\fR argument will cause npm to install the package globally
rather than locally\. See \fBnpm help global\fR\|\.
.
.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