deps/npm/html/doc/cli/npm-link.html

   1 <!doctype html>
   2 <html>
   3   <title>npm-link</title>
   4   <meta http-equiv="content-type" value="text/html;utf-8">
   5   <link rel="stylesheet" type="text/css" href="../../static/style.css">
   6   <link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-link.html">
   7   <script async=true src="../../static/toc.js"></script>
   8
   9   <body>
  10     <div id="wrapper">
  11
  12 <h1><a href="../cli/npm-link.html">npm-link</a></h1> <p>Symlink a package folder</p>
  13 <h2 id="synopsis">SYNOPSIS</h2>
  14 <pre><code>npm link (in package folder)
  15 npm link [@&lt;scope&gt;/]&lt;pkgname&gt;
  16 npm ln (with any of the previous argument usage)
  17 </code></pre><h2 id="description">DESCRIPTION</h2>
  18 <p>Package linking is a two-step process.</p>
  19 <p>First, <code>npm link</code> in a package folder will create a globally-installed
  20 symbolic link from <code>prefix/package-name</code> to the current folder (see
  21 <code><a href="../misc/npm-config.html"><a href="../misc/npm-config.html">npm-config(7)</a></a></code> for the value of <code>prefix</code>).</p>
  22 <p>Next, in some other location, <code>npm link package-name</code> will create a
  23 symlink from the local <code>node_modules</code> folder to the global symlink.</p>
  24 <p>Note that <code>package-name</code> is taken from <code>package.json</code>,
  25 not from directory name.</p>
  26 <p>The package name can be optionally prefixed with a scope. See <code><a href="../misc/npm-scope.html"><a href="../misc/npm-scope.html">npm-scope(7)</a></a></code>.
  27 The scope must be preceded by an @-symbol and followed by a slash.</p>
  28 <p>When creating tarballs for <code>npm publish</code>, the linked packages are
  29 &quot;snapshotted&quot; to their current state by resolving the symbolic links.</p>
  30 <p>This is handy for installing your own stuff, so that you can work on it and
  31 test it iteratively without having to continually rebuild.</p>
  32 <p>For example:</p>
  33 <pre><code>cd ~/projects/node-redis    # go into the package directory
  34 npm link                    # creates global link
  35 cd ~/projects/node-bloggy   # go into some other package directory.
  36 npm link redis              # link-install the package
  37 </code></pre><p>Now, any changes to ~/projects/node-redis will be reflected in
  38 ~/projects/node-bloggy/node_modules/node-redis/. Note that the link should
  39 be to the package name, not the directory name for that package. </p>
  40 <p>You may also shortcut the two steps in one.  For example, to do the
  41 above use-case in a shorter way:</p>
  42 <pre><code>cd ~/projects/node-bloggy  # go into the dir of your main project
  43 npm link ../node-redis     # link the dir of your dependency
  44 </code></pre><p>The second line is the equivalent of doing:</p>
  45 <pre><code>(cd ../node-redis; npm link)
  46 npm link node-redis
  47 </code></pre><p>That is, it first creates a global link, and then links the global
  48 installation target into your project&#39;s <code>node_modules</code> folder.</p>
  49 <p>If your linked package is scoped (see <code><a href="../misc/npm-scope.html"><a href="../misc/npm-scope.html">npm-scope(7)</a></a></code>) your link command must
  50 include that scope, e.g.</p>
  51 <pre><code>npm link @myorg/privatepackage
  52 </code></pre><h2 id="see-also">SEE ALSO</h2>
  53 <ul>
  54 <li><a href="../misc/npm-developers.html"><a href="../misc/npm-developers.html">npm-developers(7)</a></a></li>
  55 <li><a href="../misc/npm-faq.html"><a href="../misc/npm-faq.html">npm-faq(7)</a></a></li>
  56 <li><a href="../files/package.json.html"><a href="../files/package.json.html">package.json(5)</a></a></li>
  57 <li><a href="../cli/npm-install.html"><a href="../cli/npm-install.html">npm-install(1)</a></a></li>
  58 <li><a href="../files/npm-folders.html"><a href="../files/npm-folders.html">npm-folders(5)</a></a></li>
  59 <li><a href="../cli/npm-config.html"><a href="../cli/npm-config.html">npm-config(1)</a></a></li>
  60 <li><a href="../misc/npm-config.html"><a href="../misc/npm-config.html">npm-config(7)</a></a></li>
  61 <li><a href="../files/npmrc.html"><a href="../files/npmrc.html">npmrc(5)</a></a></li>
  62 </ul>
  63
  64 </div>
  65
  66 <table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
  67 <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18>&nbsp;</td></tr>
  68 <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>
  69 <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>
  70 <tr><td style="width:10px;height:10px;background:#fff" rowspan=2>&nbsp;</td></tr>
  71 <tr><td style="width:10px;height:10px;background:#fff">&nbsp;</td></tr>
  72 <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>
  73 <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>
  74 </table>
  75 <p id="footer">npm-link &mdash; npm@2.10.1</p>
  76