Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 59 lines (58 sloc) 1.595 kb
1a7ef77 isaacs Document the bundle command
isaacs authored
1 .\" Generated with Ronnjs/v0.1
2 .\" http://github.com/kapouer/ronnjs/
3 .
5c36150 isaacs make doc
isaacs authored
4 .TH "NPM\-BUNDLE" "1" "December 2010" "" ""
1a7ef77 isaacs Document the bundle command
isaacs authored
5 .
6 .SH "NAME"
7 \fBnpm-bundle\fR \-\- Bundle package dependencies
8 .
9 .SH "SYNOPSIS"
10 .
11 .nf
85b372b isaacs Add `bundle destroy`
isaacs authored
12 npm bundle
13 npm bundle destroy
14 npm bundle <cmd> <args>
1a7ef77 isaacs Document the bundle command
isaacs authored
15 .
16 .fi
17 .
ceb31e0 isaacs make doc
isaacs authored
18 .P
19 Run in a package folder\.
1a7ef77 isaacs Document the bundle command
isaacs authored
20 .
21 .SH "DESCRIPTION"
ceb31e0 isaacs make doc
isaacs authored
22 When run in a package folder, this command can be used to install
23 package dependencies into the \fBnode_modules\fR folder\.
1a7ef77 isaacs Document the bundle command
isaacs authored
24 .
25 .P
ceb31e0 isaacs make doc
isaacs authored
26 When the package is installed, it will read dependencies from the local
27 bundle \fIbefore\fR reading any dependencies that are already installed\.
1a7ef77 isaacs Document the bundle command
isaacs authored
28 .
29 .P
ceb31e0 isaacs make doc
isaacs authored
30 Furthermore, when installing, npm will not attempt to install
31 dependencies that already exist in the bundle\.
1a7ef77 isaacs Document the bundle command
isaacs authored
32 .
33 .P
fb80e0d isaacs Docs for bundle changes.
isaacs authored
34 To bundle all the dependencies of a given package, run \fBnpm bundle\fR
35 without any arguments\.
1a7ef77 isaacs Document the bundle command
isaacs authored
36 .
ceb31e0 isaacs make doc
isaacs authored
37 .P
85b372b isaacs Add `bundle destroy`
isaacs authored
38 To completely remove the bundle folder, run \fBnpm bundle destroy\fR\|\.
39 .
40 .P
fb80e0d isaacs Docs for bundle changes.
isaacs authored
41 To operate on the bundle packages, any npm command and arguments may be
42 passed to the \fBnpm bundle\fR command\. For example, to install a package
43 into the bundle, you can do \fBnpm bundle install express\fR\|\.
1a7ef77 isaacs Document the bundle command
isaacs authored
44 .
45 .P
c1791f4 isaacs make doc
isaacs authored
46 To list the packages in the bundle, do \fBnpm bundle ls\fR\|\. To remove bundled
47 packages, do \fBnpm bundle remove <whatever>\fR\|\. Et cetera\.
1a7ef77 isaacs Document the bundle command
isaacs authored
48 .
49 .P
fb80e0d isaacs Docs for bundle changes.
isaacs authored
50 In this way, a command like \fBnpm bundle install http://github\.com/user/project/tarball/master\fR can be used
51 to have a dependency that is not published on the npm registry\. (It still
52 must contain a package\.json, though, of course\.)
1a7ef77 isaacs Document the bundle command
isaacs authored
53 .
54 .SH "CAVEATS"
5c36150 isaacs make doc
isaacs authored
55 Man pages are not installed by bundle\.
56 .
57 .P
58 Bins are installed, but not globally\.
Something went wrong with that request. Please try again.