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 symlink in the global folder
  20 <code>{prefix}/lib/node_modules/&lt;package&gt;</code> that links to the package where the <code>npm
  21 link</code> command was executed. (see <code><a href="../misc/npm-config.html">npm-config(7)</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 symbolic link from globally-installed <code>package-name</code> to <code>node_modules/</code>
  24 of the current folder.</p>
  25 <p>Note that <code>package-name</code> is taken from <code>package.json</code>,
  26 not from directory name.</p>
  27 <p>The package name can be optionally prefixed with a scope. See <code><a href="../misc/npm-scope.html">npm-scope(7)</a></code>.
  28 The scope must be preceded by an @-symbol and followed by a slash.</p>
  29 <p>When creating tarballs for <code>npm publish</code>, the linked packages are
  30 &quot;snapshotted&quot; to their current state by resolving the symbolic links.</p>
  31 <p>This is handy for installing your own stuff, so that you can work on it and
  32 test it iteratively without having to continually rebuild.</p>
  33 <p>For example:</p>
  34 <pre><code>cd ~/projects/node-redis    # go into the package directory
  35 npm link                    # creates global link
  36 cd ~/projects/node-bloggy   # go into some other package directory.
  37 npm link redis              # link-install the package
  38 </code></pre><p>Now, any changes to ~/projects/node-redis will be reflected in
  39 ~/projects/node-bloggy/node_modules/node-redis/. Note that the link should
  40 be to the package name, not the directory name for that package.</p>
  41 <p>You may also shortcut the two steps in one.  For example, to do the
  42 above use-case in a shorter way:</p>
  43 <pre><code>cd ~/projects/node-bloggy  # go into the dir of your main project
  44 npm link ../node-redis     # link the dir of your dependency
  45 </code></pre><p>The second line is the equivalent of doing:</p>
  46 <pre><code>(cd ../node-redis; npm link)
  47 npm link node-redis
  48 </code></pre><p>That is, it first creates a global link, and then links the global
  49 installation target into your project&#39;s <code>node_modules</code> folder.</p>
  50 <p>If your linked package is scoped (see <code><a href="../misc/npm-scope.html">npm-scope(7)</a></code>) your link command must
  51 include that scope, e.g.</p>
  52 <pre><code>npm link @myorg/privatepackage
  53 </code></pre><h2 id="see-also">SEE ALSO</h2>
  54 <ul>
  55 <li><a href="../misc/npm-developers.html">npm-developers(7)</a></li>
  56 <li><a href="../misc/npm-faq.html">npm-faq(7)</a></li>
  57 <li><a href="../files/package.json.html">package.json(5)</a></li>
  58 <li><a href="../cli/npm-install.html">npm-install(1)</a></li>
  59 <li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
  60 <li><a href="../cli/npm-config.html">npm-config(1)</a></li>
  61 <li><a href="../misc/npm-config.html">npm-config(7)</a></li>
  62 <li><a href="../files/npmrc.html">npmrc(5)</a></li>
  63 </ul>
  64
  65 </div>
  66
  67 <table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
  68 <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18>&nbsp;</td></tr>
  69 <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>
  70 <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>
  71 <tr><td style="width:10px;height:10px;background:#fff" rowspan=2>&nbsp;</td></tr>
  72 <tr><td style="width:10px;height:10px;background:#fff">&nbsp;</td></tr>
  73 <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>
  74 <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>
  75 </table>
  76 <p id="footer">npm-link &mdash; npm@2.15.1</p>
  77