| <!doctype html> |
| <html> |
| <title>npm-link</title> |
| <meta http-equiv="content-type" value="text/html;utf-8"> |
| <link rel="stylesheet" type="text/css" href="../../static/style.css"> |
| <link rel="canonical" href="https://www.npmjs.org/doc/api/npm-link.html"> |
| <script async=true src="../../static/toc.js"></script> |
| |
| <body> |
| <div id="wrapper"> |
| |
| <h1><a href="../api/npm-link.html">npm-link</a></h1> <p>Symlink a package folder</p> |
| <h2 id="synopsis">SYNOPSIS</h2> |
| <pre><code>npm.commands.link(callback) |
| npm.commands.link(packages, callback) |
| </code></pre><h2 id="description">DESCRIPTION</h2> |
| <p>Package linking is a two-step process.</p> |
| <p>Without parameters, link will create a globally-installed |
| symbolic link from <code>prefix/package-name</code> to the current folder.</p> |
| <p>With a parameters, link will create a symlink from the local <code>node_modules</code> |
| folder to the global symlink.</p> |
| <p>When creating tarballs for <code>npm publish</code>, the linked packages are |
| "snapshotted" to their current state by resolving the symbolic links.</p> |
| <p>This is |
| handy for installing your own stuff, so that you can work on it and test it |
| iteratively without having to continually rebuild.</p> |
| <p>For example:</p> |
| <pre><code>npm.commands.link(cb) # creates global link from the cwd |
| # (say redis package) |
| npm.commands.link('redis', cb) # link-install the package |
| </code></pre><p>Now, any changes to the redis package will be reflected in |
| the package in the current working directory</p> |
| |
| </div> |
| |
| <table border=0 cellspacing=0 cellpadding=0 id=npmlogo> |
| <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr> |
| <tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr> |
| <tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr> |
| <tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr> |
| <tr><td style="width:10px;height:10px;background:#fff"> </td></tr> |
| <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr> |
| <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr> |
| </table> |
| <p id="footer">npm-link — npm@2.15.8</p> |
| |
