Fincer
/
simple-email

<!doctype html><html>  <title>npm-install</title>  <meta charset="utf-8">  <link rel="stylesheet" type="text/css" href="../../static/style.css">  <link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-install.html">  <script async=true src="../../static/toc.js"></script>
  <body>    <div id="wrapper">
<h1><a href="../cli/npm-install.html">npm-install</a></h1> <p>Install a package</p><h2 id="synopsis">SYNOPSIS</h2><pre><code>npm install (with no args, in package dir)npm install [&lt;@scope&gt;/]&lt;name&gt;npm install [&lt;@scope&gt;/]&lt;name&gt;@&lt;tag&gt;npm install [&lt;@scope&gt;/]&lt;name&gt;@&lt;version&gt;npm install [&lt;@scope&gt;/]&lt;name&gt;@&lt;version range&gt;npm install &lt;git-host&gt;:&lt;git-user&gt;/&lt;repo-name&gt;npm install &lt;git repo url&gt;npm install &lt;tarball file&gt;npm install &lt;tarball url&gt;npm install &lt;folder&gt;
alias: npm icommon options: [-P|--save-prod|-D|--save-dev|-O|--save-optional] [-E|--save-exact] [-B|--save-bundle] [--no-save] [--dry-run]</code></pre><h2 id="description">DESCRIPTION</h2><p>This command installs a package, and any packages that it depends on. If thepackage has a package-lock or shrinkwrap file, the installation of dependencieswill be driven by that, with an <code>npm-shrinkwrap.json</code> taking precedence if bothfiles exist. See <a href="../files/package-lock.json.html">package-lock.json(5)</a> and <a href="../cli/npm-shrinkwrap.html">npm-shrinkwrap(1)</a>.</p><p>A <code>package</code> is:</p><ul><li>a) a folder containing a program described by a <code><a href="../files/package.json.html">package.json(5)</a></code> file</li><li>b) a gzipped tarball containing (a)</li><li>c) a url that resolves to (b)</li><li>d) a <code>&lt;name&gt;@&lt;version&gt;</code> that is published on the registry (see <code><a href="../misc/npm-registry.html">npm-registry(7)</a></code>) with (c)</li><li>e) a <code>&lt;name&gt;@&lt;tag&gt;</code> (see <code><a href="../cli/npm-dist-tag.html">npm-dist-tag(1)</a></code>) that points to (d)</li><li>f) a <code>&lt;name&gt;</code> that has a &quot;latest&quot; tag satisfying (e)</li><li>g) a <code>&lt;git remote url&gt;</code> that resolves to (a)</li></ul><p>Even if you never publish your package, you can still get a lot ofbenefits of using npm if you just want to write a node program (a), andperhaps if you also want to be able to easily install it elsewhereafter packing it up into a tarball (b).</p><ul><li><p><code>npm install</code> (in package directory, no arguments):</p><p>  Install the dependencies in the local node_modules folder.</p><p>  In global mode (ie, with <code>-g</code> or <code>--global</code> appended to the command),  it installs the current package context (ie, the current working  directory) as a global package.</p><p>  By default, <code>npm install</code> will install all modules listed as dependencies  in <code><a href="../files/package.json.html">package.json(5)</a></code>.</p><p>  With the <code>--production</code> flag (or when the <code>NODE_ENV</code> environment variable  is set to <code>production</code>), npm will not install modules listed in  <code>devDependencies</code>.</p><blockquote><p>NOTE: The <code>--production</code> flag has no particular meaning when adding a  dependency to a project.</p></blockquote></li><li><p><code>npm install &lt;folder&gt;</code>:</p><p>  Install the package in the directory as a symlink in the current project.  Its dependencies will be installed before it&#39;s linked. If <code>&lt;folder&gt;</code> sits  inside the root of your project, its dependencies may be hoisted to the  toplevel <code>node_modules</code> as they would for other types of dependencies.</p></li><li><p><code>npm install &lt;tarball file&gt;</code>:</p><p>  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 <code>npm link</code>.</p><p>  Tarball requirements:</p><ul><li><p>The filename <em>must</em> use <code>.tar</code>, <code>.tar.gz</code>, or <code>.tgz</code> asthe extension.</p></li><li><p>The package contents should reside in a subfolder inside the tarball (usually it is called <code>package/</code>). npm strips one directory layer when installing the package (an equivalent of <code>tar x --strip-components=1</code> is run).</p></li><li><p>The package must contain a <code>package.json</code> file with <code>name</code> and <code>version</code> properties.</p><p>Example:</p><pre><code>npm install ./package.tgz</code></pre></li></ul></li><li><p><code>npm install &lt;tarball url&gt;</code>:</p><p>  Fetch the tarball url, and then install it.  In order to distinguish between  this and other options, the argument must start with &quot;http://&quot; or &quot;https://&quot;</p><p>  Example:</p><pre><code>    npm install https://github.com/indexzero/forever/tarball/v0.5.6</code></pre></li><li><p><code>npm install [&lt;@scope&gt;/]&lt;name&gt;</code>:</p><p>  Do a <code>&lt;name&gt;@&lt;tag&gt;</code> install, where <code>&lt;tag&gt;</code> is the &quot;tag&quot; config. (See  <code><a href="../misc/npm-config.html">npm-config(7)</a></code>. The config&#39;s default value is <code>latest</code>.)</p><p>  In most cases, this will install the version of the modules tagged as  <code>latest</code> on the npm registry.</p><p>  Example:</p><pre><code>    npm install sax</code></pre><p>  <code>npm install</code> saves any specified packages into <code>dependencies</code> by default.  Additionally, you can control where and how they get saved with some  additional flags:</p><ul><li><p><code>-P, --save-prod</code>: Package will appear in your <code>dependencies</code>. This is the</p><pre><code>               default unless `-D` or `-O` are present.</code></pre></li><li><p><code>-D, --save-dev</code>: Package will appear in your <code>devDependencies</code>.</p></li><li><p><code>-O, --save-optional</code>: Package will appear in your <code>optionalDependencies</code>.</p></li><li><p><code>--no-save</code>: Prevents saving to <code>dependencies</code>.</p><p>When using any of the above options to save dependencies to yourpackage.json, there are two additional, optional flags:</p></li><li><p><code>-E, --save-exact</code>: Saved dependencies will be configured with anexact version rather than using npm&#39;s default semver rangeoperator.</p></li><li><p><code>-B, --save-bundle</code>: Saved dependencies will also be added to your <code>bundleDependencies</code> list.</p><p>Further, if you have an <code>npm-shrinkwrap.json</code> or <code>package-lock.json</code> then itwill be updated as well.</p><p><code>&lt;scope&gt;</code> is optional. The package will be downloaded from the registryassociated with the specified scope. If no registry is associated withthe given scope the default registry is assumed. See <code><a href="../misc/npm-scope.html">npm-scope(7)</a></code>.</p><p>Note: if you do not include the @-symbol on your scope name, npm willinterpret this as a GitHub repository instead, see below. Scopes namesmust also be followed by a slash.</p><p>Examples:</p><pre><code>npm install saxnpm install githubname/reponamenpm install @myorg/privatepackagenpm install node-tap --save-devnpm install dtrace-provider --save-optionalnpm install readable-stream --save-exactnpm install ansi-regex --save-bundle</code></pre></li></ul></li></ul><pre><code>**Note**: If there is a file or folder named `&lt;name&gt;` in the currentworking directory, then it will try to install that, and only try tofetch the package by name if it is not valid.</code></pre><ul><li><p><code>npm install [&lt;@scope&gt;/]&lt;name&gt;@&lt;tag&gt;</code>:</p><p>  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.</p><p>  Example:</p><pre><code>    npm install sax@latest    npm install @myorg/mypackage@latest</code></pre></li><li><p><code>npm install [&lt;@scope&gt;/]&lt;name&gt;@&lt;version&gt;</code>:</p><p>  Install the specified version of the package.  This will fail if the  version has not been published to the registry.</p><p>  Example:</p><pre><code>    npm install sax@0.1.1    npm install @myorg/privatepackage@1.5.0</code></pre></li><li><p><code>npm install [&lt;@scope&gt;/]&lt;name&gt;@&lt;version range&gt;</code>:</p><p>  Install a version of the package matching the specified version range.  This  will follow the same rules for resolving dependencies described in <code><a href="../files/package.json.html">package.json(5)</a></code>.</p><p>  Note that most version ranges must be put in quotes so that your shell will  treat it as a single argument.</p><p>  Example:</p><pre><code>    npm install sax@&quot;&gt;=0.1.0 &lt;0.2.0&quot;    npm install @myorg/privatepackage@&quot;&gt;=0.1.0 &lt;0.2.0&quot;</code></pre></li><li><p><code>npm install &lt;git remote url&gt;</code>:</p><p>  Installs the package from the hosted git provider, cloning it with <code>git</code>.  For a full git remote url, only that URL will be attempted.</p><pre><code>    &lt;protocol&gt;://[&lt;user&gt;[:&lt;password&gt;]@]&lt;hostname&gt;[:&lt;port&gt;][:][/]&lt;path&gt;[#&lt;commit-ish&gt; | #semver:&lt;semver&gt;]</code></pre><p>  <code>&lt;protocol&gt;</code> is one of <code>git</code>, <code>git+ssh</code>, <code>git+http</code>, <code>git+https</code>, or  <code>git+file</code>.</p><p>  If <code>#&lt;commit-ish&gt;</code> is provided, it will be used to clone exactly that  commit. If the commit-ish has the format <code>#semver:&lt;semver&gt;</code>, <code>&lt;semver&gt;</code> can  be any valid semver range or exact version, and npm will look for any tags  or refs matching that range in the remote repository, much as it would for a  registry dependency. If neither <code>#&lt;commit-ish&gt;</code> or <code>#semver:&lt;semver&gt;</code> is  specified, then <code>master</code> is used.</p><p>  If the repository makes use of submodules, those submodules will be cloned  as well.</p><p>  If the package being installed contains a <code>prepare</code> script, its  <code>dependencies</code> and <code>devDependencies</code> will be installed, and the prepare  script will be run, before the package is packaged and installed.</p><p>  The following git environment variables are recognized by npm and will be  added to the environment when running git:</p><ul><li><p><code>GIT_ASKPASS</code></p></li><li><p><code>GIT_EXEC_PATH</code></p></li><li><p><code>GIT_PROXY_COMMAND</code></p></li><li><p><code>GIT_SSH</code></p></li><li><p><code>GIT_SSH_COMMAND</code></p></li><li><p><code>GIT_SSL_CAINFO</code></p></li><li><p><code>GIT_SSL_NO_VERIFY</code></p><p>See the git man page for details.</p><p>Examples:</p><pre><code>npm install git+ssh://git@github.com:npm/cli.git#v1.0.27npm install git+ssh://git@github.com:npm/cli#semver:^5.0npm install git+https://isaacs@github.com/npm/cli.gitnpm install git://github.com/npm/cli.git#v1.0.27GIT_SSH_COMMAND=&#39;ssh -i ~/.ssh/custom_ident&#39; npm install git+ssh://git@github.com:npm/cli.git</code></pre></li></ul></li><li><p><code>npm install &lt;githubname&gt;/&lt;githubrepo&gt;[#&lt;commit-ish&gt;]</code>:</p></li><li><p><code>npm install github:&lt;githubname&gt;/&lt;githubrepo&gt;[#&lt;commit-ish&gt;]</code>:</p><p>  Install the package at <code>https://github.com/githubname/githubrepo</code> by  attempting to clone it using <code>git</code>.</p><p>  If <code>#&lt;commit-ish&gt;</code> is provided, it will be used to clone exactly that  commit. If the commit-ish has the format <code>#semver:&lt;semver&gt;</code>, <code>&lt;semver&gt;</code> can  be any valid semver range or exact version, and npm will look for any tags  or refs matching that range in the remote repository, much as it would for a  registry dependency. If neither <code>#&lt;commit-ish&gt;</code> or <code>#semver:&lt;semver&gt;</code> is  specified, then <code>master</code> is used.</p><p>  As with regular git dependencies, <code>dependencies</code> and <code>devDependencies</code> will  be installed if the package has a <code>prepare</code> script, before the package is  done installing.</p><p>  Examples:</p><pre><code>    npm install mygithubuser/myproject    npm install github:mygithubuser/myproject</code></pre></li><li><p><code>npm install gist:[&lt;githubname&gt;/]&lt;gistID&gt;[#&lt;commit-ish&gt;|#semver:&lt;semver&gt;]</code>:</p><p>  Install the package at <code>https://gist.github.com/gistID</code> by attempting to  clone it using <code>git</code>. The GitHub username associated with the gist is  optional and will not be saved in <code>package.json</code>.</p><p>  As with regular git dependencies, <code>dependencies</code> and <code>devDependencies</code> will  be installed if the package has a <code>prepare</code> script, before the package is  done installing.</p><p>  Example:</p><pre><code>    npm install gist:101a11beef</code></pre></li><li><p><code>npm install bitbucket:&lt;bitbucketname&gt;/&lt;bitbucketrepo&gt;[#&lt;commit-ish&gt;]</code>:</p><p>  Install the package at <code>https://bitbucket.org/bitbucketname/bitbucketrepo</code>  by attempting to clone it using <code>git</code>.</p><p>  If <code>#&lt;commit-ish&gt;</code> is provided, it will be used to clone exactly that  commit. If the commit-ish has the format <code>#semver:&lt;semver&gt;</code>, <code>&lt;semver&gt;</code> can  be any valid semver range or exact version, and npm will look for any tags  or refs matching that range in the remote repository, much as it would for a  registry dependency. If neither <code>#&lt;commit-ish&gt;</code> or <code>#semver:&lt;semver&gt;</code> is  specified, then <code>master</code> is used.</p><p>  As with regular git dependencies, <code>dependencies</code> and <code>devDependencies</code> will  be installed if the package has a <code>prepare</code> script, before the package is  done installing.</p><p>  Example:</p><pre><code>    npm install bitbucket:mybitbucketuser/myproject</code></pre></li><li><p><code>npm install gitlab:&lt;gitlabname&gt;/&lt;gitlabrepo&gt;[#&lt;commit-ish&gt;]</code>:</p><p>  Install the package at <code>https://gitlab.com/gitlabname/gitlabrepo</code>  by attempting to clone it using <code>git</code>.</p><p>  If <code>#&lt;commit-ish&gt;</code> is provided, it will be used to clone exactly that  commit. If the commit-ish has the format <code>#semver:&lt;semver&gt;</code>, <code>&lt;semver&gt;</code> can  be any valid semver range or exact version, and npm will look for any tags  or refs matching that range in the remote repository, much as it would for a  registry dependency. If neither <code>#&lt;commit-ish&gt;</code> or <code>#semver:&lt;semver&gt;</code> is  specified, then <code>master</code> is used.</p><p>  As with regular git dependencies, <code>dependencies</code> and <code>devDependencies</code> will  be installed if the package has a <code>prepare</code> script, before the package is  done installing.</p><p>  Example:</p><pre><code>    npm install gitlab:mygitlabuser/myproject    npm install gitlab:myusr/myproj#semver:^5.0</code></pre></li></ul><p>You may combine multiple arguments, and even multiple types of arguments.For example:</p><pre><code>npm install sax@&quot;&gt;=0.1.0 &lt;0.2.0&quot; bench supervisor</code></pre><p>The <code>--tag</code> argument will apply to all of the specified install targets. If atag with the given name exists, the tagged version is preferred over newerversions.</p><p>The <code>--dry-run</code> argument will report in the usual way what the install wouldhave done without actually installing anything.</p><p>The <code>--package-lock-only</code> argument will only update the <code>package-lock.json</code>,instead of checking <code>node_modules</code> and downloading dependencies.</p><p>The <code>-f</code> or <code>--force</code> argument will force npm to fetch remote resources even if alocal copy exists on disk.</p><pre><code>npm install sax --force</code></pre><p>The <code>-g</code> or <code>--global</code> argument will cause npm to install the package globallyrather than locally.  See <code><a href="../files/npm-folders.html">npm-folders(5)</a></code>.</p><p>The <code>--global-style</code> argument will cause npm to install the package intoyour local <code>node_modules</code> folder with the same layout it uses with theglobal <code>node_modules</code> folder. Only your direct dependencies will show in<code>node_modules</code> and everything they depend on will be flattened in their<code>node_modules</code> folders. This obviously will eliminate some deduping.</p><p>The <code>--ignore-scripts</code> argument will cause npm to not execute anyscripts defined in the package.json. See <code><a href="../misc/npm-scripts.html">npm-scripts(7)</a></code>.</p><p>The <code>--legacy-bundling</code> argument will cause npm to install the package suchthat versions of npm prior to 1.4, such as the one included with node 0.8,can install the package. This eliminates all automatic deduping.</p><p>The <code>--link</code> argument will cause npm to link global installs into thelocal space in some cases.</p><p>The <code>--no-bin-links</code> argument will prevent npm from creating symlinks forany binaries the package might contain.</p><p>The <code>--no-optional</code> argument will prevent optional dependencies frombeing installed.</p><p>The <code>--no-shrinkwrap</code> argument, which will ignore an availablepackage lock or shrinkwrap file and use the package.json instead.</p><p>The <code>--no-package-lock</code> argument will prevent npm from creating a<code>package-lock.json</code> file.  When running with package-lock&#39;s disabled npmwill not automatically prune your node modules when installing.</p><p>The <code>--nodedir=/path/to/node/source</code> argument will allow npm to find thenode source code so that npm can compile native modules.</p><p>The <code>--only={prod[uction]|dev[elopment]}</code> argument will cause either only<code>devDependencies</code> or only non-<code>devDependencies</code> to be installed regardless of the <code>NODE_ENV</code>.</p><p>The <code>--no-audit</code> argument can be used to disable sending of audit reports tothe configured registries.  See <code><a href="../cli/npm-audit.html">npm-audit(1)</a></code> for details on what is sent.</p><p>See <code><a href="../misc/npm-config.html">npm-config(7)</a></code>.  Many of the configuration params have someeffect on installation, since that&#39;s most of what npm does.</p><h2 id="algorithm">ALGORITHM</h2><p>To install a package, npm uses the following algorithm:</p><pre><code>load the existing node_modules tree from diskclone the treefetch the package.json and assorted metadata and add it to the clonewalk the clone and add any missing dependencies  dependencies will be added as close to the top as is possible  without breaking any other modulescompare the original tree with the cloned tree and make a list ofactions to take to convert one to the otherexecute all of the actions, deepest first  kinds of actions are install, update, remove and move</code></pre><p>For this <code>package{dep}</code> structure: <code>A{B,C}, B{C}, C{D}</code>,this algorithm produces:</p><pre><code>A+-- B+-- C+-- D</code></pre><p>That is, the dependency from B to C is satisfied by the fact that Aalready caused C to be installed at a higher level. D is still installedat the top level because nothing conflicts with it.</p><p>For <code>A{B,C}, B{C,D@1}, C{D@2}</code>, this algorithm produces:</p><pre><code>A+-- B+-- C   `-- D@2+-- D@1</code></pre><p>Because B&#39;s D@1 will be installed in the top level, C now has to install D@2privately for itself. This algorithm is deterministic, but different trees maybe produced if two dependencies are requested for installation in a differentorder.</p><p>See <a href="../files/npm-folders.html">npm-folders(5)</a> for a more detailed description of the specificfolder structures that npm creates.</p><h3 id="limitations-of-npm-s-install-algorithm">Limitations of npm&#39;s Install Algorithm</h3><p>npm will refuse to install any package with an identical name to thecurrent package. This can be overridden with the <code>--force</code> flag, but inmost cases can simply be addressed by changing the local package name.</p><p>There are some very rare and pathological edge-cases where a cycle cancause npm to try to install a never-ending tree of packages.  Here isthe simplest case:</p><pre><code>A -&gt; B -&gt; A&#39; -&gt; B&#39; -&gt; A -&gt; B -&gt; A&#39; -&gt; B&#39; -&gt; A -&gt; ...</code></pre><p>where <code>A</code> is some version of a package, and <code>A&#39;</code> is a different versionof the same package.  Because <code>B</code> depends on a different version of <code>A</code>than the one that is already in the tree, it must install a separatecopy.  The same is true of <code>A&#39;</code>, which must install <code>B&#39;</code>.  Because <code>B&#39;</code>depends on the original version of <code>A</code>, which has been overridden, thecycle falls into infinite regress.</p><p>To avoid this situation, npm flat-out refuses to install any<code>name@version</code> that is already present anywhere in the tree of packagefolder ancestors.  A more correct, but more complex, solution would beto symlink the existing version into the new location.  If this everaffects a real use-case, it will be investigated.</p><h2 id="see-also">SEE ALSO</h2><ul><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-update.html">npm-update(1)</a></li><li><a href="../cli/npm-audit.html">npm-audit(1)</a></li><li><a href="../cli/npm-link.html">npm-link(1)</a></li><li><a href="../cli/npm-rebuild.html">npm-rebuild(1)</a></li><li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li><li><a href="../cli/npm-build.html">npm-build(1)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-dist-tag.html">npm-dist-tag(1)</a></li><li><a href="../cli/npm-uninstall.html">npm-uninstall(1)</a></li><li><a href="../cli/npm-shrinkwrap.html">npm-shrinkwrap(1)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo><tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18>&nbsp;</td></tr><tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td colspan=6 style="width:60px;height:10px;background:#fff">&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td></tr><tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2>&nbsp;</td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td></tr><tr><td style="width:10px;height:10px;background:#fff" rowspan=2>&nbsp;</td></tr><tr><td style="width:10px;height:10px;background:#fff">&nbsp;</td></tr><tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6>&nbsp;</td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td></tr><tr><td colspan=5 style="width:50px;height:10px;background:#fff">&nbsp;</td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4>&nbsp;</td><td style="width:90px;height:10px;background:#fff" colspan=9>&nbsp;</td></tr></table><p id="footer">npm-install &mdash; npm@6.4.1</p>