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
   7   <body>
   8     <div id="wrapper">
   9 <h1><a href="../cli/npm-link.html">npm-link</a></h1> <p>Symlink a package folder</p>
  10
  11 <h2 id="SYNOPSIS">SYNOPSIS</h2>
  12
  13 <pre><code>npm link (in package folder)
  14 npm link &lt;pkgname&gt;
  15 npm ln (with any of the previous argument usage)</code></pre>
  16
  17 <h2 id="DESCRIPTION">DESCRIPTION</h2>
  18
  19 <p>Package linking is a two-step process.</p>
  20
  21 <p>First, <code>npm link</code> in a package folder will create a globally-installed
  22 symbolic link from <code>prefix/package-name</code> to the current folder.</p>
  23
  24 <p>Next, in some other location, <code>npm link package-name</code> will create a
  25 symlink from the local <code>node_modules</code> folder to the global symlink.</p>
  26
  27 <p>Note that <code>package-name</code> is taken from <code>package.json</code>,
  28 not from directory name.</p>
  29
  30 <p>When creating tarballs for <code>npm publish</code>, the linked packages are
  31 &quot;snapshotted&quot; to their current state by resolving the symbolic links.</p>
  32
  33 <p>This is
  34 handy for installing your own stuff, so that you can work on it and test it
  35 iteratively without having to continually rebuild.</p>
  36
  37 <p>For example:</p>
  38
  39 <pre><code>cd ~/projects/node-redis    # go into the package directory
  40 npm link                    # creates global link
  41 cd ~/projects/node-bloggy   # go into some other package directory.
  42 npm link redis              # link-install the package</code></pre>
  43
  44 <p>Now, any changes to ~/projects/node-redis will be reflected in
  45 ~/projects/node-bloggy/node_modules/redis/</p>
  46
  47 <p>You may also shortcut the two steps in one.  For example, to do the
  48 above use-case in a shorter way:</p>
  49
  50 <pre><code>cd ~/projects/node-bloggy  # go into the dir of your main project
  51 npm link ../node-redis     # link the dir of your dependency</code></pre>
  52
  53 <p>The second line is the equivalent of doing:</p>
  54
  55 <pre><code>(cd ../node-redis; npm link)
  56 npm link redis</code></pre>
  57
  58 <p>That is, it first creates a global link, and then links the global
  59 installation target into your project&#39;s <code>node_modules</code> folder.</p>
  60
  61 <h2 id="SEE-ALSO">SEE ALSO</h2>
  62
  63 <ul><li><a href="../misc/npm-developers.html">npm-developers(7)</a></li><li><a href="../misc/npm-faq.html">npm-faq(7)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</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></ul>
  64 </div>
  65 <p id="footer">npm-link &mdash; npm@1.3.17</p>
  66 <script>
  67 ;(function () {
  68 var wrapper = document.getElementById("wrapper")
  69 var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0)
  70   .filter(function (el) {
  71     return el.parentNode === wrapper
  72         && el.tagName.match(/H[1-6]/)
  73         && el.id
  74   })
  75 var l = 2
  76   , toc = document.createElement("ul")
  77 toc.innerHTML = els.map(function (el) {
  78   var i = el.tagName.charAt(1)
  79     , out = ""
  80   while (i > l) {
  81     out += "<ul>"
  82     l ++
  83   }
  84   while (i < l) {
  85     out += "</ul>"
  86     l --
  87   }
  88   out += "<li><a href='#" + el.id + "'>" +
  89     ( el.innerText || el.text || el.innerHTML)
  90     + "</a>"
  91   return out
  92 }).join("\n")
  93 toc.id = "toc"
  94 document.body.appendChild(toc)
  95 })()
  96 </script>