Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: b51e5a0ee2
Fetching contributors…

Cannot retrieve contributors at this time

236 lines (234 sloc) 4.878 kb
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-INSTALL" "1" "January 2011" "" ""
.
.SH "NAME"
\fBnpm-install\fR \-\- install a package
.
.SH "SYNOPSIS"
.
.nf
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\. 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<name>\fR:
Do a \fB<name>@<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<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
.
.SH "CONFIGURATION"
.
.SS "root"
Default: \fB$INSTALL_PREFIX/lib/node\fR
.
.P
The root folder where packages are installed and npm keeps its data\.
.
.SS "binroot"
Default: \fB$INSTALL_PREFIX/bin\fR
.
.P
The folder where executable programs are installed\.
.
.P
Set to "false" to not install executables
.
.SS "manroot"
Default: $INSTALL_PREFIX/share/man
.
.P
The folder where man pages are installed\.
.
.P
Set to "false" to not install man pages\.
.
.SS "registry"
Default: https://registry\.npmjs\.org/
.
.P
The base URL of the npm package registry\.
.
.SS "tag"
Default: latest
.
.P
If you ask npm to install a package and don\'t tell it a specific version, then
it will install the specified tag\.
.
.P
Note: this has no effect on the npm\-tag(1) command\.
.
.SS "dev"
If set to a truish value, then it\'ll install the "devDependencies" as well as
"dependencies" when installing a package\.
.
.P
Note that devDependencies are \fIalways\fR installed when linking a package\.
.
.SS "tar"
Default: env\.TAR or "tar"
.
.P
The name of a GNU\-compatible tar program on your system\.
.
.SS "gzip"
Default: env\.GZIPBIN or "gzip"
.
.P
The name of a GNU\-compatible gzip program on your system\.
.
.SS "must\-install"
Default: true
.
.P
Set to false to not install over packages that already exist\. By
default, \fBnpm install foo\fR will fetch and install the latest version of \fBfoo\fR, even if it matches a version already installed\.
.
.SS "auto\-activate"
Default: true
.
.P
Automatically activate a package after installation, if there is not an active
version already\. Set to "always" to always activate when installing\.
.
.SS "update\-dependents"
Default: true
.
.P
Automatically update a package\'s dependencies after installation, if it is the
newest version installed\. Set to "always" to update dependents when a new
version is installed, even if it\'s not the newest\.
.
.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
Jump to Line
Something went wrong with that request. Please try again.