## SYNOPSIS
- npm run-script [<pkg>] <command>
+ npm run-script [<pkg>] [command]
## DESCRIPTION
This runs an arbitrary command from a package's `"scripts"` object.
If no package name is provided, it will search for a `package.json`
-in the current folder and use its `"scripts"` object.
+in the current folder and use its `"scripts"` object. If no `"command"`
+is provided, it will list the available top level scripts.
It is used by the test, start, restart, and stop commands, but can be
called directly, as well.
<div id="wrapper">
<h1><a href="cli/npm.html">npm</a></h1> <p>node package manager</p>
-
-<p><a href="https://img.shields.io/travis/npm/npm/master.svg)](https://travis-ci.org/npm/npm"></code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands[<command>](args, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>npm comes with a full set of commands, and each of the commands takes a
similar set of arguments.</p>
-
<p>In general, all commands on the command object take an <strong>array</strong> of positional
argument <strong>strings</strong>. The last argument to any function is a callback. Some
commands are special and take other optional arguments.</p>
-
<p>All commands have their own man page. See <code>man npm-<command></code> for command-line
usage, or <code>man 3 npm-<command></code> for programmatic usage.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../misc/npm-index.html">npm-index(7)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../misc/npm-index.html">npm-index(7)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-commands — npm@1.4.9</p>
+<p id="footer">npm-commands — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-config.html">npm-config</a></h1> <p>Manage the npm configuration files</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm.commands.config(args, callback)
var val = npm.config.get(key)
-npm.config.set(key, val)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm.config.set(key, val)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This function acts much the same way as the command-line version. The first
element in the array tells config what to do. Possible values are:</p>
-
-<ul><li><p><code>set</code></p><p>Sets a config parameter. The second element in <code>args</code> is interpreted as the
-key, and the third element is interpreted as the value.</p></li><li><p><code>get</code></p><p>Gets the value of a config parameter. The second element in <code>args</code> is the
-key to get the value of.</p></li><li><p><code>delete</code> (<code>rm</code> or <code>del</code>)</p><p>Deletes a parameter from the config. The second element in <code>args</code> is the
-key to delete.</p></li><li><p><code>list</code> (<code>ls</code>)</p><p>Show all configs that aren't secret. No parameters necessary.</p></li><li><p><code>edit</code>:</p><p>Opens the config file in the default editor. This command isn't very useful
-programmatically, but it is made available.</p></li></ul>
-
+<ul>
+<li><p><code>set</code></p>
+<p> Sets a config parameter. The second element in <code>args</code> is interpreted as the
+ key, and the third element is interpreted as the value.</p>
+</li>
+<li><p><code>get</code></p>
+<p> Gets the value of a config parameter. The second element in <code>args</code> is the
+ key to get the value of.</p>
+</li>
+<li><p><code>delete</code> (<code>rm</code> or <code>del</code>)</p>
+<p> Deletes a parameter from the config. The second element in <code>args</code> is the
+ key to delete.</p>
+</li>
+<li><p><code>list</code> (<code>ls</code>)</p>
+<p> Show all configs that aren't secret. No parameters necessary.</p>
+</li>
+<li><p><code>edit</code>:</p>
+<p> Opens the config file in the default editor. This command isn't very useful
+ programmatically, but it is made available.</p>
+</li>
+</ul>
<p>To programmatically access npm configuration settings, or set them for
the duration of a program, use the <code>npm.config.set</code> and <code>npm.config.get</code>
functions instead.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../api/npm.html">npm(3)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../api/npm.html">npm(3)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-config — npm@1.4.9</p>
+<p id="footer">npm-config — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-deprecate.html">npm-deprecate</a></h1> <p>Deprecate a version of a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.deprecate(args, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.deprecate(args, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command will update the npm registry entry for a package, providing
a deprecation warning to all who attempt to install it.</p>
-
<p>The 'args' parameter must have exactly two elements:</p>
-
-<ul><li><p><code>package[@version]</code></p><p>The <code>version</code> portion is optional, and may be either a range, or a
-specific version, or a tag.</p></li><li><p><code>message</code></p><p>The warning message that will be printed whenever a user attempts to
-install the package.</p></li></ul>
-
+<ul>
+<li><p><code>package[@version]</code></p>
+<p> The <code>version</code> portion is optional, and may be either a range, or a
+ specific version, or a tag.</p>
+</li>
+<li><p><code>message</code></p>
+<p> The warning message that will be printed whenever a user attempts to
+ install the package.</p>
+</li>
+</ul>
<p>Note that you must be the package owner to deprecate something. See the
<code>owner</code> and <code>adduser</code> help topics.</p>
-
<p>To un-deprecate a package, specify an empty string (<code>""</code>) for the <code>message</code> argument.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../api/npm-publish.html">npm-publish(3)</a></li>
+<li><a href="../api/npm-unpublish.html">npm-unpublish(3)</a></li>
+<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../api/npm-publish.html">npm-publish(3)</a></li><li><a href="../api/npm-unpublish.html">npm-unpublish(3)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-deprecate — npm@1.4.9</p>
+<p id="footer">npm-deprecate — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-docs.html">npm-docs</a></h1> <p>Docs for a package in a web browser maybe</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.docs(package, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.docs(package, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command tries to guess at the likely location of a package's
documentation URL, and then tries to open it using the <code>--browser</code>
config param.</p>
-
<p>Like other commands, the first parameter is an array. This command only
uses the first element, which is expected to be a package name with an
optional version number.</p>
-
<p>This command will launch a browser, so this command may not be the most
friendly for programmatic use.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-docs — npm@1.4.9</p>
+<p id="footer">npm-docs — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-edit.html">npm-edit</a></h1> <p>Edit an installed package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.edit(package, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.edit(package, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Opens the package folder in the default editor (or whatever you've
configured as the npm <code>editor</code> config -- see <code>npm help config</code>.)</p>
-
<p>After it has been edited, the package is rebuilt so as to pick up any
changes in compiled packages.</p>
-
<p>For instance, you can do <code>npm install connect</code> to install connect
into your package, and then <code>npm.commands.edit(["connect"], callback)</code>
to make a few changes to your locally installed copy.</p>
-
<p>The first parameter is a string array with a single element, the package
to open. The package can optionally have a version number attached.</p>
-
<p>Since this command opens an editor in a new process, be careful about where
and how this is used.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-edit — npm@1.4.9</p>
+<p id="footer">npm-edit — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-explore.html">npm-explore</a></h1> <p>Browse an installed package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.explore(args, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.explore(args, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Spawn a subshell in the directory of the installed package specified.</p>
-
<p>If a command is specified, then it is run in the subshell, which then
immediately terminates.</p>
-
<p>Note that the package is <em>not</em> automatically rebuilt afterwards, so be
sure to use <code>npm rebuild <pkg></code> if you make any changes.</p>
-
<p>The first element in the 'args' parameter must be a package name. After that is the optional command, which can be any number of strings. All of the strings will be combined into one, space-delimited command.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-explore — npm@1.4.9</p>
+<p id="footer">npm-explore — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-help-search.html">npm-help-search</a></h1> <p>Search the help pages</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.helpSearch(args, [silent,] callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.helpSearch(args, [silent,] callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command is rarely useful, but it exists in the rare case that it is.</p>
-
<p>This command takes an array of search terms and returns the help pages that
match in order of best match.</p>
-
<p>If there is only one match, then npm displays that help section. If there
are multiple results, the results are printed to the screen formatted and the
array of results is returned. Each result is an object with these properties:</p>
-
-<ul><li>hits:
-A map of args to number of hits on that arg. For example, {"npm": 3}</li><li>found:
-Total number of unique args that matched.</li><li>totalHits:
-Total number of hits.</li><li>lines:
-An array of all matching lines (and some adjacent lines).</li><li>file:
-Name of the file that matched</li></ul>
-
+<ul>
+<li>hits:
+A map of args to number of hits on that arg. For example, {"npm": 3}</li>
+<li>found:
+Total number of unique args that matched.</li>
+<li>totalHits:
+Total number of hits.</li>
+<li>lines:
+An array of all matching lines (and some adjacent lines).</li>
+<li>file:
+Name of the file that matched</li>
+</ul>
<p>The silent parameter is not neccessary not used, but it may in the future.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-help-search — npm@1.4.9</p>
+<p id="footer">npm-help-search — npm@1.4.10</p>
<div id="wrapper">
<h1>npm <a href="../api/init.html">init</a></h1> <p>Interactively create a package.json file</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.init(args, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.init(args, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This will ask you a bunch of questions, and then write a package.json for you.</p>
-
<p>It attempts to make reasonable guesses about what you want things to be set to,
and then writes a package.json file with the options you've selected.</p>
-
<p>If you already have a package.json file, it'll read that first, and default to
the options in there.</p>
-
<p>It is strictly additive, so it does not delete options from your package.json
without a really good reason to do so.</p>
-
<p>Since this function expects to be run on the command-line, it doesn't work very
well as a programmatically. The best option is to roll your own, and since
JavaScript makes it stupid simple to output formatted JSON, that is the
preferred method. If you're sure you want to handle command-line prompting,
then go ahead and use this programmatically.</p>
-
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
+<h2 id="see-also">SEE ALSO</h2>
<p><a href="../files/package.json.html">package.json(5)</a></p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-init — npm@1.4.9</p>
+<p id="footer">npm-init — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-install.html">npm-install</a></h1> <p>install a package programmatically</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.install([where,] packages, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.install([where,] packages, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This acts much the same ways as installing on the command-line.</p>
-
<p>The 'where' parameter is optional and only used internally, and it specifies
where the packages should be installed to.</p>
-
<p>The 'packages' parameter is an array of strings. Each element in the array is
the name of a package to be installed.</p>
-
<p>Finally, 'callback' is a function that will be called when all packages have been
installed or when an error has been encountered.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-install — npm@1.4.9</p>
+<p id="footer">npm-install — npm@1.4.10</p>
<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>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm.command.link(callback)
-npm.command.link(packages, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm.command.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
+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: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@1.4.9</p>
+<p id="footer">npm-link — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-load.html">npm-load</a></h1> <p>Load config settings</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.load(conf, cb)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.load(conf, cb)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>npm.load() must be called before any other function call. Both parameters are
optional, but the second is recommended.</p>
-
<p>The first parameter is an object hash of command-line config params, and the
second parameter is a callback that will be called when npm is loaded and
ready to serve.</p>
-
<p>The first parameter should follow a similar structure as the package.json
config object.</p>
-
<p>For example, to emulate the --dev flag, pass an object that looks like this:</p>
-
<pre><code>{
"dev": true
-}</code></pre>
+}
+</code></pre><p>For a list of all the available command-line configs, see <code>npm help config</code></p>
-<p>For a list of all the available command-line configs, see <code>npm help config</code></p>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-load — npm@1.4.9</p>
+<p id="footer">npm-load — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-ls.html">npm-ls</a></h1> <p>List installed packages</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.ls(args, [silent,] callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.ls(args, [silent,] callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command will print to stdout all the versions of packages that are
installed, as well as their dependencies, in a tree-structure. It will also
return that data using the callback.</p>
-
<p>This command does not take any arguments, but args must be defined.
Beyond that, if any arguments are passed in, npm will politely warn that it
does not take positional arguments, though you may set config flags
like with any other command, such as <code>global</code> to list global packages.</p>
-
<p>It will print out extraneous, missing, and invalid packages.</p>
-
<p>If the silent parameter is set to true, nothing will be output to the screen,
but the data will still be returned.</p>
-
<p>Callback is provided an error if one occurred, the full data about which
packages are installed and which dependencies they will receive, and a
"lite" data object which just shows which versions are installed where.
Note that the full data object is a circular structure, so care must be
taken if it is serialized to JSON.</p>
-
-<h2 id="CONFIGURATION">CONFIGURATION</h2>
-
+<h2 id="configuration">CONFIGURATION</h2>
<h3 id="long">long</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Show extended information.</p>
-
<h3 id="parseable">parseable</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Show parseable output instead of tree view.</p>
-
<h3 id="global">global</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>List packages in the global install prefix instead of in the current
project.</p>
-
<p>Note, if parseable is set or long isn't set, then duplicates will be trimmed.
This means that if a submodule a same dependency as a parent module, then the
dependency will only be output once.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-ls — npm@1.4.9</p>
+<p id="footer">npm-ls — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-outdated.html">npm-outdated</a></h1> <p>Check for outdated packages</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.outdated([packages,] callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.outdated([packages,] callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command will check the registry to see if the specified packages are
currently outdated.</p>
-
<p>If the 'packages' parameter is left out, npm will check all packages.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-outdated — npm@1.4.9</p>
+<p id="footer">npm-outdated — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-owner.html">npm-owner</a></h1> <p>Manage package owners</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.owner(args, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.owner(args, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>The first element of the 'args' parameter defines what to do, and the subsequent
elements depend on the action. Possible values for the action are (order of
parameters are given in parenthesis):</p>
-
-<ul><li>ls (package):
+<ul>
+<li>ls (package):
List all the users who have access to modify a package and push new versions.
-Handy when you need to know who to bug for help.</li><li>add (user, package):
+Handy when you need to know who to bug for help.</li>
+<li>add (user, package):
Add a new user as a maintainer of a package. This user is enabled to modify
-metadata, publish new versions, and add other owners.</li><li>rm (user, package):
+metadata, publish new versions, and add other owners.</li>
+<li>rm (user, package):
Remove a user from the package owner list. This immediately revokes their
-privileges.</li></ul>
-
+privileges.</li>
+</ul>
<p>Note that there is only one level of access. Either you can modify a package,
or you can't. Future versions may contain more fine-grained access levels, but
that is not implemented at this time.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../api/npm-publish.html">npm-publish(3)</a></li>
+<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../api/npm-publish.html">npm-publish(3)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-owner — npm@1.4.9</p>
+<p id="footer">npm-owner — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-pack.html">npm-pack</a></h1> <p>Create a tarball from a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.pack([packages,] callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.pack([packages,] callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>For anything that's installable (that is, a package folder, tarball,
tarball url, name@tag, name@version, or name), this command will fetch
it to the cache, and then copy the tarball to the current working
directory as <code><name>-<version>.tgz</code>, and then write the filenames out to
stdout.</p>
-
<p>If the same package is specified multiple times, then the file will be
overwritten the second time.</p>
-
<p>If no arguments are supplied, then npm packs the current package folder.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-pack — npm@1.4.9</p>
+<p id="footer">npm-pack — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-prefix.html">npm-prefix</a></h1> <p>Display prefix</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.prefix(args, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.prefix(args, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Print the prefix to standard out.</p>
-
<p>'args' is never used and callback is never called with data.
'args' must be present or things will break.</p>
-
<p>This function is not useful programmatically</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-prefix — npm@1.4.9</p>
+<p id="footer">npm-prefix — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-prune.html">npm-prune</a></h1> <p>Remove extraneous packages</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.prune([packages,] callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.prune([packages,] callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command removes "extraneous" packages.</p>
-
<p>The first parameter is optional, and it specifies packages to be removed.</p>
-
<p>No packages are specified, then all packages will be checked.</p>
-
<p>Extraneous packages are packages that are not listed on the parent
package's dependencies list.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-prune — npm@1.4.9</p>
+<p id="footer">npm-prune — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-publish.html">npm-publish</a></h1> <p>Publish a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.publish([packages,] callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.publish([packages,] callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Publishes a package to the registry so that it can be installed by name.
Possible values in the 'packages' array are:</p>
-
-<ul><li><p><code><folder></code>:
-A folder containing a package.json file</p></li><li><p><code><tarball></code>:
+<ul>
+<li><p><code><folder></code>:
+A folder containing a package.json file</p>
+</li>
+<li><p><code><tarball></code>:
A url or file path to a gzipped tar archive containing a single folder
-with a package.json file inside.</p></li></ul>
-
+with a package.json file inside.</p>
+</li>
+</ul>
<p>If the package array is empty, npm will try to publish something in the
current working directory.</p>
-
<p>This command could fails if one of the packages specified already exists in
the registry. Overwrites when the "force" environment variable is set.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
+<li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li>
+<li><a href="../api/npm-owner.html">npm-owner(3)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li><li><a href="../api/npm-owner.html">npm-owner(3)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-publish — npm@1.4.9</p>
+<p id="footer">npm-publish — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-rebuild.html">npm-rebuild</a></h1> <p>Rebuild a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.rebuild([packages,] callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.rebuild([packages,] callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command runs the <code>npm build</code> command on each of the matched packages. This is useful
when you install a new version of node, and must recompile all your C++ addons with
the new binary. If no 'packages' parameter is specify, every package will be rebuilt.</p>
-
-<h2 id="CONFIGURATION">CONFIGURATION</h2>
-
+<h2 id="configuration">CONFIGURATION</h2>
<p>See <code>npm help build</code></p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-rebuild — npm@1.4.9</p>
+<p id="footer">npm-rebuild — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-repo.html">npm-repo</a></h1> <p>Open package repository page in the browser</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.repo(package, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.repo(package, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command tries to guess at the likely location of a package's
repository URL, and then tries to open it using the <code>--browser</code>
config param.</p>
-
<p>Like other commands, the first parameter is an array. This command only
uses the first element, which is expected to be a package name with an
optional version number.</p>
-
<p>This command will launch a browser, so this command may not be the most
friendly for programmatic use.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-repo — npm@1.4.9</p>
+<p id="footer">npm-repo — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-restart.html">npm-restart</a></h1> <p>Start a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.restart(packages, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.restart(packages, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This runs a package's "restart" script, if one was provided.
Otherwise it runs package's "stop" script, if one was provided, and then
the "start" script.</p>
-
<p>If no version is specified, then it restarts the "active" version.</p>
-
<p>npm can run tests on multiple packages. Just specify multiple packages
in the <code>packages</code> parameter.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../api/npm-start.html">npm-start(3)</a></li>
+<li><a href="../api/npm-stop.html">npm-stop(3)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../api/npm-start.html">npm-start(3)</a></li><li><a href="../api/npm-stop.html">npm-stop(3)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-restart — npm@1.4.9</p>
+<p id="footer">npm-restart — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-root.html">npm-root</a></h1> <p>Display npm root</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.root(args, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.root(args, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Print the effective <code>node_modules</code> folder to standard out.</p>
-
<p>'args' is never used and callback is never called with data.
'args' must be present or things will break.</p>
-
<p>This function is not useful programmatically.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-root — npm@1.4.9</p>
+<p id="footer">npm-root — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-run-script.html">npm-run-script</a></h1> <p>Run arbitrary package scripts</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.run-script(args, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.run-script(args, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This runs an arbitrary command from a package's "scripts" object.</p>
-
<p>It is used by the test, start, restart, and stop commands, but can be
called directly, as well.</p>
-
<p>The 'args' parameter is an array of strings. Behavior depends on the number
of elements. If there is only one element, npm assumes that the element
represents a command to be run on the local repository. If there is more than
one element, then the first is assumed to be the package and the second is
assumed to be the command to run. All other elements are ignored.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li>
+<li><a href="../api/npm-test.html">npm-test(3)</a></li>
+<li><a href="../api/npm-start.html">npm-start(3)</a></li>
+<li><a href="../api/npm-restart.html">npm-restart(3)</a></li>
+<li><a href="../api/npm-stop.html">npm-stop(3)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li><li><a href="../api/npm-test.html">npm-test(3)</a></li><li><a href="../api/npm-start.html">npm-start(3)</a></li><li><a href="../api/npm-restart.html">npm-restart(3)</a></li><li><a href="../api/npm-stop.html">npm-stop(3)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-run-script — npm@1.4.9</p>
+<p id="footer">npm-run-script — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-search.html">npm-search</a></h1> <p>Search for packages</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.search(searchTerms, [silent,] [staleness,] callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.search(searchTerms, [silent,] [staleness,] callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Search the registry for packages matching the search terms. The available parameters are:</p>
-
-<ul><li>searchTerms:
-Array of search terms. These terms are case-insensitive.</li><li>silent:
-If true, npm will not log anything to the console.</li><li>staleness:
+<ul>
+<li>searchTerms:
+Array of search terms. These terms are case-insensitive.</li>
+<li>silent:
+If true, npm will not log anything to the console.</li>
+<li>staleness:
This is the threshold for stale packages. "Fresh" packages are not refreshed
-from the registry. This value is measured in seconds.</li><li><p>callback:
+from the registry. This value is measured in seconds.</li>
+<li><p>callback:
Returns an object where each key is the name of a package, and the value
is information about that package along with a 'words' property, which is
a space-delimited string of all of the interesting words in that package.
-The only properties included are those that are searched, which generally include:</p><ul><li>name</li><li>description</li><li>maintainers</li><li>url</li><li>keywords</li></ul></li></ul>
-
+The only properties included are those that are searched, which generally include:</p>
+<ul>
+<li>name</li>
+<li>description</li>
+<li>maintainers</li>
+<li>url</li>
+<li>keywords</li>
+</ul>
+</li>
+</ul>
<p>A search on the registry excludes any result that does not match all of the
search terms. It also removes any items from the results that contain an
excluded term (the "searchexclude" config). The search is case insensitive
and doesn't try to read your mind (it doesn't do any verb tense matching or the
like).</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-search — npm@1.4.9</p>
+<p id="footer">npm-search — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-shrinkwrap.html">npm-shrinkwrap</a></h1> <p>programmatically generate package shrinkwrap file</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.shrinkwrap(args, [silent,] callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.shrinkwrap(args, [silent,] callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This acts much the same ways as shrinkwrapping on the command-line.</p>
-
<p>This command does not take any arguments, but 'args' must be defined.
Beyond that, if any arguments are passed in, npm will politely warn that it
does not take positional arguments.</p>
-
<p>If the 'silent' parameter is set to true, nothing will be output to the screen,
but the shrinkwrap file will still be written.</p>
-
<p>Finally, 'callback' is a function that will be called when the shrinkwrap has
been saved.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-shrinkwrap — npm@1.4.9</p>
+<p id="footer">npm-shrinkwrap — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-start.html">npm-start</a></h1> <p>Start a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.start(packages, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.start(packages, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This runs a package's "start" script, if one was provided.</p>
-
<p>npm can run tests on multiple packages. Just specify multiple packages
in the <code>packages</code> parameter.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-start — npm@1.4.9</p>
+<p id="footer">npm-start — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-stop.html">npm-stop</a></h1> <p>Stop a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.stop(packages, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.stop(packages, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This runs a package's "stop" script, if one was provided.</p>
-
<p>npm can run stop on multiple packages. Just specify multiple packages
in the <code>packages</code> parameter.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-stop — npm@1.4.9</p>
+<p id="footer">npm-stop — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-submodule.html">npm-submodule</a></h1> <p>Add a package as a git submodule</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.submodule(packages, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.submodule(packages, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>For each package specified, npm will check if it has a git repository url
in its package.json description then add it as a git submodule at
<code>node_modules/<pkg name></code>.</p>
-
<p>This is a convenience only. From then on, it's up to you to manage
updates by using the appropriate git commands. npm will stubbornly
refuse to update, modify, or remove anything with a <code>.git</code> subfolder
in it.</p>
-
<p>This command also does not install missing dependencies, if the package
does not include them in its git repository. If <code>npm ls</code> reports that
things are missing, you can either install, link, or submodule them yourself,
or you can do <code>npm explore <pkgname> -- npm install</code> to install the
dependencies into the submodule folder.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li>npm help json</li>
+<li>git help submodule</li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li>npm help json</li><li>git help submodule</li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-submodule — npm@1.4.9</p>
+<p id="footer">npm-submodule — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-tag.html">npm-tag</a></h1> <p>Tag a published version</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.tag(package@version, tag, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.tag(package@version, tag, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Tags the specified version of the package with the specified tag, or the
<code>--tag</code> config if not specified.</p>
-
<p>The 'package@version' is an array of strings, but only the first two elements are
currently used.</p>
-
<p>The first element must be in the form package@version, where package
is the package name and version is the version number (much like installing a
specific version).</p>
-
<p>The second element is the name of the tag to tag this version with. If this
parameter is missing or falsey (empty), the default froom the config will be
used. For more information about how to set this config, check
<code>man 3 npm-config</code> for programmatic usage or <code>man npm-config</code> for cli usage.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-tag — npm@1.4.9</p>
+<p id="footer">npm-tag — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-test.html">npm-test</a></h1> <p>Test a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code> npm.commands.test(packages, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code> npm.commands.test(packages, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This runs a package's "test" script, if one was provided.</p>
-
<p>To run tests as a condition of installation, set the <code>npat</code> config to
true.</p>
-
<p>npm can run tests on multiple packages. Just specify multiple packages
in the <code>packages</code> parameter.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-test — npm@1.4.9</p>
+<p id="footer">npm-test — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-uninstall.html">npm-uninstall</a></h1> <p>uninstall a package programmatically</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.uninstall(packages, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.uninstall(packages, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This acts much the same ways as uninstalling on the command-line.</p>
-
<p>The 'packages' parameter is an array of strings. Each element in the array is
the name of a package to be uninstalled.</p>
-
<p>Finally, 'callback' is a function that will be called when all packages have been
uninstalled or when an error has been encountered.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-uninstall — npm@1.4.9</p>
+<p id="footer">npm-uninstall — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-unpublish.html">npm-unpublish</a></h1> <p>Remove a package from the registry</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.unpublish(package, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.unpublish(package, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This removes a package version from the registry, deleting its
entry and removing the tarball.</p>
-
<p>The package parameter must be defined.</p>
-
<p>Only the first element in the package parameter is used. If there is no first
element, then npm assumes that the package at the current working directory
is what is meant.</p>
-
<p>If no version is specified, or if all versions are removed then
the root package entry is removed from the registry entirely.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-unpublish — npm@1.4.9</p>
+<p id="footer">npm-unpublish — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-update.html">npm-update</a></h1> <p>Update a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.update(packages, callback)</code></pre>
-
-<h1>DESCRIPTION</h1>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.update(packages, callback)
+</code></pre><h1 id="description">DESCRIPTION</h1>
<p>Updates a package, upgrading it to the latest version. It also installs any missing packages.</p>
-
<p>The 'packages' argument is an array of packages to update. The 'callback' parameter will be called when done or when an error occurs.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-update — npm@1.4.9</p>
+<p id="footer">npm-update — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-version.html">npm-version</a></h1> <p>Bump a package version</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.version(newversion, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.version(newversion, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Run this in a package directory to bump the version and write the new
data back to the package.json file.</p>
-
<p>If run in a git repo, it will also create a version commit and tag, and
fail if the repo is not clean.</p>
-
<p>Like all other commands, this function takes a string array as its first
parameter. The difference, however, is this function will fail if it does
not have exactly one element. The only element should be a version number.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-version — npm@1.4.9</p>
+<p id="footer">npm-version — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-view.html">npm-view</a></h1> <p>View registry info</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.view(args, [silent,] callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.view(args, [silent,] callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command shows data about a package and prints it to the stream
referenced by the <code>outfd</code> config, which defaults to stdout.</p>
-
<p>The "args" parameter is an ordered list that closely resembles the command-line
usage. The elements should be ordered such that the first element is
the package and version (package@version). The version is optional. After that,
the rest of the parameters are fields with optional subfields ("field.subfield")
which can be used to get only the information desired from the registry.</p>
-
<p>The callback will be passed all of the data returned by the query.</p>
-
<p>For example, to get the package registry entry for the <code>connect</code> package,
you can do this:</p>
-
-<pre><code>npm.commands.view(["connect"], callback)</code></pre>
-
-<p>If no version is specified, "latest" is assumed.</p>
-
+<pre><code>npm.commands.view(["connect"], callback)
+</code></pre><p>If no version is specified, "latest" is assumed.</p>
<p>Field names can be specified after the package descriptor.
For example, to show the dependencies of the <code>ronn</code> package at version
0.3.5, you could do the following:</p>
-
-<pre><code>npm.commands.view(["ronn@0.3.5", "dependencies"], callback)</code></pre>
-
-<p>You can view child field by separating them with a period.
+<pre><code>npm.commands.view(["ronn@0.3.5", "dependencies"], callback)
+</code></pre><p>You can view child field by separating them with a period.
To view the git repository URL for the latest version of npm, you could
do this:</p>
-
-<pre><code>npm.commands.view(["npm", "repository.url"], callback)</code></pre>
-
-<p>For fields that are arrays, requesting a non-numeric field will return
+<pre><code>npm.commands.view(["npm", "repository.url"], callback)
+</code></pre><p>For fields that are arrays, requesting a non-numeric field will return
all of the values from the objects in the list. For example, to get all
the contributor names for the "express" project, you can do this:</p>
-
-<pre><code>npm.commands.view(["express", "contributors.email"], callback)</code></pre>
-
-<p>You may also use numeric indices in square braces to specifically select
+<pre><code>npm.commands.view(["express", "contributors.email"], callback)
+</code></pre><p>You may also use numeric indices in square braces to specifically select
an item in an array field. To just get the email address of the first
contributor in the list, you can do this:</p>
-
-<pre><code>npm.commands.view(["express", "contributors[0].email"], callback)</code></pre>
-
-<p>Multiple fields may be specified, and will be printed one after another.
+<pre><code>npm.commands.view(["express", "contributors[0].email"], callback)
+</code></pre><p>Multiple fields may be specified, and will be printed one after another.
For exampls, to get all the contributor names and email addresses, you
can do this:</p>
-
-<pre><code>npm.commands.view(["express", "contributors.name", "contributors.email"], callback)</code></pre>
-
-<p>"Person" fields are shown as a string if they would be shown as an
+<pre><code>npm.commands.view(["express", "contributors.name", "contributors.email"], callback)
+</code></pre><p>"Person" fields are shown as a string if they would be shown as an
object. So, for example, this will show the list of npm contributors in
the shortened string format. (See <code>npm help json</code> for more on this.)</p>
-
-<pre><code>npm.commands.view(["npm", "contributors"], callback)</code></pre>
-
-<p>If a version range is provided, then data will be printed for every
+<pre><code>npm.commands.view(["npm", "contributors"], callback)
+</code></pre><p>If a version range is provided, then data will be printed for every
matching version of the package. This will show which version of jsdom
was required by each matching version of yui3:</p>
-
-<pre><code>npm.commands.view(["yui3@'>0.5.4'", "dependencies.jsdom"], callback)</code></pre>
-
-<h2 id="OUTPUT">OUTPUT</h2>
-
+<pre><code>npm.commands.view(["yui3@'>0.5.4'", "dependencies.jsdom"], callback)
+</code></pre><h2 id="output">OUTPUT</h2>
<p>If only a single string field for a single version is output, then it
will not be colorized or quoted, so as to enable piping the output to
another command.</p>
-
<p>If the version range matches multiple versions, than each printed value
will be prefixed with the version it applies to.</p>
-
<p>If multiple fields are requested, than each of them are prefixed with
the field name.</p>
-
<p>Console output can be disabled by setting the 'silent' parameter to true.</p>
-
-<h2 id="RETURN-VALUE">RETURN VALUE</h2>
-
+<h2 id="return-value">RETURN VALUE</h2>
<p>The data returned will be an object in this formation:</p>
-
<pre><code>{ <version>:
{ <field>: <value>
, ... }
-, ... }</code></pre>
+, ... }
+</code></pre><p>corresponding to the list of fields selected.</p>
-<p>corresponding to the list of fields selected.</p>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-view — npm@1.4.9</p>
+<p id="footer">npm-view — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm-whoami.html">npm-whoami</a></h1> <p>Display npm username</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm.commands.whoami(args, callback)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm.commands.whoami(args, callback)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Print the <code>username</code> config to standard output.</p>
-
<p>'args' is never used and callback is never called with data.
'args' must be present or things will break.</p>
-
<p>This function is not useful programmatically</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-whoami — npm@1.4.9</p>
+<p id="footer">npm-whoami — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../api/npm.html">npm</a></h1> <p>node package manager</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>var npm = require("npm")
npm.load([configObject, ]function (er, npm) {
// use the npm object, now that it's loaded.
console.log("prefix = %s", npm.prefix)
npm.commands.install(["package"], cb)
-})</code></pre>
-
-<h2 id="VERSION">VERSION</h2>
-
-<p>1.4.9</p>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+})
+</code></pre><h2 id="version">VERSION</h2>
+<p>1.4.10</p>
+<h2 id="description">DESCRIPTION</h2>
<p>This is the API documentation for npm.
To find documentation of the command line
client, see <code><a href="../cli/npm.html">npm(1)</a></code>.</p>
-
<p>Prior to using npm's commands, <code>npm.load()</code> must be called.
If you provide <code>configObject</code> as an object hash of top-level
configs, they override the values stored in the various config
is parsed from the command line options. Additional configuration
params are loaded from two configuration files. See <code><a href="../cli/npm-config.html">npm-config(1)</a></code>,
<code><a href="../misc/npm-config.html">npm-config(7)</a></code>, and <code><a href="../files/npmrc.html">npmrc(5)</a></code> for more information.</p>
-
<p>After that, each of the functions are accessible in the
commands object: <code>npm.commands.<cmd></code>. See <code><a href="../misc/npm-index.html">npm-index(7)</a></code> for a list of
all possible commands.</p>
-
<p>All commands on the command object take an <strong>array</strong> of positional argument
<strong>strings</strong>. The last argument to any function is a callback. Some
commands take other optional arguments.</p>
-
<p>Configs cannot currently be set on a per function basis, as each call to
npm.config.set will change the value for <em>all</em> npm commands in that process.</p>
-
<p>To find API documentation for a specific command, run the <code>npm apihelp</code>
command.</p>
-
-<h2 id="METHODS-AND-PROPERTIES">METHODS AND PROPERTIES</h2>
-
-<ul><li><p><code>npm.load(configs, cb)</code></p><p>Load the configuration params, and call the <code>cb</code> function once the
-globalconfig and userconfig files have been loaded as well, or on
-nextTick if they've already been loaded.</p></li><li><p><code>npm.config</code></p><p>An object for accessing npm configuration parameters.</p><ul><li><p><code>npm.config.get(key)</code></p></li><li><code>npm.config.set(key, val)</code></li><li><p><code>npm.config.del(key)</code></p></li></ul></li><li><p><code>npm.dir</code> or <code>npm.root</code></p><p>The <code>node_modules</code> directory where npm will operate.</p></li><li><p><code>npm.prefix</code></p><p>The prefix where npm is operating. (Most often the current working
-directory.)</p></li><li><p><code>npm.cache</code></p><p>The place where npm keeps JSON and tarballs it fetches from the
-registry (or uploads to the registry).</p></li><li><p><code>npm.tmp</code></p><p>npm's temporary working directory.</p></li><li><p><code>npm.deref</code></p><p>Get the "real" name for a command that has either an alias or
-abbreviation.</p></li></ul>
-
-<h2 id="MAGIC">MAGIC</h2>
-
+<h2 id="methods-and-properties">METHODS AND PROPERTIES</h2>
+<ul>
+<li><p><code>npm.load(configs, cb)</code></p>
+<p> Load the configuration params, and call the <code>cb</code> function once the
+ globalconfig and userconfig files have been loaded as well, or on
+ nextTick if they've already been loaded.</p>
+</li>
+<li><p><code>npm.config</code></p>
+<p> An object for accessing npm configuration parameters.</p>
+<ul>
+<li><code>npm.config.get(key)</code></li>
+<li><code>npm.config.set(key, val)</code></li>
+<li><code>npm.config.del(key)</code></li>
+</ul>
+</li>
+<li><p><code>npm.dir</code> or <code>npm.root</code></p>
+<p> The <code>node_modules</code> directory where npm will operate.</p>
+</li>
+<li><p><code>npm.prefix</code></p>
+<p> The prefix where npm is operating. (Most often the current working
+ directory.)</p>
+</li>
+<li><p><code>npm.cache</code></p>
+<p> The place where npm keeps JSON and tarballs it fetches from the
+ registry (or uploads to the registry).</p>
+</li>
+<li><p><code>npm.tmp</code></p>
+<p> npm's temporary working directory.</p>
+</li>
+<li><p><code>npm.deref</code></p>
+<p> Get the "real" name for a command that has either an alias or
+ abbreviation.</p>
+</li>
+</ul>
+<h2 id="magic">MAGIC</h2>
<p>For each of the methods in the <code>npm.commands</code> hash, a method is added to
the npm object, which takes a set of positional string arguments rather
than an array and a callback.</p>
-
<p>If the last argument is a callback, then it will use the supplied
callback. However, if no callback is provided, then it will print out
the error or results.</p>
-
<p>For example, this would work in a node repl:</p>
-
<pre><code>> npm = require("npm")
> npm.load() // wait a sec...
-> npm.install("dnode", "express")</code></pre>
-
-<p>Note that that <em>won't</em> work in a node program, since the <code>install</code>
+> npm.install("dnode", "express")
+</code></pre><p>Note that that <em>won't</em> work in a node program, since the <code>install</code>
method will get called before the configuration load is completed.</p>
-
-<h2 id="ABBREVS">ABBREVS</h2>
-
+<h2 id="abbrevs">ABBREVS</h2>
<p>In order to support <code>npm ins foo</code> instead of <code>npm install foo</code>, the
<code>npm.commands</code> object has a set of abbreviations as well as the full
method names. Use the <code>npm.deref</code> method to find the real name.</p>
-
<p>For example:</p>
-
-<pre><code>var cmd = npm.deref("unp") // cmd === "unpublish"</code></pre>
+<pre><code>var cmd = npm.deref("unp") // cmd === "unpublish"
+</code></pre>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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 — npm@1.4.9</p>
+<p id="footer">npm — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-adduser.html">npm-adduser</a></h1> <p>Add a registry user account</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm adduser</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm adduser
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Create or verify a user named <code><username></code> in the npm registry, and
save the credentials to the <code>.npmrc</code> file.</p>
-
<p>The username, password, and email are read in from prompts.</p>
-
<p>You may use this command to change your email address, but not username
or password.</p>
-
<p>To reset your password, go to <a href="https://npmjs.org/forgot">https://npmjs.org/forgot</a></p>
-
<p>You may use this command multiple times with the same user account to
authorize on a new machine.</p>
-
-<h2 id="CONFIGURATION">CONFIGURATION</h2>
-
+<h2 id="configuration">CONFIGURATION</h2>
<h3 id="registry">registry</h3>
-
-<p>Default: http://registry.npmjs.org/</p>
-
+<p>Default: <a href="http://registry.npmjs.org/">http://registry.npmjs.org/</a></p>
<p>The base URL of the npm package registry.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../misc/npm-registry.html">npm-registry(7)</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="../cli/npm-owner.html">npm-owner(1)</a></li>
+<li><a href="../cli/npm-whoami.html">npm-whoami(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../misc/npm-registry.html">npm-registry(7)</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="../cli/npm-owner.html">npm-owner(1)</a></li><li><a href="../cli/npm-whoami.html">npm-whoami(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-adduser — npm@1.4.9</p>
+<p id="footer">npm-adduser — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-bin.html">npm-bin</a></h1> <p>Display npm bin folder</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm bin</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm bin
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Print the folder where npm will install executables.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-prefix.html">npm-prefix(1)</a></li>
+<li><a href="../cli/npm-root.html">npm-root(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>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-prefix.html">npm-prefix(1)</a></li><li><a href="../cli/npm-root.html">npm-root(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>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-bin — npm@1.4.9</p>
+<p id="footer">npm-bin — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-bugs.html">npm-bugs</a></h1> <p>Bugs for a package in a web browser maybe</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm bugs <pkgname>
-npm bugs (with no args in a package dir)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm bugs (with no args in a package dir)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command tries to guess at the likely location of a package's
bug tracker URL, and then tries to open it using the <code>--browser</code>
config param. If no package name is provided, it will search for
a <code>package.json</code> in the current folder and use the <code>name</code> property.</p>
-
-<h2 id="CONFIGURATION">CONFIGURATION</h2>
-
+<h2 id="configuration">CONFIGURATION</h2>
<h3 id="browser">browser</h3>
-
-<ul><li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li><li>Type: String</li></ul>
-
+<ul>
+<li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li>
+<li>Type: String</li>
+</ul>
<p>The browser that is called by the <code>npm bugs</code> command to open websites.</p>
-
<h3 id="registry">registry</h3>
-
-<ul><li>Default: https://registry.npmjs.org/</li><li>Type: url</li></ul>
-
+<ul>
+<li>Default: <a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a></li>
+<li>Type: url</li>
+</ul>
<p>The base URL of the npm package registry.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-docs.html">npm-docs(1)</a></li>
+<li><a href="../cli/npm-view.html">npm-view(1)</a></li>
+<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
+<li><a href="../misc/npm-registry.html">npm-registry(7)</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="../files/package.json.html">package.json(5)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-docs.html">npm-docs(1)</a></li><li><a href="../cli/npm-view.html">npm-view(1)</a></li><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</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="../files/package.json.html">package.json(5)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-bugs — npm@1.4.9</p>
+<p id="footer">npm-bugs — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-build.html">npm-build</a></h1> <p>Build a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm build <package-folder></code></pre>
-
-<ul><li><code><package-folder></code>:
-A folder containing a <code>package.json</code> file in its root.</li></ul>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm build <package-folder>
+</code></pre><ul>
+<li><code><package-folder></code>:
+A folder containing a <code>package.json</code> file in its root.</li>
+</ul>
+<h2 id="description">DESCRIPTION</h2>
<p>This is the plumbing command called by <code>npm link</code> and <code>npm install</code>.</p>
-
<p>It should generally not be called directly.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
+<li><a href="../cli/npm-link.html">npm-link(1)</a></li>
+<li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li>
+<li><a href="../files/package.json.html">package.json(5)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../cli/npm-link.html">npm-link(1)</a></li><li><a href="../misc/npm-scripts.html">npm-scripts(7)</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: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-build — npm@1.4.9</p>
+<p id="footer">npm-build — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-bundle.html">npm-bundle</a></h1> <p>REMOVED</p>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="description">DESCRIPTION</h2>
<p>The <code>npm bundle</code> command has been removed in 1.0, for the simple reason
that it is no longer necessary, as the default behavior is now to
install packages into the local space.</p>
-
<p>Just use <code>npm install</code> now to do what <code>npm bundle</code> used to do.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-install.html">npm-install(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-bundle — npm@1.4.9</p>
+<p id="footer">npm-bundle — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-cache.html">npm-cache</a></h1> <p>Manipulates packages cache</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm cache add <tarball file>
npm cache add <folder>
npm cache add <tarball url>
npm cache ls [<path>]
-npm cache clean [<path>]</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm cache clean [<path>]
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Used to add, list, or clear the npm cache folder.</p>
-
+<ul>
+<li><p>add:
Add the specified package to the local cache. This command is primarily
intended to be used internally by npm, but it can provide a way to
-add data to the local installation cache explicitly.</p></li><li><p>ls:
+add data to the local installation cache explicitly.</p>
+</li>
+<li><p>ls:
Show the data in the cache. Argument is a path to show in the cache
folder. Works a bit like the <code>find</code> program, but limited by the
-<code>depth</code> config.</p></li><li><p>clean:
+<code>depth</code> config.</p>
+</li>
+<li><p>clean:
Delete data out of the cache folder. If an argument is provided, then
it specifies a subpath to delete. If no argument is provided, then
-the entire cache is cleared.</p></li></ul>
-
-<h2 id="DETAILS">DETAILS</h2>
-
+the entire cache is cleared.</p>
+</li>
+</ul>
+<h2 id="details">DETAILS</h2>
<p>npm stores cache data in the directory specified in <code>npm config get cache</code>.
For each package that is added to the cache, three pieces of information are
stored in <code>{cache}/{name}/{version}</code>:</p>
-
-<ul><li>.../package/:
-A folder containing the package contents as they appear in the tarball.</li><li>.../package.json:
-The package.json file, as npm sees it, with overlays applied and a _id attribute.</li><li>.../package.tgz:
-The tarball for that version.</li></ul>
-
+<ul>
+<li>.../package/:
+A folder containing the package contents as they appear in the tarball.</li>
+<li>.../package.json:
+The package.json file, as npm sees it, with overlays applied and a _id attribute.</li>
+<li>.../package.tgz:
+The tarball for that version.</li>
+</ul>
<p>Additionally, whenever a registry request is made, a <code>.cache.json</code> file
is placed at the corresponding URI, to store the ETag and the requested
data.</p>
-
<p>Commands that make non-essential registry requests (such as <code>search</code> and
<code>view</code>, or the completion scripts) generally specify a minimum timeout.
If the <code>.cache.json</code> file is younger than the specified timeout, then
they do not make an HTTP request to the registry.</p>
-
-<h2 id="CONFIGURATION">CONFIGURATION</h2>
-
+<h2 id="configuration">CONFIGURATION</h2>
<h3 id="cache">cache</h3>
-
<p>Default: <code>~/.npm</code> on Posix, or <code>%AppData%/npm-cache</code> on Windows.</p>
-
<p>The root cache folder.</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-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="../cli/npm-install.html">npm-install(1)</a></li>
+<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
+<li><a href="../cli/npm-pack.html">npm-pack(1)</a></li>
+</ul>
-<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-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="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../cli/npm-pack.html">npm-pack(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-cache — npm@1.4.9</p>
+<p id="footer">npm-cache — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-completion.html">npm-completion</a></h1> <p>Tab Completion for npm</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>. <(npm completion)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>. <(npm completion)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Enables tab-completion in all npm commands.</p>
-
<p>The synopsis above
loads the completions into your current shell. Adding it to
your ~/.bashrc or ~/.zshrc will make the completions available
everywhere.</p>
-
<p>You may of course also pipe the output of npm completion to a file
such as <code>/usr/local/etc/bash_completion.d/npm</code> if you have a system
that will read that file for you.</p>
-
<p>When <code>COMP_CWORD</code>, <code>COMP_LINE</code>, and <code>COMP_POINT</code> are defined in the
environment, <code>npm completion</code> acts in "plumbing mode", and outputs
completions based on the arguments.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<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="../cli/npm.html">npm(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<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="../cli/npm.html">npm(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-completion — npm@1.4.9</p>
+<p id="footer">npm-completion — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-config.html">npm-config</a></h1> <p>Manage the npm configuration files</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm config set <key> <value> [--global]
npm config get <key>
npm config delete <key>
npm config edit
npm c [set|get|delete|list]
npm get <key>
-npm set <key> <value> [--global]</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm set <key> <value> [--global]
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>npm gets its config settings from the command line, environment
variables, <code>npmrc</code> files, and in some cases, the <code>package.json</code> file.</p>
-
<p>See <a href="../files/npmrc.html">npmrc(5)</a> for more information about the npmrc files.</p>
-
<p>See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> for a more thorough discussion of the mechanisms
involved.</p>
-
<p>The <code>npm config</code> command can be used to update and edit the contents
of the user and global npmrc files.</p>
-
-<h2 id="Sub-commands">Sub-commands</h2>
-
+<h2 id="sub-commands">Sub-commands</h2>
<p>Config supports the following sub-commands:</p>
-
<h3 id="set">set</h3>
-
-<pre><code>npm config set key value</code></pre>
-
-<p>Sets the config key to the value.</p>
-
+<pre><code>npm config set key value
+</code></pre><p>Sets the config key to the value.</p>
<p>If value is omitted, then it sets it to "true".</p>
-
<h3 id="get">get</h3>
-
-<pre><code>npm config get key</code></pre>
-
-<p>Echo the config value to stdout.</p>
-
+<pre><code>npm config get key
+</code></pre><p>Echo the config value to stdout.</p>
<h3 id="list">list</h3>
-
-<pre><code>npm config list</code></pre>
-
-<p>Show all the config settings.</p>
-
+<pre><code>npm config list
+</code></pre><p>Show all the config settings.</p>
<h3 id="delete">delete</h3>
-
-<pre><code>npm config delete key</code></pre>
-
-<p>Deletes the key from all configuration files.</p>
-
+<pre><code>npm config delete key
+</code></pre><p>Deletes the key from all configuration files.</p>
<h3 id="edit">edit</h3>
-
-<pre><code>npm config edit</code></pre>
-
-<p>Opens the config file in an editor. Use the <code>--global</code> flag to edit the
+<pre><code>npm config edit
+</code></pre><p>Opens the config file in an editor. Use the <code>--global</code> flag to edit the
global config.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
+<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
+<li><a href="../files/package.json.html">package.json(5)</a></li>
+<li><a href="../files/npmrc.html">npmrc(5)</a></li>
+<li><a href="../cli/npm.html">npm(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../cli/npm.html">npm(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-config — npm@1.4.9</p>
+<p id="footer">npm-config — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-dedupe.html">npm-dedupe</a></h1> <p>Reduce duplication</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm dedupe [package names...]
-npm ddp [package names...]</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm ddp [package names...]
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Searches the local package tree and attempts to simplify the overall
structure by moving dependencies further up the tree, where they can
be more effectively shared by multiple dependent packages.</p>
-
<p>For example, consider this dependency graph:</p>
-
<pre><code>a
+-- b <-- depends on c@1.0.x
| `-- c@1.0.3
`-- d <-- depends on c@~1.0.9
- `-- c@1.0.10</code></pre>
-
-<p>In this case, <code><a href="../cli/npm-dedupe.html">npm-dedupe(1)</a></code> will transform the tree to:</p>
-
+ `-- c@1.0.10
+</code></pre><p>In this case, <code><a href="../cli/npm-dedupe.html">npm-dedupe(1)</a></code> will transform the tree to:</p>
<pre><code>a
+-- b
+-- d
-`-- c@1.0.10</code></pre>
-
-<p>Because of the hierarchical nature of node's module lookup, b and d
+`-- c@1.0.10
+</code></pre><p>Because of the hierarchical nature of node's module lookup, b and d
will both get their dependency met by the single c package at the root
level of the tree.</p>
-
<p>If a suitable version exists at the target location in the tree
already, then it will be left untouched, but the other duplicates will
be deleted.</p>
-
<p>If no suitable version can be found, then a warning is printed, and
nothing is done.</p>
-
<p>If any arguments are supplied, then they are filters, and only the
named packages will be touched.</p>
-
<p>Note that this operation transforms the dependency tree, and may
result in packages getting updated versions, perhaps from the npm
registry.</p>
-
<p>This feature is experimental, and may change in future versions.</p>
-
<p>The <code>--tag</code> argument will apply to all of the affected dependencies. If a
tag with the given name exists, the tagged version is preferred over newer
versions.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-ls.html">npm-ls(1)</a></li>
+<li><a href="../cli/npm-update.html">npm-update(1)</a></li>
+<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-ls.html">npm-ls(1)</a></li><li><a href="../cli/npm-update.html">npm-update(1)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-dedupe — npm@1.4.9</p>
+<p id="footer">npm-dedupe — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-deprecate.html">npm-deprecate</a></h1> <p>Deprecate a version of a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm deprecate <name>[@<version>] <message></code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm deprecate <name>[@<version>] <message>
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command will update the npm registry entry for a package, providing
a deprecation warning to all who attempt to install it.</p>
-
<p>It works on version ranges as well as specific versions, so you can do
something like this:</p>
-
-<pre><code>npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3"</code></pre>
-
-<p>Note that you must be the package owner to deprecate something. See the
+<pre><code>npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3"
+</code></pre><p>Note that you must be the package owner to deprecate something. See the
<code>owner</code> and <code>adduser</code> help topics.</p>
-
<p>To un-deprecate a package, specify an empty string (<code>""</code>) for the <code>message</code> argument.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
+<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-deprecate — npm@1.4.9</p>
+<p id="footer">npm-deprecate — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-docs.html">npm-docs</a></h1> <p>Docs for a package in a web browser maybe</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm docs [<pkgname> [<pkgname> ...]]
npm docs (with no args in a package dir)
npm home [<pkgname> [<pkgname> ...]]
-npm home (with no args in a package dir)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm home (with no args in a package dir)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command tries to guess at the likely location of a package's
documentation URL, and then tries to open it using the <code>--browser</code>
config param. You can pass multiple package names at once. If no
package name is provided, it will search for a <code>package.json</code> in
the current folder and use the <code>name</code> property.</p>
-
-<h2 id="CONFIGURATION">CONFIGURATION</h2>
-
+<h2 id="configuration">CONFIGURATION</h2>
<h3 id="browser">browser</h3>
-
-<ul><li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li><li>Type: String</li></ul>
-
+<ul>
+<li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li>
+<li>Type: String</li>
+</ul>
<p>The browser that is called by the <code>npm docs</code> command to open websites.</p>
-
<h3 id="registry">registry</h3>
-
-<ul><li>Default: https://registry.npmjs.org/</li><li>Type: url</li></ul>
-
+<ul>
+<li>Default: <a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a></li>
+<li>Type: url</li>
+</ul>
<p>The base URL of the npm package registry.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-view.html">npm-view(1)</a></li>
+<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
+<li><a href="../misc/npm-registry.html">npm-registry(7)</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="../files/package.json.html">package.json(5)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-view.html">npm-view(1)</a></li><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</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="../files/package.json.html">package.json(5)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-docs — npm@1.4.9</p>
+<p id="footer">npm-docs — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-edit.html">npm-edit</a></h1> <p>Edit an installed package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm edit <name>[@<version>]</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm edit <name>[@<version>]
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Opens the package folder in the default editor (or whatever you've
configured as the npm <code>editor</code> config -- see <code><a href="../misc/npm-config.html">npm-config(7)</a></code>.)</p>
-
<p>After it has been edited, the package is rebuilt so as to pick up any
changes in compiled packages.</p>
-
<p>For instance, you can do <code>npm install connect</code> to install connect
into your package, and then <code>npm edit connect</code> to make a few
changes to your locally installed copy.</p>
-
-<h2 id="CONFIGURATION">CONFIGURATION</h2>
-
+<h2 id="configuration">CONFIGURATION</h2>
<h3 id="editor">editor</h3>
-
-<ul><li>Default: <code>EDITOR</code> environment variable if set, or <code>"vi"</code> on Posix,
-or <code>"notepad"</code> on Windows.</li><li>Type: path</li></ul>
-
+<ul>
+<li>Default: <code>EDITOR</code> environment variable if set, or <code>"vi"</code> on Posix,
+or <code>"notepad"</code> on Windows.</li>
+<li>Type: path</li>
+</ul>
<p>The command to run for <code>npm edit</code> or <code>npm config edit</code>.</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-explore.html">npm-explore(1)</a></li>
+<li><a href="../cli/npm-install.html">npm-install(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>
+</ul>
-<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-explore.html">npm-explore(1)</a></li><li><a href="../cli/npm-install.html">npm-install(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></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-edit — npm@1.4.9</p>
+<p id="footer">npm-edit — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-explore.html">npm-explore</a></h1> <p>Browse an installed package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm explore <name>[@<version>] [ -- <cmd>]</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm explore <name>[@<version>] [ -- <cmd>]
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Spawn a subshell in the directory of the installed package specified.</p>
-
<p>If a command is specified, then it is run in the subshell, which then
immediately terminates.</p>
-
<p>This is particularly handy in the case of git submodules in the
<code>node_modules</code> folder:</p>
-
-<pre><code>npm explore some-dependency -- git pull origin master</code></pre>
-
-<p>Note that the package is <em>not</em> automatically rebuilt afterwards, so be
+<pre><code>npm explore some-dependency -- git pull origin master
+</code></pre><p>Note that the package is <em>not</em> automatically rebuilt afterwards, so be
sure to use <code>npm rebuild <pkg></code> if you make any changes.</p>
-
-<h2 id="CONFIGURATION">CONFIGURATION</h2>
-
+<h2 id="configuration">CONFIGURATION</h2>
<h3 id="shell">shell</h3>
-
-<ul><li>Default: SHELL environment variable, or "bash" on Posix, or "cmd" on
-Windows</li><li>Type: path</li></ul>
-
+<ul>
+<li>Default: SHELL environment variable, or "bash" on Posix, or "cmd" on
+Windows</li>
+<li>Type: path</li>
+</ul>
<p>The shell to run for the <code>npm explore</code> command.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-submodule.html">npm-submodule(1)</a></li>
+<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
+<li><a href="../cli/npm-edit.html">npm-edit(1)</a></li>
+<li><a href="../cli/npm-rebuild.html">npm-rebuild(1)</a></li>
+<li><a href="../cli/npm-build.html">npm-build(1)</a></li>
+<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-submodule.html">npm-submodule(1)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-edit.html">npm-edit(1)</a></li><li><a href="../cli/npm-rebuild.html">npm-rebuild(1)</a></li><li><a href="../cli/npm-build.html">npm-build(1)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-explore — npm@1.4.9</p>
+<p id="footer">npm-explore — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-help-search.html">npm-help-search</a></h1> <p>Search npm help documentation</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm help-search some search terms</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm help-search some search terms
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command will search the npm markdown documentation files for the
terms provided, and then list the results, sorted by relevance.</p>
-
<p>If only one result is found, then it will show that help topic.</p>
-
<p>If the argument to <code>npm help</code> is not a known help topic, then it will
call <code>help-search</code>. It is rarely if ever necessary to call this
command directly.</p>
-
-<h2 id="CONFIGURATION">CONFIGURATION</h2>
-
+<h2 id="configuration">CONFIGURATION</h2>
<h3 id="long">long</h3>
-
-<ul><li>Type: Boolean</li><li>Default false</li></ul>
-
+<ul>
+<li>Type: Boolean</li>
+<li>Default false</li>
+</ul>
<p>If true, the "long" flag will cause help-search to output context around
where the terms were found in the documentation.</p>
-
<p>If false, then help-search will just list out the help topics found.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm.html">npm(1)</a></li>
+<li><a href="../misc/npm-faq.html">npm-faq(7)</a></li>
+<li><a href="../cli/npm-help.html">npm-help(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm.html">npm(1)</a></li><li><a href="../misc/npm-faq.html">npm-faq(7)</a></li><li><a href="../cli/npm-help.html">npm-help(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-help-search — npm@1.4.9</p>
+<p id="footer">npm-help-search — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-help.html">npm-help</a></h1> <p>Get help on npm</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm help <topic>
-npm help some search terms</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm help some search terms
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>If supplied a topic, then show the appropriate documentation page.</p>
-
<p>If the topic does not exist, or if multiple terms are provided, then run
the <code>help-search</code> command to find a match. Note that, if <code>help-search</code>
finds a single subject, then it will run <code>help</code> on that topic, so unique
matches are equivalent to specifying a topic name.</p>
-
-<h2 id="CONFIGURATION">CONFIGURATION</h2>
-
+<h2 id="configuration">CONFIGURATION</h2>
<h3 id="viewer">viewer</h3>
-
-<ul><li>Default: "man" on Posix, "browser" on Windows</li><li>Type: path</li></ul>
-
+<ul>
+<li>Default: "man" on Posix, "browser" on Windows</li>
+<li>Type: path</li>
+</ul>
<p>The program to use to view help content.</p>
-
<p>Set to <code>"browser"</code> to view html help content in the default web browser.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm.html">npm(1)</a></li>
+<li><a href="../../doc/README.html">README</a></li>
+<li><a href="../misc/npm-faq.html">npm-faq(7)</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>
+<li><a href="../files/package.json.html">package.json(5)</a></li>
+<li><a href="../cli/npm-help-search.html">npm-help-search(1)</a></li>
+<li><a href="../misc/npm-index.html">npm-index(7)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm.html">npm(1)</a></li><li><a href="../../doc/README.html">README</a></li><li><a href="../misc/npm-faq.html">npm-faq(7)</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><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../cli/npm-help-search.html">npm-help-search(1)</a></li><li><a href="../misc/npm-index.html">npm-index(7)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-help — npm@1.4.9</p>
+<p id="footer">npm-help — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-init.html">npm-init</a></h1> <p>Interactively create a package.json file</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm init</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm init
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This will ask you a bunch of questions, and then write a package.json for you.</p>
-
<p>It attempts to make reasonable guesses about what you want things to be set to,
and then writes a package.json file with the options you've selected.</p>
-
<p>If you already have a package.json file, it'll read that first, and default to
the options in there.</p>
-
<p>It is strictly additive, so it does not delete options from your package.json
without a really good reason to do so.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="https://github.com/isaacs/init-package-json">https://github.com/isaacs/init-package-json</a></li>
+<li><a href="../files/package.json.html">package.json(5)</a></li>
+<li><a href="../cli/npm-version.html">npm-version(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="https://github.com/isaacs/init-package-json">https://github.com/isaacs/init-package-json</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../cli/npm-version.html">npm-version(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-init — npm@1.4.9</p>
+<p id="footer">npm-init — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-install.html">npm-install</a></h1> <p>Install a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm install (with no args in a package dir)
npm install <tarball file>
npm install <tarball url>
npm install <name>@<tag>
npm install <name>@<version>
npm install <name>@<version range>
-npm i (with any of the previous argument usage)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm i (with any of the previous argument usage)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command installs a package, and any packages that it depends on. If the
package has a shrinkwrap file, the installation of dependencies will be driven
by that. See <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 package.json file</li><li>b) a gzipped tarball containing (a)</li><li>c) a url that resolves to (b)</li><li>d) a <code><name>@<version></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><name>@<tag></code> that points to (d)</li><li>f) a <code><name></code> that has a "latest" tag satisfying (e)</li><li>g) a <code><git remote url></code> that resolves to (b)</li></ul>
-
+<ul>
+<li>a) a folder containing a program described by a package.json file</li>
+<li>b) a gzipped tarball containing (a)</li>
+<li>c) a url that resolves to (b)</li>
+<li>d) a <code><name>@<version></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><name>@<tag></code> that points to (d)</li>
+<li>f) a <code><name></code> that has a "latest" tag satisfying (e)</li>
+<li>g) a <code><git remote url></code> that resolves to (b)</li>
+</ul>
<p>Even if you never publish your package, you can still get a lot of
benefits of using npm if you just want to write a node program (a), and
perhaps if you also want to be able to easily install it elsewhere
after 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. With the <code>--production</code> flag,
-npm will not install modules listed in <code>devDependencies</code>.</p></li><li><p><code>npm install <folder></code>:</p><p>Install a package that is sitting in a folder on the filesystem.</p></li><li><p><code>npm install <tarball file></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>Example:</p><pre><code> npm install ./package.tgz</code></pre></li><li><p><code>npm install <tarball url></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 "http://" or "https://"</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 <name> [--save|--save-dev|--save-optional]</code>:</p><p>Do a <code><name>@<tag></code> install, where <code><tag></code> is the "tag" config. (See
-<code><a href="../misc/npm-config.html">npm-config(7)</a></code>.)</p><p>In most cases, this will install the latest version
-of the module published on npm.</p><p>Example:</p><p> npm install sax</p><p><code>npm install</code> takes 3 exclusive, optional flags which save or update
-the package version in your main package.json:</p><ul><li><p><code>--save</code>: Package will appear in your <code>dependencies</code>.</p></li><li><p><code>--save-dev</code>: Package will appear in your <code>devDependencies</code>.</p></li><li><p><code>--save-optional</code>: Package will appear in your <code>optionalDependencies</code>.</p><p>When using any of the above options to save dependencies to your
-package.json, there is an additional, optional flag:</p></li><li><p><code>--save-exact</code>: Saved dependencies will be configured with an
+<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. With the <code>--production</code> flag,
+ npm will not install modules listed in <code>devDependencies</code>.</p>
+</li>
+<li><p><code>npm install <folder></code>:</p>
+<p> Install a package that is sitting in a folder on the filesystem.</p>
+</li>
+<li><p><code>npm install <tarball file></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> Example:</p>
+<pre><code> npm install ./package.tgz
+</code></pre></li>
+<li><p><code>npm install <tarball url></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 "http://" or "https://"</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 <name> [--save|--save-dev|--save-optional]</code>:</p>
+<p> Do a <code><name>@<tag></code> install, where <code><tag></code> is the "tag" config. (See
+ <code><a href="../misc/npm-config.html">npm-config(7)</a></code>.)</p>
+<p> In most cases, this will install the latest version
+ of the module published on npm.</p>
+<p> Example:</p>
+<pre><code> npm install sax
+</code></pre><p> <code>npm install</code> takes 3 exclusive, optional flags which save or update
+ the package version in your main package.json:</p>
+<ul>
+<li><p><code>--save</code>: Package will appear in your <code>dependencies</code>.</p>
+</li>
+<li><p><code>--save-dev</code>: Package will appear in your <code>devDependencies</code>.</p>
+</li>
+<li><p><code>--save-optional</code>: Package will appear in your <code>optionalDependencies</code>.</p>
+<p>When using any of the above options to save dependencies to your
+package.json, there is an additional, optional flag:</p>
+</li>
+<li><p><code>--save-exact</code>: Saved dependencies will be configured with an
exact version rather than using npm's default semver range
-operator.</p><p>Examples:</p><p> npm install sax --save
- npm install node-tap --save-dev
- npm install dtrace-provider --save-optional
- npm install readable-stream --save --save-exact</p><p><strong>Note</strong>: If there is a file or folder named <code><name></code> in the current
+operator.</p>
+<p>Examples:</p>
+<pre><code>npm install sax --save
+npm install node-tap --save-dev
+npm install dtrace-provider --save-optional
+npm install readable-stream --save --save-exact
+</code></pre></li>
+</ul>
+</li>
+</ul>
+<pre><code>**Note**: If there is a file or folder named `<name>` in the current
working directory, then it will try to install that, and only try to
-fetch the package by name if it is not valid.</p></li></ul></li><li><p><code>npm install <name>@<tag></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</code></pre></li><li><p><code>npm install <name>@<version></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</code></pre></li><li><p><code>npm install <name>@<version range></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><p> npm install sax@">=0.1.0 <0.2.0"</p></li><li><p><code>npm install <git remote url></code>:</p><p>Install a package by cloning a git remote url. The format of the git
-url is:</p><p> <protocol>://[<user>@]<hostname><separator><path>[#<commit-ish>]</p><p><code><protocol></code> is one of <code>git</code>, <code>git+ssh</code>, <code>git+http</code>, or
-<code>git+https</code>. If no <code><commit-ish></code> is specified, then <code>master</code> is
-used.</p><p>Examples:</p><pre><code> git+ssh://git@github.com:npm/npm.git#v1.0.27
- git+https://isaacs@github.com/npm/npm.git
- git://github.com/npm/npm.git#v1.0.27</code></pre></li></ul>
-
+fetch the package by name if it is not valid.
+</code></pre><ul>
+<li><p><code>npm install <name>@<tag></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
+</code></pre></li>
+<li><p><code>npm install <name>@<version></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
+</code></pre></li>
+<li><p><code>npm install <name>@<version range></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@">=0.1.0 <0.2.0"
+</code></pre></li>
+<li><p><code>npm install <git remote url></code>:</p>
+<p> Install a package by cloning a git remote url. The format of the git
+ url is:</p>
+<pre><code> <protocol>://[<user>@]<hostname><separator><path>[#<commit-ish>]
+</code></pre><p> <code><protocol></code> is one of <code>git</code>, <code>git+ssh</code>, <code>git+http</code>, or
+ <code>git+https</code>. If no <code><commit-ish></code> is specified, then <code>master</code> is
+ used.</p>
+<p> Examples:</p>
+<pre><code> git+ssh://git@github.com:npm/npm.git#v1.0.27
+ git+https://isaacs@github.com/npm/npm.git
+ git://github.com/npm/npm.git#v1.0.27
+</code></pre></li>
+</ul>
<p>You may combine multiple arguments, and even multiple types of arguments.
For example:</p>
-
-<pre><code>npm install sax@">=0.1.0 <0.2.0" bench supervisor</code></pre>
-
-<p>The <code>--tag</code> argument will apply to all of the specified install targets. If a
+<pre><code>npm install sax@">=0.1.0 <0.2.0" bench supervisor
+</code></pre><p>The <code>--tag</code> argument will apply to all of the specified install targets. If a
tag with the given name exists, the tagged version is preferred over newer
versions.</p>
-
<p>The <code>--force</code> argument will force npm to fetch remote resources even if a
local copy exists on disk.</p>
-
-<pre><code>npm install sax --force</code></pre>
-
-<p>The <code>--global</code> argument will cause npm to install the package globally
+<pre><code>npm install sax --force
+</code></pre><p>The <code>--global</code> argument will cause npm to install the package globally
rather than locally. See <code><a href="../files/npm-folders.html">npm-folders(5)</a></code>.</p>
-
<p>The <code>--link</code> argument will cause npm to link global installs into the
local space in some cases.</p>
-
<p>The <code>--no-bin-links</code> argument will prevent npm from creating symlinks for
any binaries the package might contain.</p>
-
<p>The <code>--no-optional</code> argument will prevent optional dependencies from
being installed.</p>
-
<p>The <code>--no-shrinkwrap</code> argument, which will ignore an available
shrinkwrap file and use the package.json instead.</p>
-
<p>The <code>--nodedir=/path/to/node/source</code> argument will allow npm to find the
node source code so that npm can compile native modules.</p>
-
<p>See <code><a href="../misc/npm-config.html">npm-config(7)</a></code>. Many of the configuration params have some
effect on installation, since that's most of what npm does.</p>
-
-<h2 id="ALGORITHM">ALGORITHM</h2>
-
+<h2 id="algorithm">ALGORITHM</h2>
<p>To install a package, npm uses the following algorithm:</p>
-
<pre><code>install(where, what, family, ancestors)
fetch what, unpack to <where>/node_modules/<what>
for each dep in what.dependencies
not in <where>/node_modules/<what>/node_modules/*
and not in <family>
add precise version deps to <family>
- install(<where>/node_modules/<what>, dep, family)</code></pre>
-
-<p>For this <code>package{dep}</code> structure: <code>A{B,C}, B{C}, C{D}</code>,
+ install(<where>/node_modules/<what>, dep, family)
+</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 A
+ `-- D
+</code></pre><p>That is, the dependency from B to C is satisfied by the fact that A
already caused C to be installed at a higher level.</p>
-
<p>See <a href="../files/npm-folders.html">npm-folders(5)</a> for a more detailed description of the specific
folder structures that npm creates.</p>
-
-<h3 id="Limitations-of-npm-s-Install-Algorithm">Limitations of npm's Install Algorithm</h3>
-
+<h3 id="limitations-of-npm-s-install-algorithm">Limitations of npm's Install Algorithm</h3>
<p>There are some very rare and pathological edge-cases where a cycle can
cause npm to try to install a never-ending tree of packages. Here is
the simplest case:</p>
-
-<pre><code>A -> B -> A' -> B' -> A -> B -> A' -> B' -> A -> ...</code></pre>
-
-<p>where <code>A</code> is some version of a package, and <code>A'</code> is a different version
+<pre><code>A -> B -> A' -> B' -> A -> B -> A' -> B' -> A -> ...
+</code></pre><p>where <code>A</code> is some version of a package, and <code>A'</code> is a different version
of 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 separate
copy. The same is true of <code>A'</code>, which must install <code>B'</code>. Because <code>B'</code>
depends on the original version of <code>A</code>, which has been overridden, the
cycle 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 package
folder ancestors. A more correct, but more complex, solution would be
to symlink the existing version into the new location. If this ever
affects 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-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-tag.html">npm-tag(1)</a></li>
+<li><a href="../cli/npm-rm.html">npm-rm(1)</a></li>
+<li><a href="../cli/npm-shrinkwrap.html">npm-shrinkwrap(1)</a></li>
+</ul>
-<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-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-tag.html">npm-tag(1)</a></li><li><a href="../cli/npm-rm.html">npm-rm(1)</a></li><li><a href="../cli/npm-shrinkwrap.html">npm-shrinkwrap(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-install — npm@1.4.9</p>
+<p id="footer">npm-install — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-link.html">npm-link</a></h1> <p>Symlink a package folder</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm link (in package folder)
npm link <pkgname>
-npm ln (with any of the previous argument usage)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm ln (with any of the previous argument usage)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Package linking is a two-step process.</p>
-
<p>First, <code>npm link</code> in a package folder will create a globally-installed
symbolic link from <code>prefix/package-name</code> to the current folder.</p>
-
<p>Next, in some other location, <code>npm link package-name</code> will create a
symlink from the local <code>node_modules</code> folder to the global symlink.</p>
-
<p>Note that <code>package-name</code> is taken from <code>package.json</code>,
not from directory name.</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>cd ~/projects/node-redis # go into the package directory
npm link # creates global link
cd ~/projects/node-bloggy # go into some other package directory.
-npm link redis # link-install the package</code></pre>
-
-<p>Now, any changes to ~/projects/node-redis will be reflected in
+npm link redis # link-install the package
+</code></pre><p>Now, any changes to ~/projects/node-redis will be reflected in
~/projects/node-bloggy/node_modules/redis/</p>
-
<p>You may also shortcut the two steps in one. For example, to do the
above use-case in a shorter way:</p>
-
<pre><code>cd ~/projects/node-bloggy # go into the dir of your main project
-npm link ../node-redis # link the dir of your dependency</code></pre>
-
-<p>The second line is the equivalent of doing:</p>
-
+npm link ../node-redis # link the dir of your dependency
+</code></pre><p>The second line is the equivalent of doing:</p>
<pre><code>(cd ../node-redis; npm link)
-npm link redis</code></pre>
-
-<p>That is, it first creates a global link, and then links the global
+npm link redis
+</code></pre><p>That is, it first creates a global link, and then links the global
installation target into your project's <code>node_modules</code> folder.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<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>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<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>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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@1.4.9</p>
+<p id="footer">npm-link — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-ls.html">npm-ls</a></h1> <p>List installed packages</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm list [<pkg> ...]
npm ls [<pkg> ...]
npm la [<pkg> ...]
-npm ll [<pkg> ...]</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm ll [<pkg> ...]
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command will print to stdout all the versions of packages that are
installed, as well as their dependencies, in a tree-structure.</p>
-
<p>Positional arguments are <code>name@version-range</code> identifiers, which will
limit the results to only the paths to the packages named. Note that
nested packages will <em>also</em> show the paths to the specified packages.
For example, running <code>npm ls promzard</code> in npm's source tree will show:</p>
-
-<pre><code>npm@1.4.9 /path/to/npm
+<pre><code>npm@1.4.10 /path/to/npm
└─┬ init-package-json@0.0.4
- └── promzard@0.1.5</code></pre>
-
-<p>It will print out extraneous, missing, and invalid packages.</p>
-
+ └── promzard@0.1.5
+</code></pre><p>It will print out extraneous, missing, and invalid packages.</p>
<p>If a project specifies git urls for dependencies these are shown
in parentheses after the name@version to make it easier for users to
recognize potential forks of a project.</p>
-
<p>When run as <code>ll</code> or <code>la</code>, it shows extended information by default.</p>
-
-<h2 id="CONFIGURATION">CONFIGURATION</h2>
-
+<h2 id="configuration">CONFIGURATION</h2>
<h3 id="json">json</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Show information in JSON format.</p>
-
<h3 id="long">long</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Show extended information.</p>
-
<h3 id="parseable">parseable</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Show parseable output instead of tree view.</p>
-
<h3 id="global">global</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>List packages in the global install prefix instead of in the current
project.</p>
-
<h3 id="depth">depth</h3>
-
-<ul><li>Type: Int</li></ul>
-
+<ul>
+<li>Type: Int</li>
+</ul>
<p>Max display depth of the dependency tree.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<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="../files/npm-folders.html">npm-folders(5)</a></li>
+<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
+<li><a href="../cli/npm-link.html">npm-link(1)</a></li>
+<li><a href="../cli/npm-prune.html">npm-prune(1)</a></li>
+<li><a href="../cli/npm-outdated.html">npm-outdated(1)</a></li>
+<li><a href="../cli/npm-update.html">npm-update(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><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="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../cli/npm-link.html">npm-link(1)</a></li><li><a href="../cli/npm-prune.html">npm-prune(1)</a></li><li><a href="../cli/npm-outdated.html">npm-outdated(1)</a></li><li><a href="../cli/npm-update.html">npm-update(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-ls — npm@1.4.9</p>
+<p id="footer">npm-ls — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-outdated.html">npm-outdated</a></h1> <p>Check for outdated packages</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm outdated [<name> [<name> ...]]</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm outdated [<name> [<name> ...]]
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command will check the registry to see if any (or, specific) installed
packages are currently outdated.</p>
-
<p>The resulting field 'wanted' shows the latest version according to the
version specified in the package.json, the field 'latest' the very latest
version of the package.</p>
-
-<h2 id="CONFIGURATION">CONFIGURATION</h2>
-
+<h2 id="configuration">CONFIGURATION</h2>
<h3 id="json">json</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Show information in JSON format.</p>
-
<h3 id="long">long</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Show extended information.</p>
-
<h3 id="parseable">parseable</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Show parseable output instead of tree view.</p>
-
<h3 id="global">global</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Check packages in the global install prefix instead of in the current
project.</p>
-
<h3 id="depth">depth</h3>
-
-<ul><li>Type: Int</li></ul>
-
+<ul>
+<li>Type: Int</li>
+</ul>
<p>Max depth for checking dependency tree.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-update.html">npm-update(1)</a></li>
+<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
+<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-update.html">npm-update(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-outdated — npm@1.4.9</p>
+<p id="footer">npm-outdated — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-owner.html">npm-owner</a></h1> <p>Manage package owners</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm owner ls <package name>
npm owner add <user> <package name>
-npm owner rm <user> <package name></code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm owner rm <user> <package name>
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Manage ownership of published packages.</p>
-
-<ul><li>ls:
+<ul>
+<li>ls:
List all the users who have access to modify a package and push new versions.
-Handy when you need to know who to bug for help.</li><li>add:
+Handy when you need to know who to bug for help.</li>
+<li>add:
Add a new user as a maintainer of a package. This user is enabled to modify
-metadata, publish new versions, and add other owners.</li><li>rm:
+metadata, publish new versions, and add other owners.</li>
+<li>rm:
Remove a user from the package owner list. This immediately revokes their
-privileges.</li></ul>
-
+privileges.</li>
+</ul>
<p>Note that there is only one level of access. Either you can modify a package,
or you can't. Future versions may contain more fine-grained access levels, but
that is not implemented at this time.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
+<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
+<li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li>
+<li><a href="../misc/npm-disputes.html">npm-disputes(7)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li><li><a href="../misc/npm-disputes.html">npm-disputes(7)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-owner — npm@1.4.9</p>
+<p id="footer">npm-owner — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-pack.html">npm-pack</a></h1> <p>Create a tarball from a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm pack [<pkg> [<pkg> ...]]</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm pack [<pkg> [<pkg> ...]]
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>For anything that's installable (that is, a package folder, tarball,
tarball url, name@tag, name@version, or name), this command will fetch
it to the cache, and then copy the tarball to the current working
directory as <code><name>-<version>.tgz</code>, and then write the filenames out to
stdout.</p>
-
<p>If the same package is specified multiple times, then the file will be
overwritten the second time.</p>
-
<p>If no arguments are supplied, then npm packs the current package folder.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-cache.html">npm-cache(1)</a></li>
+<li><a href="../cli/npm-publish.html">npm-publish(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>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-cache.html">npm-cache(1)</a></li><li><a href="../cli/npm-publish.html">npm-publish(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></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-pack — npm@1.4.9</p>
+<p id="footer">npm-pack — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-prefix.html">npm-prefix</a></h1> <p>Display prefix</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm prefix</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm prefix
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Print the prefix to standard out.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-root.html">npm-root(1)</a></li>
+<li><a href="../cli/npm-bin.html">npm-bin(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>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-root.html">npm-root(1)</a></li><li><a href="../cli/npm-bin.html">npm-bin(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>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-prefix — npm@1.4.9</p>
+<p id="footer">npm-prefix — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-prune.html">npm-prune</a></h1> <p>Remove extraneous packages</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm prune [<name> [<name ...]]
-npm prune [<name> [<name ...]] [--production]</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm prune [<name> [<name ...]] [--production]
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command removes "extraneous" packages. If a package name is
provided, then only packages matching one of the supplied names are
removed.</p>
-
<p>Extraneous packages are packages that are not listed on the parent
package's dependencies list.</p>
-
<p>If the <code>--production</code> flag is specified, this command will remove the
packages specified in your <code>devDependencies</code>.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-rm.html">npm-rm(1)</a></li>
+<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
+<li><a href="../cli/npm-ls.html">npm-ls(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-rm.html">npm-rm(1)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-ls.html">npm-ls(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-prune — npm@1.4.9</p>
+<p id="footer">npm-prune — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-publish.html">npm-publish</a></h1> <p>Publish a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm publish <tarball> [--tag <tag>]
-npm publish <folder> [--tag <tag>]</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm publish <folder> [--tag <tag>]
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Publishes a package to the registry so that it can be installed by name.</p>
-
-<ul><li><p><code><folder></code>:
-A folder containing a package.json file</p></li><li><p><code><tarball></code>:
+<ul>
+<li><p><code><folder></code>:
+A folder containing a package.json file</p>
+</li>
+<li><p><code><tarball></code>:
A url or file path to a gzipped tar archive containing a single folder
-with a package.json file inside.</p></li><li><p><code>[--tag <tag>]</code>
+with a package.json file inside.</p>
+</li>
+<li><p><code>[--tag <tag>]</code>
Registers the published package with the given tag, such that <code>npm install
<name>@<tag></code> will install this version. By default, <code>npm publish</code> updates
-and <code>npm install</code> installs the <code>latest</code> tag.</p></li></ul>
-
+and <code>npm install</code> installs the <code>latest</code> tag.</p>
+</li>
+</ul>
<p>Fails if the package name and version combination already exists in
the registry.</p>
-
<p>Once a package is published with a given name and version, that
specific name and version combination can never be used again, even if
it is removed with <a href="../cli/npm-unpublish.html">npm-unpublish(1)</a>.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
+<li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li>
+<li><a href="../cli/npm-owner.html">npm-owner(1)</a></li>
+<li><a href="../cli/npm-deprecate.html">npm-deprecate(1)</a></li>
+<li><a href="../cli/npm-tag.html">npm-tag(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li><li><a href="../cli/npm-owner.html">npm-owner(1)</a></li><li><a href="../cli/npm-deprecate.html">npm-deprecate(1)</a></li><li><a href="../cli/npm-tag.html">npm-tag(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-publish — npm@1.4.9</p>
+<p id="footer">npm-publish — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-rebuild.html">npm-rebuild</a></h1> <p>Rebuild a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm rebuild [<name> [<name> ...]]
-npm rb [<name> [<name> ...]]</code></pre>
-
-<ul><li><code><name></code>:
-The package to rebuild</li></ul>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm rb [<name> [<name> ...]]
+</code></pre><ul>
+<li><code><name></code>:
+The package to rebuild</li>
+</ul>
+<h2 id="description">DESCRIPTION</h2>
<p>This command runs the <code>npm build</code> command on the matched folders. This is useful
when you install a new version of node, and must recompile all your C++ addons with
the new binary.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-build.html">npm-build(1)</a></li>
+<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-build.html">npm-build(1)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-rebuild — npm@1.4.9</p>
+<p id="footer">npm-rebuild — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-repo.html">npm-repo</a></h1> <p>Open package repository page in the browser</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm repo <pkgname>
-npm repo (with no args in a package dir)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm repo (with no args in a package dir)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command tries to guess at the likely location of a package's
repository URL, and then tries to open it using the <code>--browser</code>
config param. If no package name is provided, it will search for
a <code>package.json</code> in the current folder and use the <code>name</code> property.</p>
-
-<h2 id="CONFIGURATION">CONFIGURATION</h2>
-
+<h2 id="configuration">CONFIGURATION</h2>
<h3 id="browser">browser</h3>
-
-<ul><li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li><li>Type: String</li></ul>
-
+<ul>
+<li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li>
+<li>Type: String</li>
+</ul>
<p>The browser that is called by the <code>npm repo</code> command to open websites.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-docs.html">npm-docs(1)</a></li>
+<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-docs.html">npm-docs(1)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-repo — npm@1.4.9</p>
+<p id="footer">npm-repo — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-restart.html">npm-restart</a></h1> <p>Start a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm restart <name></code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm restart <name>
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This runs a package's "restart" script, if one was provided.
Otherwise it runs package's "stop" script, if one was provided, and then
the "start" script.</p>
-
<p>If no version is specified, then it restarts the "active" version.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-run-script.html">npm-run-script(1)</a></li>
+<li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li>
+<li><a href="../cli/npm-test.html">npm-test(1)</a></li>
+<li><a href="../cli/npm-start.html">npm-start(1)</a></li>
+<li><a href="../cli/npm-stop.html">npm-stop(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-run-script.html">npm-run-script(1)</a></li><li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li><li><a href="../cli/npm-test.html">npm-test(1)</a></li><li><a href="../cli/npm-start.html">npm-start(1)</a></li><li><a href="../cli/npm-stop.html">npm-stop(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-restart — npm@1.4.9</p>
+<p id="footer">npm-restart — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-rm.html">npm-rm</a></h1> <p>Remove a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm rm <name>
npm r <name>
npm uninstall <name>
-npm un <name></code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm un <name>
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This uninstalls a package, completely removing everything npm installed
on its behalf.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-prune.html">npm-prune(1)</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>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-prune.html">npm-prune(1)</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>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-rm — npm@1.4.9</p>
+<p id="footer">npm-rm — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-root.html">npm-root</a></h1> <p>Display npm root</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm root</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm root
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Print the effective <code>node_modules</code> folder to standard out.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-prefix.html">npm-prefix(1)</a></li>
+<li><a href="../cli/npm-bin.html">npm-bin(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>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-prefix.html">npm-prefix(1)</a></li><li><a href="../cli/npm-bin.html">npm-bin(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>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-root — npm@1.4.9</p>
+<p id="footer">npm-root — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-run-script.html">npm-run-script</a></h1> <p>Run arbitrary package scripts</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm run-script [<pkg>] <command></code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm run-script [<pkg>] [command]
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This runs an arbitrary command from a package's <code>"scripts"</code> object.
If no package name is provided, it will search for a <code>package.json</code>
-in the current folder and use its <code>"scripts"</code> object.</p>
-
+in the current folder and use its <code>"scripts"</code> object. If no <code>"command"</code>
+is provided, it will list the available top level scripts.</p>
<p>It is used by the test, start, restart, and stop commands, but can be
called directly, as well.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li>
+<li><a href="../cli/npm-test.html">npm-test(1)</a></li>
+<li><a href="../cli/npm-start.html">npm-start(1)</a></li>
+<li><a href="../cli/npm-restart.html">npm-restart(1)</a></li>
+<li><a href="../cli/npm-stop.html">npm-stop(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li><li><a href="../cli/npm-test.html">npm-test(1)</a></li><li><a href="../cli/npm-start.html">npm-start(1)</a></li><li><a href="../cli/npm-restart.html">npm-restart(1)</a></li><li><a href="../cli/npm-stop.html">npm-stop(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-run-script — npm@1.4.9</p>
+<p id="footer">npm-run-script — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-search.html">npm-search</a></h1> <p>Search for packages</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm search [--long] [search terms ...]
npm s [search terms ...]
-npm se [search terms ...]</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm se [search terms ...]
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Search the registry for packages matching the search terms.</p>
-
<p>If a term starts with <code>/</code>, then it's interpreted as a regular expression.
A trailing <code>/</code> will be ignored in this case. (Note that many regular
expression characters must be escaped or quoted in most shells.)</p>
-
-<h2 id="CONFIGURATION">CONFIGURATION</h2>
-
+<h2 id="configuration">CONFIGURATION</h2>
<h3 id="long">long</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Display full package descriptions and other long text across multiple
lines. When disabled (default) search results are truncated to fit
neatly on a single line. Modules with extremely long names will
fall on multiple lines.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../misc/npm-registry.html">npm-registry(7)</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="../cli/npm-view.html">npm-view(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../misc/npm-registry.html">npm-registry(7)</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="../cli/npm-view.html">npm-view(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-search — npm@1.4.9</p>
+<p id="footer">npm-search — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-shrinkwrap.html">npm-shrinkwrap</a></h1> <p>Lock down dependency versions</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm shrinkwrap</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm shrinkwrap
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command locks down the versions of a package's dependencies so
that you can control exactly which versions of each dependency will be
used when your package is installed. The "package.json" file is still
required if you want to use "npm install".</p>
-
<p>By default, "npm install" recursively installs the target's
dependencies (as specified in package.json), choosing the latest
available version that satisfies the dependency's semver pattern. In
possible or desirable, as when another author owns the npm package.
It's also possible to check dependencies directly into source control,
but that may be undesirable for other reasons.</p>
-
<p>As an example, consider package A:</p>
-
<pre><code>{
"name": "A",
"version": "0.1.0",
"dependencies": {
"B": "<0.1.0"
}
-}</code></pre>
-
-<p>package B:</p>
-
+}
+</code></pre><p>package B:</p>
<pre><code>{
"name": "B",
"version": "0.0.1",
"dependencies": {
"C": "<0.1.0"
}
-}</code></pre>
-
-<p>and package C:</p>
-
+}
+</code></pre><p>and package C:</p>
<pre><code>{
"name": "C,
"version": "0.0.1"
-}</code></pre>
-
-<p>If these are the only versions of A, B, and C available in the
+}
+</code></pre><p>If these are the only versions of A, B, and C available in the
registry, then a normal "npm install A" will install:</p>
-
<pre><code>A@0.1.0
`-- B@0.0.1
- `-- C@0.0.1</code></pre>
-
-<p>However, if B@0.0.2 is published, then a fresh "npm install A" will
+ `-- C@0.0.1
+</code></pre><p>However, if B@0.0.2 is published, then a fresh "npm install A" will
install:</p>
-
<pre><code>A@0.1.0
`-- B@0.0.2
- `-- C@0.0.1</code></pre>
-
-<p>assuming the new version did not modify B's dependencies. Of course,
+ `-- C@0.0.1
+</code></pre><p>assuming the new version did not modify B's dependencies. Of course,
the new version of B could include a new version of C and any number
of new dependencies. If such changes are undesirable, the author of A
could specify a dependency on B@0.0.1. However, if A's author and B's
author are not the same person, there's no way for A's author to say
that he or she does not want to pull in newly published versions of C
when B hasn't changed at all.</p>
-
<p>In this case, A's author can run</p>
-
-<pre><code>npm shrinkwrap</code></pre>
-
-<p>This generates npm-shrinkwrap.json, which will look something like this:</p>
-
+<pre><code>npm shrinkwrap
+</code></pre><p>This generates npm-shrinkwrap.json, which will look something like this:</p>
<pre><code>{
"name": "A",
"version": "0.1.0",
}
}
}
-}</code></pre>
-
-<p>The shrinkwrap command has locked down the dependencies based on
+}
+</code></pre><p>The shrinkwrap command has locked down the dependencies based on
what's currently installed in node_modules. When "npm install"
installs a package with a npm-shrinkwrap.json file in the package
root, the shrinkwrap file (rather than package.json files) completely
installs of this package will use B@0.0.1 and C@0.1.0, regardless the
dependencies and versions listed in A's, B's, and C's package.json
files.</p>
-
-<h3 id="Using-shrinkwrapped-packages">Using shrinkwrapped packages</h3>
-
+<h3 id="using-shrinkwrapped-packages">Using shrinkwrapped packages</h3>
<p>Using a shrinkwrapped package is no different than using any other
package: you can "npm install" it by hand, or add a dependency to your
package.json file and "npm install" it.</p>
-
-<h3 id="Building-shrinkwrapped-packages">Building shrinkwrapped packages</h3>
-
+<h3 id="building-shrinkwrapped-packages">Building shrinkwrapped packages</h3>
<p>To shrinkwrap an existing package:</p>
-
-<ol><li>Run "npm install" in the package root to install the current
-versions of all dependencies.</li><li>Validate that the package works as expected with these versions.</li><li>Run "npm shrinkwrap", add npm-shrinkwrap.json to git, and publish
-your package.</li></ol>
-
+<ol>
+<li>Run "npm install" in the package root to install the current
+versions of all dependencies.</li>
+<li>Validate that the package works as expected with these versions.</li>
+<li>Run "npm shrinkwrap", add npm-shrinkwrap.json to git, and publish
+your package.</li>
+</ol>
<p>To add or update a dependency in a shrinkwrapped package:</p>
-
-<ol><li>Run "npm install" in the package root to install the current
-versions of all dependencies.</li><li>Add or update dependencies. "npm install" each new or updated
+<ol>
+<li>Run "npm install" in the package root to install the current
+versions of all dependencies.</li>
+<li>Add or update dependencies. "npm install" each new or updated
package individually and then update package.json. Note that they
must be explicitly named in order to be installed: running <code>npm
install</code> with no arguments will merely reproduce the existing
-shrinkwrap.</li><li>Validate that the package works as expected with the new
-dependencies.</li><li>Run "npm shrinkwrap", commit the new npm-shrinkwrap.json, and
-publish your package.</li></ol>
-
+shrinkwrap.</li>
+<li>Validate that the package works as expected with the new
+dependencies.</li>
+<li>Run "npm shrinkwrap", commit the new npm-shrinkwrap.json, and
+publish your package.</li>
+</ol>
<p>You can use <a href="../cli/npm-outdated.html">npm-outdated(1)</a> to view dependencies with newer versions
available.</p>
-
-<h3 id="Other-Notes">Other Notes</h3>
-
+<h3 id="other-notes">Other Notes</h3>
<p>A shrinkwrap file must be consistent with the package's package.json
file. "npm shrinkwrap" will fail if required dependencies are not
already installed, since that would result in a shrinkwrap that
wouldn't actually work. Similarly, the command will fail if there are
extraneous packages (not referenced by package.json), since that would
indicate that package.json is not correct.</p>
-
<p>Since "npm shrinkwrap" is intended to lock down your dependencies for
production use, <code>devDependencies</code> will not be included unless you
explicitly set the <code>--dev</code> flag when you run <code>npm shrinkwrap</code>. If
installed <code>devDependencies</code> are excluded, then npm will print a
warning. If you want them to be installed with your module by
default, please consider adding them to <code>dependencies</code> instead.</p>
-
<p>If shrinkwrapped package A depends on shrinkwrapped package B, B's
shrinkwrap will not be used as part of the installation of A. However,
because A's shrinkwrap is constructed from a valid installation of B
and recursively specifies all dependencies, the contents of B's
shrinkwrap will implicitly be included in A's shrinkwrap.</p>
-
-<h3 id="Caveats">Caveats</h3>
-
+<h3 id="caveats">Caveats</h3>
<p>Shrinkwrap files only lock down package versions, not actual package
contents. While discouraged, a package author can republish an
existing version of a package, causing shrinkwrapped packages using
you're using with code that breaks your application, you could modify
the shrinkwrap file to use git URL references rather than version
numbers so that npm always fetches all packages from git.</p>
-
<p>If you wish to lock down the specific bytes included in a package, for
example to have 100% confidence in being able to reproduce a
deployment or build, then you ought to check your dependencies into
source control, or pursue some other mechanism that can verify
contents rather than versions.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
+<li><a href="../files/package.json.html">package.json(5)</a></li>
+<li><a href="../cli/npm-ls.html">npm-ls(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../cli/npm-ls.html">npm-ls(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-shrinkwrap — npm@1.4.9</p>
+<p id="footer">npm-shrinkwrap — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-star.html">npm-star</a></h1> <p>Mark your favorite packages</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm star <pkgname> [<pkg>, ...]
-npm unstar <pkgname> [<pkg>, ...]</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm unstar <pkgname> [<pkg>, ...]
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>"Starring" a package means that you have some interest in it. It's
a vaguely positive way to show that you care.</p>
-
<p>"Unstarring" is the same thing, but in reverse.</p>
-
<p>It's a boolean thing. Starring repeatedly has no additional effect.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-view.html">npm-view(1)</a></li>
+<li><a href="../cli/npm-whoami.html">npm-whoami(1)</a></li>
+<li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-view.html">npm-view(1)</a></li><li><a href="../cli/npm-whoami.html">npm-whoami(1)</a></li><li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-star — npm@1.4.9</p>
+<p id="footer">npm-star — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-stars.html">npm-stars</a></h1> <p>View packages marked as favorites</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm stars
-npm stars [username]</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm stars [username]
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>If you have starred a lot of neat things and want to find them again
quickly this command lets you do just that.</p>
-
<p>You may also want to see your friend's favorite packages, in this case
you will most certainly enjoy this command.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-star.html">npm-star(1)</a></li>
+<li><a href="../cli/npm-view.html">npm-view(1)</a></li>
+<li><a href="../cli/npm-whoami.html">npm-whoami(1)</a></li>
+<li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-star.html">npm-star(1)</a></li><li><a href="../cli/npm-view.html">npm-view(1)</a></li><li><a href="../cli/npm-whoami.html">npm-whoami(1)</a></li><li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-stars — npm@1.4.9</p>
+<p id="footer">npm-stars — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-start.html">npm-start</a></h1> <p>Start a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm start <name></code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm start <name>
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This runs a package's "start" script, if one was provided.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-run-script.html">npm-run-script(1)</a></li>
+<li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li>
+<li><a href="../cli/npm-test.html">npm-test(1)</a></li>
+<li><a href="../cli/npm-restart.html">npm-restart(1)</a></li>
+<li><a href="../cli/npm-stop.html">npm-stop(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-run-script.html">npm-run-script(1)</a></li><li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li><li><a href="../cli/npm-test.html">npm-test(1)</a></li><li><a href="../cli/npm-restart.html">npm-restart(1)</a></li><li><a href="../cli/npm-stop.html">npm-stop(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-start — npm@1.4.9</p>
+<p id="footer">npm-start — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-stop.html">npm-stop</a></h1> <p>Stop a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm stop <name></code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm stop <name>
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This runs a package's "stop" script, if one was provided.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-run-script.html">npm-run-script(1)</a></li>
+<li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li>
+<li><a href="../cli/npm-test.html">npm-test(1)</a></li>
+<li><a href="../cli/npm-start.html">npm-start(1)</a></li>
+<li><a href="../cli/npm-restart.html">npm-restart(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-run-script.html">npm-run-script(1)</a></li><li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li><li><a href="../cli/npm-test.html">npm-test(1)</a></li><li><a href="../cli/npm-start.html">npm-start(1)</a></li><li><a href="../cli/npm-restart.html">npm-restart(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-stop — npm@1.4.9</p>
+<p id="footer">npm-stop — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-submodule.html">npm-submodule</a></h1> <p>Add a package as a git submodule</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm submodule <pkg></code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm submodule <pkg>
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>If the specified package has a git repository url in its package.json
description, then this command will add it as a git submodule at
<code>node_modules/<pkg name></code>.</p>
-
<p>This is a convenience only. From then on, it's up to you to manage
updates by using the appropriate git commands. npm will stubbornly
refuse to update, modify, or remove anything with a <code>.git</code> subfolder
in it.</p>
-
<p>This command also does not install missing dependencies, if the package
does not include them in its git repository. If <code>npm ls</code> reports that
things are missing, you can either install, link, or submodule them yourself,
or you can do <code>npm explore <pkgname> -- npm install</code> to install the
dependencies into the submodule folder.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../files/package.json.html">package.json(5)</a></li>
+<li>git help submodule</li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../files/package.json.html">package.json(5)</a></li><li>git help submodule</li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-submodule — npm@1.4.9</p>
+<p id="footer">npm-submodule — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-tag.html">npm-tag</a></h1> <p>Tag a published version</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm tag <name>@<version> [<tag>]</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm tag <name>@<version> [<tag>]
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Tags the specified version of the package with the specified tag, or the
<code>--tag</code> config if not specified.</p>
-
<p>A tag can be used when installing packages as a reference to a version instead
of using a specific version number:</p>
-
-<pre><code>npm install <name>@<tag></code></pre>
-
-<p>When installing dependencies, a preferred tagged version may be specified:</p>
-
-<pre><code>npm install --tag <tag></code></pre>
-
-<p>This also applies to <code>npm dedupe</code>.</p>
-
+<pre><code>npm install <name>@<tag>
+</code></pre><p>When installing dependencies, a preferred tagged version may be specified:</p>
+<pre><code>npm install --tag <tag>
+</code></pre><p>This also applies to <code>npm dedupe</code>.</p>
<p>Publishing a package always sets the "latest" tag to the published version.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
+<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
+<li><a href="../cli/npm-dedupe.html">npm-dedupe(1)</a></li>
+<li><a href="../misc/npm-registry.html">npm-registry(7)</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>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../cli/npm-dedupe.html">npm-dedupe(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</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>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-tag — npm@1.4.9</p>
+<p id="footer">npm-tag — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-test.html">npm-test</a></h1> <p>Test a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code> npm test <name>
- npm tst <name></code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+ npm tst <name>
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This runs a package's "test" script, if one was provided.</p>
-
<p>To run tests as a condition of installation, set the <code>npat</code> config to
true.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-run-script.html">npm-run-script(1)</a></li>
+<li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li>
+<li><a href="../cli/npm-start.html">npm-start(1)</a></li>
+<li><a href="../cli/npm-restart.html">npm-restart(1)</a></li>
+<li><a href="../cli/npm-stop.html">npm-stop(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-run-script.html">npm-run-script(1)</a></li><li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li><li><a href="../cli/npm-start.html">npm-start(1)</a></li><li><a href="../cli/npm-restart.html">npm-restart(1)</a></li><li><a href="../cli/npm-stop.html">npm-stop(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-test — npm@1.4.9</p>
+<p id="footer">npm-test — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-rm.html">npm-rm</a></h1> <p>Remove a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm uninstall <name> [--save|--save-dev|--save-optional]
-npm rm (with any of the previous argument usage)</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm rm (with any of the previous argument usage)
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This uninstalls a package, completely removing everything npm installed
on its behalf.</p>
-
<p>Example:</p>
-
-<pre><code>npm uninstall sax</code></pre>
-
-<p>In global mode (ie, with <code>-g</code> or <code>--global</code> appended to the command),
+<pre><code>npm uninstall sax
+</code></pre><p>In global mode (ie, with <code>-g</code> or <code>--global</code> appended to the command),
it uninstalls the current package context as a global package.</p>
-
<p><code>npm uninstall</code> takes 3 exclusive, optional flags which save or update
the package version in your main package.json:</p>
-
-<ul><li><p><code>--save</code>: Package will be removed from your <code>dependencies</code>.</p></li><li><p><code>--save-dev</code>: Package will be removed from your <code>devDependencies</code>.</p></li><li><p><code>--save-optional</code>: Package will be removed from your <code>optionalDependencies</code>.</p></li></ul>
-
+<ul>
+<li><p><code>--save</code>: Package will be removed from your <code>dependencies</code>.</p>
+</li>
+<li><p><code>--save-dev</code>: Package will be removed from your <code>devDependencies</code>.</p>
+</li>
+<li><p><code>--save-optional</code>: Package will be removed from your <code>optionalDependencies</code>.</p>
+</li>
+</ul>
<p>Examples:</p>
-
<pre><code>npm uninstall sax --save
npm uninstall node-tap --save-dev
-npm uninstall dtrace-provider --save-optional</code></pre>
-
-<h2 id="SEE-ALSO">SEE ALSO</h2>
+npm uninstall dtrace-provider --save-optional
+</code></pre><h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-prune.html">npm-prune(1)</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>
-<ul><li><a href="../cli/npm-prune.html">npm-prune(1)</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>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-uninstall — npm@1.4.9</p>
+<p id="footer">npm-uninstall — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-unpublish.html">npm-unpublish</a></h1> <p>Remove a package from the registry</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm unpublish <name>[@<version>]</code></pre>
-
-<h2 id="WARNING">WARNING</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm unpublish <name>[@<version>]
+</code></pre><h2 id="warning">WARNING</h2>
<p><strong>It is generally considered bad behavior to remove versions of a library
that others are depending on!</strong></p>
-
<p>Consider using the <code>deprecate</code> command
instead, if your intent is to encourage users to upgrade.</p>
-
<p>There is plenty of room on the registry.</p>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="description">DESCRIPTION</h2>
<p>This removes a package version from the registry, deleting its
entry and removing the tarball.</p>
-
<p>If no version is specified, or if all versions are removed then
the root package entry is removed from the registry entirely.</p>
-
<p>Even if a package version is unpublished, that specific name and
version combination can never be reused. In order to publish the
package again, a new version number must be used.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-deprecate.html">npm-deprecate(1)</a></li>
+<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
+<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
+<li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li>
+<li><a href="../cli/npm-owner.html">npm-owner(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-deprecate.html">npm-deprecate(1)</a></li><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li><li><a href="../cli/npm-owner.html">npm-owner(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-unpublish — npm@1.4.9</p>
+<p id="footer">npm-unpublish — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-update.html">npm-update</a></h1> <p>Update a package</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm update [-g] [<name> [<name> ...]]</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm update [-g] [<name> [<name> ...]]
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command will update all the packages listed to the latest version
(specified by the <code>tag</code> config).</p>
-
<p>It will also install missing packages.</p>
-
<p>If the <code>-g</code> flag is specified, this command will update globally installed packages.
If no package name is specified, all packages in the specified location (global or local) will be updated.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
+<li><a href="../cli/npm-outdated.html">npm-outdated(1)</a></li>
+<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
+<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
+<li><a href="../cli/npm-ls.html">npm-ls(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../cli/npm-outdated.html">npm-outdated(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-ls.html">npm-ls(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-update — npm@1.4.9</p>
+<p id="footer">npm-update — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-version.html">npm-version</a></h1> <p>Bump a package version</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm version [<newversion> | major | minor | patch]</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm version [<newversion> | major | minor | patch]
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Run this in a package directory to bump the version and write the new
data back to the package.json file.</p>
-
<p>The <code>newversion</code> argument should be a valid semver string, <em>or</em> a valid
second argument to semver.inc (one of "patch", "minor", or
"major"). In the second case, the existing version will be incremented
by 1 in the specified field.</p>
-
<p>If run in a git repo, it will also create a version commit and tag, and
fail if the repo is not clean.</p>
-
<p>If supplied with <code>--message</code> (shorthand: <code>-m</code>) config option, npm will
use it as a commit message when creating a version commit. If the
<code>message</code> config contains <code>%s</code> then that will be replaced with the
resulting version number. For example:</p>
-
-<pre><code>npm version patch -m "Upgrade to %s for reasons"</code></pre>
-
-<p>If the <code>sign-git-tag</code> config is set, then the tag will be signed using
+<pre><code>npm version patch -m "Upgrade to %s for reasons"
+</code></pre><p>If the <code>sign-git-tag</code> config is set, then the tag will be signed using
the <code>-s</code> flag to git. Note that you must have a default GPG key set up
in your git config for this to work properly. For example:</p>
-
<pre><code>$ npm config set sign-git-tag true
$ npm version patch
user: "isaacs (http://blog.izs.me/) <i@izs.me>"
2048-bit RSA key, ID 6C481CF6, created 2010-08-31
-Enter passphrase:</code></pre>
-
-<h2 id="SEE-ALSO">SEE ALSO</h2>
+Enter passphrase:
+</code></pre><h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-init.html">npm-init(1)</a></li>
+<li><a href="../files/package.json.html">package.json(5)</a></li>
+<li><a href="../misc/semver.html">semver(7)</a></li>
+</ul>
-<ul><li><a href="../cli/npm-init.html">npm-init(1)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../misc/semver.html">semver(7)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-version — npm@1.4.9</p>
+<p id="footer">npm-version — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-view.html">npm-view</a></h1> <p>View registry info</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm view <name>[@<version>] [<field>[.<subfield>]...]
-npm v <name>[@<version>] [<field>[.<subfield>]...]</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+npm v <name>[@<version>] [<field>[.<subfield>]...]
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>This command shows data about a package and prints it to the stream
referenced by the <code>outfd</code> config, which defaults to stdout.</p>
-
<p>To show the package registry entry for the <code>connect</code> package, you can do
this:</p>
-
-<pre><code>npm view connect</code></pre>
-
-<p>The default version is "latest" if unspecified.</p>
-
+<pre><code>npm view connect
+</code></pre><p>The default version is "latest" if unspecified.</p>
<p>Field names can be specified after the package descriptor.
For example, to show the dependencies of the <code>ronn</code> package at version
0.3.5, you could do the following:</p>
-
-<pre><code>npm view ronn@0.3.5 dependencies</code></pre>
-
-<p>You can view child field by separating them with a period.
+<pre><code>npm view ronn@0.3.5 dependencies
+</code></pre><p>You can view child field by separating them with a period.
To view the git repository URL for the latest version of npm, you could
do this:</p>
-
-<pre><code>npm view npm repository.url</code></pre>
-
-<p>This makes it easy to view information about a dependency with a bit of
+<pre><code>npm view npm repository.url
+</code></pre><p>This makes it easy to view information about a dependency with a bit of
shell scripting. For example, to view all the data about the version of
opts that ronn depends on, you can do this:</p>
-
-<pre><code>npm view opts@$(npm view ronn dependencies.opts)</code></pre>
-
-<p>For fields that are arrays, requesting a non-numeric field will return
+<pre><code>npm view opts@$(npm view ronn dependencies.opts)
+</code></pre><p>For fields that are arrays, requesting a non-numeric field will return
all of the values from the objects in the list. For example, to get all
the contributor names for the "express" project, you can do this:</p>
-
-<pre><code>npm view express contributors.email</code></pre>
-
-<p>You may also use numeric indices in square braces to specifically select
+<pre><code>npm view express contributors.email
+</code></pre><p>You may also use numeric indices in square braces to specifically select
an item in an array field. To just get the email address of the first
contributor in the list, you can do this:</p>
-
-<pre><code>npm view express contributors[0].email</code></pre>
-
-<p>Multiple fields may be specified, and will be printed one after another.
+<pre><code>npm view express contributors[0].email
+</code></pre><p>Multiple fields may be specified, and will be printed one after another.
For exampls, to get all the contributor names and email addresses, you
can do this:</p>
-
-<pre><code>npm view express contributors.name contributors.email</code></pre>
-
-<p>"Person" fields are shown as a string if they would be shown as an
+<pre><code>npm view express contributors.name contributors.email
+</code></pre><p>"Person" fields are shown as a string if they would be shown as an
object. So, for example, this will show the list of npm contributors in
the shortened string format. (See <code><a href="../files/package.json.html">package.json(5)</a></code> for more on this.)</p>
-
-<pre><code>npm view npm contributors</code></pre>
-
-<p>If a version range is provided, then data will be printed for every
+<pre><code>npm view npm contributors
+</code></pre><p>If a version range is provided, then data will be printed for every
matching version of the package. This will show which version of jsdom
was required by each matching version of yui3:</p>
-
-<pre><code>npm view yui3@'>0.5.4' dependencies.jsdom</code></pre>
-
-<h2 id="OUTPUT">OUTPUT</h2>
-
+<pre><code>npm view yui3@'>0.5.4' dependencies.jsdom
+</code></pre><h2 id="output">OUTPUT</h2>
<p>If only a single string field for a single version is output, then it
will not be colorized or quoted, so as to enable piping the output to
another command. If the field is an object, it will be output as a JavaScript object literal.</p>
-
<p>If the --json flag is given, the outputted fields will be JSON.</p>
-
<p>If the version range matches multiple versions, than each printed value
will be prefixed with the version it applies to.</p>
-
<p>If multiple fields are requested, than each of them are prefixed with
the field name.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-search.html">npm-search(1)</a></li>
+<li><a href="../misc/npm-registry.html">npm-registry(7)</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="../cli/npm-docs.html">npm-docs(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm-search.html">npm-search(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</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="../cli/npm-docs.html">npm-docs(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-view — npm@1.4.9</p>
+<p id="footer">npm-view — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-whoami.html">npm-whoami</a></h1> <p>Display npm username</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm whoami</code></pre>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm whoami
+</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Print the <code>username</code> config to standard output.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<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="../cli/npm-adduser.html">npm-adduser(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><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="../cli/npm-adduser.html">npm-adduser(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-whoami — npm@1.4.9</p>
+<p id="footer">npm-whoami — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm.html">npm</a></h1> <p>node package manager</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<pre><code>npm <command> [args]</code></pre>
-
-<h2 id="VERSION">VERSION</h2>
-
-<p>1.4.9</p>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<pre><code>npm <command> [args]
+</code></pre><h2 id="version">VERSION</h2>
+<p>1.4.10</p>
+<h2 id="description">DESCRIPTION</h2>
<p>npm is the package manager for the Node JavaScript platform. It puts
modules in place so that node can find them, and manages dependency
conflicts intelligently.</p>
-
<p>It is extremely configurable to support a wide variety of use cases.
Most commonly, it is used to publish, discover, install, and develop node
programs.</p>
-
<p>Run <code>npm help</code> to get a list of available commands.</p>
-
-<h2 id="INTRODUCTION">INTRODUCTION</h2>
-
+<h2 id="introduction">INTRODUCTION</h2>
<p>You probably got npm because you want to install stuff.</p>
-
<p>Use <code>npm install blerg</code> to install the latest version of "blerg". Check out
<code><a href="../cli/npm-install.html">npm-install(1)</a></code> for more info. It can do a lot of stuff.</p>
-
<p>Use the <code>npm search</code> command to show everything that's available.
Use <code>npm ls</code> to show everything you've installed.</p>
-
-<h2 id="DIRECTORIES">DIRECTORIES</h2>
-
+<h2 id="directories">DIRECTORIES</h2>
<p>See <code><a href="../files/npm-folders.html">npm-folders(5)</a></code> to learn about where npm puts stuff.</p>
-
<p>In particular, npm has two modes of operation:</p>
-
-<ul><li>global mode:<br />npm installs packages into the install prefix at
-<code>prefix/lib/node_modules</code> and bins are installed in <code>prefix/bin</code>.</li><li>local mode:<br />npm installs packages into the current project directory, which
+<ul>
+<li>global mode:<br>npm installs packages into the install prefix at
+<code>prefix/lib/node_modules</code> and bins are installed in <code>prefix/bin</code>.</li>
+<li>local mode:<br>npm installs packages into the current project directory, which
defaults to the current working directory. Packages are installed to
-<code>./node_modules</code>, and bins are installed to <code>./node_modules/.bin</code>.</li></ul>
-
+<code>./node_modules</code>, and bins are installed to <code>./node_modules/.bin</code>.</li>
+</ul>
<p>Local mode is the default. Use <code>--global</code> or <code>-g</code> on any command to
operate in global mode instead.</p>
-
-<h2 id="DEVELOPER-USAGE">DEVELOPER USAGE</h2>
-
+<h2 id="developer-usage">DEVELOPER USAGE</h2>
<p>If you're using npm to develop and publish your code, check out the
following help topics:</p>
-
-<ul><li>json:
-Make a package.json file. See <code><a href="../files/package.json.html">package.json(5)</a></code>.</li><li>link:
+<ul>
+<li>json:
+Make a package.json file. See <code><a href="../files/package.json.html">package.json(5)</a></code>.</li>
+<li>link:
For linking your current working code into Node's path, so that you
don't have to reinstall every time you make a change. Use
-<code>npm link</code> to do this.</li><li>install:
+<code>npm link</code> to do this.</li>
+<li>install:
It's a good idea to install things if you don't need the symbolic link.
Especially, installing other peoples code from the registry is done via
-<code>npm install</code></li><li>adduser:
+<code>npm install</code></li>
+<li>adduser:
Create an account or log in. Credentials are stored in the
-user config file.</li><li>publish:
-Use the <code>npm publish</code> command to upload your code to the registry.</li></ul>
-
-<h2 id="CONFIGURATION">CONFIGURATION</h2>
-
+user config file.</li>
+<li>publish:
+Use the <code>npm publish</code> command to upload your code to the registry.</li>
+</ul>
+<h2 id="configuration">CONFIGURATION</h2>
<p>npm is extremely configurable. It reads its configuration options from
5 places.</p>
-
-<ul><li>Command line switches:<br />Set a config with <code>--key val</code>. All keys take a value, even if they
+<ul>
+<li>Command line switches:<br>Set a config with <code>--key val</code>. All keys take a value, even if they
are booleans (the config parser doesn't know what the options are at
the time of parsing.) If no value is provided, then the option is set
-to boolean <code>true</code>.</li><li>Environment Variables:<br />Set any config by prefixing the name in an environment variable with
-<code>npm_config_</code>. For example, <code>export npm_config_key=val</code>.</li><li>User Configs:<br />The file at $HOME/.npmrc is an ini-formatted list of configs. If
+to boolean <code>true</code>.</li>
+<li>Environment Variables:<br>Set any config by prefixing the name in an environment variable with
+<code>npm_config_</code>. For example, <code>export npm_config_key=val</code>.</li>
+<li>User Configs:<br>The file at $HOME/.npmrc is an ini-formatted list of configs. If
present, it is parsed. If the <code>userconfig</code> option is set in the cli
-or env, then that will be used instead.</li><li>Global Configs:<br />The file found at ../etc/npmrc (from the node executable, by default
+or env, then that will be used instead.</li>
+<li>Global Configs:<br>The file found at ../etc/npmrc (from the node executable, by default
this resolves to /usr/local/etc/npmrc) will be parsed if it is found.
If the <code>globalconfig</code> option is set in the cli, env, or user config,
-then that file is parsed instead.</li><li>Defaults:<br />npm's default configuration options are defined in
-lib/utils/config-defs.js. These must not be changed.</li></ul>
-
+then that file is parsed instead.</li>
+<li>Defaults:<br>npm's default configuration options are defined in
+lib/utils/config-defs.js. These must not be changed.</li>
+</ul>
<p>See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> for much much more information.</p>
-
-<h2 id="CONTRIBUTIONS">CONTRIBUTIONS</h2>
-
+<h2 id="contributions">CONTRIBUTIONS</h2>
<p>Patches welcome!</p>
-
-<ul><li>code:
+<ul>
+<li>code:
Read through <code><a href="../misc/npm-coding-style.html">npm-coding-style(7)</a></code> if you plan to submit code.
-You don't have to agree with it, but you do have to follow it.</li><li>docs:
+You don't have to agree with it, but you do have to follow it.</li>
+<li>docs:
If you find an error in the documentation, edit the appropriate markdown
-file in the "doc" folder. (Don't worry about generating the man page.)</li></ul>
-
+file in the "doc" folder. (Don't worry about generating the man page.)</li>
+</ul>
<p>Contributors are listed in npm's <code>package.json</code> file. You can view them
easily by doing <code>npm view npm contributors</code>.</p>
-
<p>If you would like to contribute, but don't know what to work on, check
the issues list or ask on the mailing list.</p>
-
-<ul><li><a href="http://github.com/npm/npm/issues">http://github.com/npm/npm/issues</a></li><li><a href="mailto:npm-@googlegroups.com">npm-@googlegroups.com</a></li></ul>
-
-<h2 id="BUGS">BUGS</h2>
-
+<ul>
+<li><a href="http://github.com/npm/npm/issues">http://github.com/npm/npm/issues</a></li>
+<li><a href="mailto:npm-@googlegroups.com">npm-@googlegroups.com</a></li>
+</ul>
+<h2 id="bugs">BUGS</h2>
<p>When you find issues, please report them:</p>
-
-<ul><li>web:
-<a href="http://github.com/npm/npm/issues">http://github.com/npm/npm/issues</a></li><li>email:
-<a href="mailto:npm-@googlegroups.com">npm-@googlegroups.com</a></li></ul>
-
+<ul>
+<li>web:
+<a href="http://github.com/npm/npm/issues">http://github.com/npm/npm/issues</a></li>
+<li>email:
+<a href="mailto:npm-@googlegroups.com">npm-@googlegroups.com</a></li>
+</ul>
<p>Be sure to include <em>all</em> of the output from the npm command that didn't work
as expected. The <code>npm-debug.log</code> file is also helpful to provide.</p>
-
<p>You can also look for isaacs in #node.js on irc://irc.freenode.net. He
will no doubt tell you to put the output in a gist or email.</p>
-
-<h2 id="AUTHOR">AUTHOR</h2>
-
+<h2 id="author">AUTHOR</h2>
<p><a href="http://blog.izs.me/">Isaac Z. Schlueter</a> ::
<a href="https://github.com/isaacs/">isaacs</a> ::
<a href="http://twitter.com/izs">@izs</a> ::
-<a href="mailto:i@izs.me">i@izs.me</a></p>
-
-<h2 id="SEE-ALSO">SEE ALSO</h2>
+<a href="mailto:i@izs.me">i@izs.me</a></p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-help.html">npm-help(1)</a></li>
+<li><a href="../misc/npm-faq.html">npm-faq(7)</a></li>
+<li><a href="../../doc/README.html">README</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="../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-index.html">npm-index(7)</a></li>
+<li><a href="../api/npm.html">npm(3)</a></li>
+</ul>
-<ul><li><a href="../cli/npm-help.html">npm-help(1)</a></li><li><a href="../misc/npm-faq.html">npm-faq(7)</a></li><li><a href="../../doc/README.html">README</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="../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-index.html">npm-index(7)</a></li><li><a href="../api/npm.html">npm(3)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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 — npm@1.4.9</p>
+<p id="footer">npm — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../files/npm-folders.html">npm-folders</a></h1> <p>Folder Structures Used by npm</p>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="description">DESCRIPTION</h2>
<p>npm puts various things on your computer. That's its job.</p>
-
<p>This document will tell you what it puts where.</p>
-
<h3 id="tl-dr">tl;dr</h3>
-
-<ul><li>Local install (default): puts stuff in <code>./node_modules</code> of the current
-package root.</li><li>Global install (with <code>-g</code>): puts stuff in /usr/local or wherever node
-is installed.</li><li>Install it <strong>locally</strong> if you're going to <code>require()</code> it.</li><li>Install it <strong>globally</strong> if you're going to run it on the command line.</li><li>If you need both, then install it in both places, or use <code>npm link</code>.</li></ul>
-
-<h3 id="prefix-Configuration">prefix Configuration</h3>
-
+<ul>
+<li>Local install (default): puts stuff in <code>./node_modules</code> of the current
+package root.</li>
+<li>Global install (with <code>-g</code>): puts stuff in /usr/local or wherever node
+is installed.</li>
+<li>Install it <strong>locally</strong> if you're going to <code>require()</code> it.</li>
+<li>Install it <strong>globally</strong> if you're going to run it on the command line.</li>
+<li>If you need both, then install it in both places, or use <code>npm link</code>.</li>
+</ul>
+<h3 id="prefix-configuration">prefix Configuration</h3>
<p>The <code>prefix</code> config defaults to the location where node is installed.
On most systems, this is <code>/usr/local</code>, and most of the time is the same
as node's <code>process.installPrefix</code>.</p>
-
<p>On windows, this is the exact location of the node.exe binary. On Unix
systems, it's one level up, since node is typically installed at
<code>{prefix}/bin/node</code> rather than <code>{prefix}/node.exe</code>.</p>
-
<p>When the <code>global</code> flag is set, npm installs things into this prefix.
When it is not set, it uses the root of the current package, or the
current working directory if not in a package already.</p>
-
-<h3 id="Node-Modules">Node Modules</h3>
-
+<h3 id="node-modules">Node Modules</h3>
<p>Packages are dropped into the <code>node_modules</code> folder under the <code>prefix</code>.
When installing locally, this means that you can
<code>require("packagename")</code> to load its main module, or
<code>require("packagename/lib/path/to/sub/module")</code> to load other modules.</p>
-
<p>Global installs on Unix systems go to <code>{prefix}/lib/node_modules</code>.
Global installs on Windows go to <code>{prefix}/node_modules</code> (that is, no
<code>lib</code> folder.)</p>
-
<p>If you wish to <code>require()</code> a package, then install it locally.</p>
-
-<h3 id="Executables">Executables</h3>
-
+<h3 id="executables">Executables</h3>
<p>When in global mode, executables are linked into <code>{prefix}/bin</code> on Unix,
or directly into <code>{prefix}</code> on Windows.</p>
-
<p>When in local mode, executables are linked into
<code>./node_modules/.bin</code> so that they can be made available to scripts run
through npm. (For example, so that a test runner will be in the path
when you run <code>npm test</code>.)</p>
-
-<h3 id="Man-Pages">Man Pages</h3>
-
+<h3 id="man-pages">Man Pages</h3>
<p>When in global mode, man pages are linked into <code>{prefix}/share/man</code>.</p>
-
<p>When in local mode, man pages are not installed.</p>
-
<p>Man pages are not installed on Windows systems.</p>
-
-<h3 id="Cache">Cache</h3>
-
+<h3 id="cache">Cache</h3>
<p>See <code><a href="../cli/npm-cache.html">npm-cache(1)</a></code>. Cache files are stored in <code>~/.npm</code> on Posix, or
<code>~/npm-cache</code> on Windows.</p>
-
<p>This is controlled by the <code>cache</code> configuration param.</p>
-
-<h3 id="Temp-Files">Temp Files</h3>
-
+<h3 id="temp-files">Temp Files</h3>
<p>Temporary files are stored by default in the folder specified by the
<code>tmp</code> config, which defaults to the TMPDIR, TMP, or TEMP environment
variables, or <code>/tmp</code> on Unix and <code>c:\windows\temp</code> on Windows.</p>
-
<p>Temp files are given a unique folder under this root for each run of the
program, and are deleted upon successful exit.</p>
-
-<h2 id="More-Information">More Information</h2>
-
+<h2 id="more-information">More Information</h2>
<p>When installing locally, npm first tries to find an appropriate
<code>prefix</code> folder. This is so that <code>npm install foo@1.2.3</code> will install
to the sensible root of your package, even if you happen to have <code>cd</code>ed
into some other folder.</p>
-
<p>Starting at the $PWD, npm will walk up the folder tree checking for a
folder that contains either a <code>package.json</code> file, or a <code>node_modules</code>
folder. If such a thing is found, then that is treated as the effective
"current directory" for the purpose of running npm commands. (This
behavior is inspired by and similar to git's .git-folder seeking
logic when running git commands in a working dir.)</p>
-
<p>If no package root is found, then the current folder is used.</p>
-
<p>When you run <code>npm install foo@1.2.3</code>, then the package is loaded into
the cache, and then unpacked into <code>./node_modules/foo</code>. Then, any of
foo's dependencies are similarly unpacked into
<code>./node_modules/foo/node_modules/...</code>.</p>
-
<p>Any bin files are symlinked to <code>./node_modules/.bin/</code>, so that they may
be found by npm scripts when necessary.</p>
-
-<h3 id="Global-Installation">Global Installation</h3>
-
+<h3 id="global-installation">Global Installation</h3>
<p>If the <code>global</code> configuration is set to true, then npm will
install packages "globally".</p>
-
<p>For global installation, packages are installed roughly the same way,
but using the folders described above.</p>
-
-<h3 id="Cycles-Conflicts-and-Folder-Parsimony">Cycles, Conflicts, and Folder Parsimony</h3>
-
+<h3 id="cycles-conflicts-and-folder-parsimony">Cycles, Conflicts, and Folder Parsimony</h3>
<p>Cycles are handled using the property of node's module system that it
walks up the directories looking for <code>node_modules</code> folders. So, at every
stage, if a package is already installed in an ancestor <code>node_modules</code>
folder, then it is not installed at the current location.</p>
-
<p>Consider the case above, where <code>foo -> bar -> baz</code>. Imagine if, in
addition to that, baz depended on bar, so you'd have:
<code>foo -> bar -> baz -> bar -> baz ...</code>. However, since the folder
put another copy of bar into <code>.../baz/node_modules</code>, since when it calls
require("bar"), it will get the copy that is installed in
<code>foo/node_modules/bar</code>.</p>
-
<p>This shortcut is only used if the exact same
version would be installed in multiple nested <code>node_modules</code> folders. It
is still possible to have <code>a/node_modules/b/node_modules/a</code> if the two
"a" packages are different versions. However, without repeating the
exact same package multiple times, an infinite regress will always be
prevented.</p>
-
<p>Another optimization can be made by installing dependencies at the
highest level possible, below the localized "target" folder.</p>
-
-<h4 id="Example">Example</h4>
-
+<h4 id="example">Example</h4>
<p>Consider this dependency graph:</p>
-
<pre><code>foo
+-- blerg@1.2.5
+-- bar@1.2.3
| `-- asdf@*
`-- baz@1.2.3
`-- quux@3.x
- `-- bar</code></pre>
-
-<p>In this case, we might expect a folder structure like this:</p>
-
+ `-- bar
+</code></pre><p>In this case, we might expect a folder structure like this:</p>
<pre><code>foo
+-- node_modules
+-- blerg (1.2.5) <---[A]
| `-- asdf (2.3.4)
`-- baz (1.2.3) <---[D]
`-- node_modules
- `-- quux (3.2.0) <---[E]</code></pre>
-
-<p>Since foo depends directly on <code>bar@1.2.3</code> and <code>baz@1.2.3</code>, those are
+ `-- quux (3.2.0) <---[E]
+</code></pre><p>Since foo depends directly on <code>bar@1.2.3</code> and <code>baz@1.2.3</code>, those are
installed in foo's <code>node_modules</code> folder.</p>
-
<p>Even though the latest copy of blerg is 1.3.7, foo has a specific
dependency on version 1.2.5. So, that gets installed at [A]. Since the
parent installation of blerg satisfies bar's dependency on <code>blerg@1.x</code>,
it does not install another copy under [B].</p>
-
<p>Bar [B] also has dependencies on baz and asdf, so those are installed in
bar's <code>node_modules</code> folder. Because it depends on <code>baz@2.x</code>, it cannot
re-use the <code>baz@1.2.3</code> installed in the parent <code>node_modules</code> folder [D],
and must install its own copy [C].</p>
-
<p>Underneath bar, the <code>baz -> quux -> bar</code> dependency creates a cycle.
However, because bar is already in quux's ancestry [B], it does not
unpack another copy of bar into that folder.</p>
-
<p>Underneath <code>foo -> baz</code> [D], quux's [E] folder tree is empty, because its
dependency on bar is satisfied by the parent folder copy installed at [B].</p>
-
<p>For a graphical breakdown of what is installed where, use <code>npm ls</code>.</p>
-
-<h3 id="Publishing">Publishing</h3>
-
+<h3 id="publishing">Publishing</h3>
<p>Upon publishing, npm will look in the <code>node_modules</code> folder. If any of
the items there are not in the <code>bundledDependencies</code> array, then they will
not be included in the package tarball.</p>
-
<p>This allows a package maintainer to install all of their dependencies
(and dev dependencies) locally, but only re-publish those items that
cannot be found elsewhere. See <code><a href="../files/package.json.html">package.json(5)</a></code> for more information.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<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="../cli/npm-pack.html">npm-pack(1)</a></li>
+<li><a href="../cli/npm-cache.html">npm-cache(1)</a></li>
+<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
+<li><a href="../files/npmrc.html">npmrc(5)</a></li>
+<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
+<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><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="../cli/npm-pack.html">npm-pack(1)</a></li><li><a href="../cli/npm-cache.html">npm-cache(1)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-folders — npm@1.4.9</p>
+<p id="footer">npm-folders — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../files/npm-folders.html">npm-folders</a></h1> <p>Folder Structures Used by npm</p>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="description">DESCRIPTION</h2>
<p>npm puts various things on your computer. That's its job.</p>
-
<p>This document will tell you what it puts where.</p>
-
<h3 id="tl-dr">tl;dr</h3>
-
-<ul><li>Local install (default): puts stuff in <code>./node_modules</code> of the current
-package root.</li><li>Global install (with <code>-g</code>): puts stuff in /usr/local or wherever node
-is installed.</li><li>Install it <strong>locally</strong> if you're going to <code>require()</code> it.</li><li>Install it <strong>globally</strong> if you're going to run it on the command line.</li><li>If you need both, then install it in both places, or use <code>npm link</code>.</li></ul>
-
-<h3 id="prefix-Configuration">prefix Configuration</h3>
-
+<ul>
+<li>Local install (default): puts stuff in <code>./node_modules</code> of the current
+package root.</li>
+<li>Global install (with <code>-g</code>): puts stuff in /usr/local or wherever node
+is installed.</li>
+<li>Install it <strong>locally</strong> if you're going to <code>require()</code> it.</li>
+<li>Install it <strong>globally</strong> if you're going to run it on the command line.</li>
+<li>If you need both, then install it in both places, or use <code>npm link</code>.</li>
+</ul>
+<h3 id="prefix-configuration">prefix Configuration</h3>
<p>The <code>prefix</code> config defaults to the location where node is installed.
On most systems, this is <code>/usr/local</code>, and most of the time is the same
as node's <code>process.installPrefix</code>.</p>
-
<p>On windows, this is the exact location of the node.exe binary. On Unix
systems, it's one level up, since node is typically installed at
<code>{prefix}/bin/node</code> rather than <code>{prefix}/node.exe</code>.</p>
-
<p>When the <code>global</code> flag is set, npm installs things into this prefix.
When it is not set, it uses the root of the current package, or the
current working directory if not in a package already.</p>
-
-<h3 id="Node-Modules">Node Modules</h3>
-
+<h3 id="node-modules">Node Modules</h3>
<p>Packages are dropped into the <code>node_modules</code> folder under the <code>prefix</code>.
When installing locally, this means that you can
<code>require("packagename")</code> to load its main module, or
<code>require("packagename/lib/path/to/sub/module")</code> to load other modules.</p>
-
<p>Global installs on Unix systems go to <code>{prefix}/lib/node_modules</code>.
Global installs on Windows go to <code>{prefix}/node_modules</code> (that is, no
<code>lib</code> folder.)</p>
-
<p>If you wish to <code>require()</code> a package, then install it locally.</p>
-
-<h3 id="Executables">Executables</h3>
-
+<h3 id="executables">Executables</h3>
<p>When in global mode, executables are linked into <code>{prefix}/bin</code> on Unix,
or directly into <code>{prefix}</code> on Windows.</p>
-
<p>When in local mode, executables are linked into
<code>./node_modules/.bin</code> so that they can be made available to scripts run
through npm. (For example, so that a test runner will be in the path
when you run <code>npm test</code>.)</p>
-
-<h3 id="Man-Pages">Man Pages</h3>
-
+<h3 id="man-pages">Man Pages</h3>
<p>When in global mode, man pages are linked into <code>{prefix}/share/man</code>.</p>
-
<p>When in local mode, man pages are not installed.</p>
-
<p>Man pages are not installed on Windows systems.</p>
-
-<h3 id="Cache">Cache</h3>
-
+<h3 id="cache">Cache</h3>
<p>See <code><a href="../cli/npm-cache.html">npm-cache(1)</a></code>. Cache files are stored in <code>~/.npm</code> on Posix, or
<code>~/npm-cache</code> on Windows.</p>
-
<p>This is controlled by the <code>cache</code> configuration param.</p>
-
-<h3 id="Temp-Files">Temp Files</h3>
-
+<h3 id="temp-files">Temp Files</h3>
<p>Temporary files are stored by default in the folder specified by the
<code>tmp</code> config, which defaults to the TMPDIR, TMP, or TEMP environment
variables, or <code>/tmp</code> on Unix and <code>c:\windows\temp</code> on Windows.</p>
-
<p>Temp files are given a unique folder under this root for each run of the
program, and are deleted upon successful exit.</p>
-
-<h2 id="More-Information">More Information</h2>
-
+<h2 id="more-information">More Information</h2>
<p>When installing locally, npm first tries to find an appropriate
<code>prefix</code> folder. This is so that <code>npm install foo@1.2.3</code> will install
to the sensible root of your package, even if you happen to have <code>cd</code>ed
into some other folder.</p>
-
<p>Starting at the $PWD, npm will walk up the folder tree checking for a
folder that contains either a <code>package.json</code> file, or a <code>node_modules</code>
folder. If such a thing is found, then that is treated as the effective
"current directory" for the purpose of running npm commands. (This
behavior is inspired by and similar to git's .git-folder seeking
logic when running git commands in a working dir.)</p>
-
<p>If no package root is found, then the current folder is used.</p>
-
<p>When you run <code>npm install foo@1.2.3</code>, then the package is loaded into
the cache, and then unpacked into <code>./node_modules/foo</code>. Then, any of
foo's dependencies are similarly unpacked into
<code>./node_modules/foo/node_modules/...</code>.</p>
-
<p>Any bin files are symlinked to <code>./node_modules/.bin/</code>, so that they may
be found by npm scripts when necessary.</p>
-
-<h3 id="Global-Installation">Global Installation</h3>
-
+<h3 id="global-installation">Global Installation</h3>
<p>If the <code>global</code> configuration is set to true, then npm will
install packages "globally".</p>
-
<p>For global installation, packages are installed roughly the same way,
but using the folders described above.</p>
-
-<h3 id="Cycles-Conflicts-and-Folder-Parsimony">Cycles, Conflicts, and Folder Parsimony</h3>
-
+<h3 id="cycles-conflicts-and-folder-parsimony">Cycles, Conflicts, and Folder Parsimony</h3>
<p>Cycles are handled using the property of node's module system that it
walks up the directories looking for <code>node_modules</code> folders. So, at every
stage, if a package is already installed in an ancestor <code>node_modules</code>
folder, then it is not installed at the current location.</p>
-
<p>Consider the case above, where <code>foo -> bar -> baz</code>. Imagine if, in
addition to that, baz depended on bar, so you'd have:
<code>foo -> bar -> baz -> bar -> baz ...</code>. However, since the folder
put another copy of bar into <code>.../baz/node_modules</code>, since when it calls
require("bar"), it will get the copy that is installed in
<code>foo/node_modules/bar</code>.</p>
-
<p>This shortcut is only used if the exact same
version would be installed in multiple nested <code>node_modules</code> folders. It
is still possible to have <code>a/node_modules/b/node_modules/a</code> if the two
"a" packages are different versions. However, without repeating the
exact same package multiple times, an infinite regress will always be
prevented.</p>
-
<p>Another optimization can be made by installing dependencies at the
highest level possible, below the localized "target" folder.</p>
-
-<h4 id="Example">Example</h4>
-
+<h4 id="example">Example</h4>
<p>Consider this dependency graph:</p>
-
<pre><code>foo
+-- blerg@1.2.5
+-- bar@1.2.3
| `-- asdf@*
`-- baz@1.2.3
`-- quux@3.x
- `-- bar</code></pre>
-
-<p>In this case, we might expect a folder structure like this:</p>
-
+ `-- bar
+</code></pre><p>In this case, we might expect a folder structure like this:</p>
<pre><code>foo
+-- node_modules
+-- blerg (1.2.5) <---[A]
| `-- asdf (2.3.4)
`-- baz (1.2.3) <---[D]
`-- node_modules
- `-- quux (3.2.0) <---[E]</code></pre>
-
-<p>Since foo depends directly on <code>bar@1.2.3</code> and <code>baz@1.2.3</code>, those are
+ `-- quux (3.2.0) <---[E]
+</code></pre><p>Since foo depends directly on <code>bar@1.2.3</code> and <code>baz@1.2.3</code>, those are
installed in foo's <code>node_modules</code> folder.</p>
-
<p>Even though the latest copy of blerg is 1.3.7, foo has a specific
dependency on version 1.2.5. So, that gets installed at [A]. Since the
parent installation of blerg satisfies bar's dependency on <code>blerg@1.x</code>,
it does not install another copy under [B].</p>
-
<p>Bar [B] also has dependencies on baz and asdf, so those are installed in
bar's <code>node_modules</code> folder. Because it depends on <code>baz@2.x</code>, it cannot
re-use the <code>baz@1.2.3</code> installed in the parent <code>node_modules</code> folder [D],
and must install its own copy [C].</p>
-
<p>Underneath bar, the <code>baz -> quux -> bar</code> dependency creates a cycle.
However, because bar is already in quux's ancestry [B], it does not
unpack another copy of bar into that folder.</p>
-
<p>Underneath <code>foo -> baz</code> [D], quux's [E] folder tree is empty, because its
dependency on bar is satisfied by the parent folder copy installed at [B].</p>
-
<p>For a graphical breakdown of what is installed where, use <code>npm ls</code>.</p>
-
-<h3 id="Publishing">Publishing</h3>
-
+<h3 id="publishing">Publishing</h3>
<p>Upon publishing, npm will look in the <code>node_modules</code> folder. If any of
the items there are not in the <code>bundledDependencies</code> array, then they will
not be included in the package tarball.</p>
-
<p>This allows a package maintainer to install all of their dependencies
(and dev dependencies) locally, but only re-publish those items that
cannot be found elsewhere. See <code><a href="../files/package.json.html">package.json(5)</a></code> for more information.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<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="../cli/npm-pack.html">npm-pack(1)</a></li>
+<li><a href="../cli/npm-cache.html">npm-cache(1)</a></li>
+<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
+<li><a href="../files/npmrc.html">npmrc(5)</a></li>
+<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
+<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><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="../cli/npm-pack.html">npm-pack(1)</a></li><li><a href="../cli/npm-cache.html">npm-cache(1)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-folders — npm@1.4.9</p>
+<p id="footer">npm-folders — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../files/package.json.html">package.json</a></h1> <p>Specifics of npm's package.json handling</p>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="description">DESCRIPTION</h2>
<p>This document is all you need to know about what's required in your package.json
file. It must be actual JSON, not just a JavaScript object literal.</p>
-
<p>A lot of the behavior described in this document is affected by the config
settings described in <code><a href="../misc/npm-config.html">npm-config(7)</a></code>.</p>
-
<h2 id="name">name</h2>
-
<p>The <em>most</em> important things in your package.json are the name and version fields.
Those are actually required, and your package won't install without
them. The name and version together form an identifier that is assumed
to be completely unique. Changes to the package should come along with
changes to the version.</p>
-
<p>The name is what your thing is called. Some tips:</p>
-
-<ul><li>Don't put "js" or "node" in the name. It's assumed that it's js, since you're
+<ul>
+<li>Don't put "js" or "node" in the name. It's assumed that it's js, since you're
writing a package.json file, and you can specify the engine using the "engines"
-field. (See below.)</li><li>The name ends up being part of a URL, an argument on the command line, and a
+field. (See below.)</li>
+<li>The name ends up being part of a URL, an argument on the command line, and a
folder name. Any name with non-url-safe characters will be rejected.
-Also, it can't start with a dot or an underscore.</li><li>The name will probably be passed as an argument to require(), so it should
-be something short, but also reasonably descriptive.</li><li>You may want to check the npm registry to see if there's something by that name
-already, before you get too attached to it. http://registry.npmjs.org/</li></ul>
-
+Also, it can't start with a dot or an underscore.</li>
+<li>The name will probably be passed as an argument to require(), so it should
+be something short, but also reasonably descriptive.</li>
+<li>You may want to check the npm registry to see if there's something by that name
+already, before you get too attached to it. <a href="http://registry.npmjs.org/">http://registry.npmjs.org/</a></li>
+</ul>
<h2 id="version">version</h2>
-
<p>The <em>most</em> important things in your package.json are the name and version fields.
Those are actually required, and your package won't install without
them. The name and version together form an identifier that is assumed
to be completely unique. Changes to the package should come along with
changes to the version.</p>
-
<p>Version must be parseable by
<a href="https://github.com/isaacs/node-semver">node-semver</a>, which is bundled
with npm as a dependency. (<code>npm install semver</code> to use it yourself.)</p>
-
<p>More on version numbers and ranges at <a href="../misc/semver.html">semver(7)</a>.</p>
-
<h2 id="description">description</h2>
-
<p>Put a description in it. It's a string. This helps people discover your
package, as it's listed in <code>npm search</code>.</p>
-
<h2 id="keywords">keywords</h2>
-
<p>Put keywords in it. It's an array of strings. This helps people
discover your package as it's listed in <code>npm search</code>.</p>
-
<h2 id="homepage">homepage</h2>
-
<p>The url to the project homepage.</p>
-
<p><strong>NOTE</strong>: This is <em>not</em> the same as "url". If you put a "url" field,
then the registry will think it's a redirection to your package that has
been published somewhere else, and spit at you.</p>
-
<p>Literally. Spit. I'm so not kidding.</p>
-
<h2 id="bugs">bugs</h2>
-
<p>The url to your project's issue tracker and / or the email address to which
issues should be reported. These are helpful for people who encounter issues
with your package.</p>
-
<p>It should look like this:</p>
-
<pre><code>{ "url" : "http://github.com/owner/project/issues"
, "email" : "project@hostname.com"
-}</code></pre>
-
-<p>You can specify either one or both values. If you want to provide only a url,
+}
+</code></pre><p>You can specify either one or both values. If you want to provide only a url,
you can specify the value for "bugs" as a simple string instead of an object.</p>
-
<p>If a url is provided, it will be used by the <code>npm bugs</code> command.</p>
-
<h2 id="license">license</h2>
-
<p>You should specify a license for your package so that people know how they are
permitted to use it, and any restrictions you're placing on it.</p>
-
<p>The simplest way, assuming you're using a common license such as BSD-3-Clause
or MIT, is to just specify the standard SPDX ID of the license you're using,
like this:</p>
-
-<pre><code>{ "license" : "BSD-3-Clause" }</code></pre>
-
-<p>You can check <a href="https://spdx.org/licenses/">the full list of SPDX license IDs</a>.
+<pre><code>{ "license" : "BSD-3-Clause" }
+</code></pre><p>You can check <a href="https://spdx.org/licenses/">the full list of SPDX license IDs</a>.
Ideally you should pick one that is
<a href="http://opensource.org/licenses/alphabetical">OSI</a> approved.</p>
-
<p>It's also a good idea to include a LICENSE file at the top level in
your package.</p>
-
<h2 id="people-fields-author-contributors">people fields: author, contributors</h2>
-
<p>The "author" is one person. "contributors" is an array of people. A "person"
is an object with a "name" field and optionally "url" and "email", like this:</p>
-
<pre><code>{ "name" : "Barney Rubble"
, "email" : "b@rubble.com"
, "url" : "http://barnyrubble.tumblr.com/"
-}</code></pre>
-
-<p>Or you can shorten that all into a single string, and npm will parse it for you:</p>
-
-<pre><code>"Barney Rubble <b@rubble.com> (http://barnyrubble.tumblr.com/)</code></pre>
-
-<p>Both email and url are optional either way.</p>
-
+}
+</code></pre><p>Or you can shorten that all into a single string, and npm will parse it for you:</p>
+<pre><code>"Barney Rubble <b@rubble.com> (http://barnyrubble.tumblr.com/)
+</code></pre><p>Both email and url are optional either way.</p>
<p>npm also sets a top-level "maintainers" field with your npm user info.</p>
-
<h2 id="files">files</h2>
-
<p>The "files" field is an array of files to include in your project. If
you name a folder in the array, then it will also include the files
inside that folder. (Unless they would be ignored by another rule.)</p>
-
<p>You can also provide a ".npmignore" file in the root of your package,
which will keep files from being included, even if they would be picked
up by the files array. The ".npmignore" file works just like a
".gitignore".</p>
-
<h2 id="main">main</h2>
-
<p>The main field is a module ID that is the primary entry point to your program.
That is, if your package is named <code>foo</code>, and a user installs it, and then does
<code>require("foo")</code>, then your main module's exports object will be returned.</p>
-
<p>This should be a module ID relative to the root of your package folder.</p>
-
<p>For most modules, it makes the most sense to have a main script and often not
much else.</p>
-
<h2 id="bin">bin</h2>
-
<p>A lot of packages have one or more executable files that they'd like to
install into the PATH. npm makes this pretty easy (in fact, it uses this
feature to install the "npm" executable.)</p>
-
<p>To use this, supply a <code>bin</code> field in your package.json which is a map of
command name to local file name. On install, npm will symlink that file into
<code>prefix/bin</code> for global installs, or <code>./node_modules/.bin/</code> for local
installs.</p>
-
<p>For example, npm has this:</p>
-
-<pre><code>{ "bin" : { "npm" : "./cli.js" } }</code></pre>
-
-<p>So, when you install npm, it'll create a symlink from the <code>cli.js</code> script to
+<pre><code>{ "bin" : { "npm" : "./cli.js" } }
+</code></pre><p>So, when you install npm, it'll create a symlink from the <code>cli.js</code> script to
<code>/usr/local/bin/npm</code>.</p>
-
<p>If you have a single executable, and its name should be the name
of the package, then you can just supply it as a string. For example:</p>
-
<pre><code>{ "name": "my-program"
, "version": "1.2.5"
-, "bin": "./path/to/program" }</code></pre>
-
-<p>would be the same as this:</p>
-
+, "bin": "./path/to/program" }
+</code></pre><p>would be the same as this:</p>
<pre><code>{ "name": "my-program"
, "version": "1.2.5"
-, "bin" : { "my-program" : "./path/to/program" } }</code></pre>
-
-<h2 id="man">man</h2>
-
+, "bin" : { "my-program" : "./path/to/program" } }
+</code></pre><h2 id="man">man</h2>
<p>Specify either a single file or an array of filenames to put in place for the
<code>man</code> program to find.</p>
-
<p>If only a single file is provided, then it's installed such that it is the
result from <code>man <pkgname></code>, regardless of its actual filename. For example:</p>
-
<pre><code>{ "name" : "foo"
, "version" : "1.2.3"
, "description" : "A packaged foo fooer for fooing foos"
, "main" : "foo.js"
, "man" : "./man/doc.1"
-}</code></pre>
-
-<p>would link the <code>./man/doc.1</code> file in such that it is the target for <code>man foo</code></p>
-
+}
+</code></pre><p>would link the <code>./man/doc.1</code> file in such that it is the target for <code>man foo</code></p>
<p>If the filename doesn't start with the package name, then it's prefixed.
So, this:</p>
-
<pre><code>{ "name" : "foo"
, "version" : "1.2.3"
, "description" : "A packaged foo fooer for fooing foos"
, "main" : "foo.js"
, "man" : [ "./man/foo.1", "./man/bar.1" ]
-}</code></pre>
-
-<p>will create files to do <code>man foo</code> and <code>man foo-bar</code>.</p>
-
+}
+</code></pre><p>will create files to do <code>man foo</code> and <code>man foo-bar</code>.</p>
<p>Man files must end with a number, and optionally a <code>.gz</code> suffix if they are
compressed. The number dictates which man section the file is installed into.</p>
-
<pre><code>{ "name" : "foo"
, "version" : "1.2.3"
, "description" : "A packaged foo fooer for fooing foos"
, "main" : "foo.js"
, "man" : [ "./man/foo.1", "./man/foo.2" ]
-}</code></pre>
-
-<p>will create entries for <code>man foo</code> and <code>man 2 foo</code></p>
-
+}
+</code></pre><p>will create entries for <code>man foo</code> and <code>man 2 foo</code></p>
<h2 id="directories">directories</h2>
-
<p>The CommonJS <a href="http://wiki.commonjs.org/wiki/Packages/1.0">Packages</a> spec details a
few ways that you can indicate the structure of your package using a <code>directories</code>
hash. If you look at <a href="http://registry.npmjs.org/npm/latest">npm's package.json</a>,
you'll see that it has directories for doc, lib, and man.</p>
-
<p>In the future, this information may be used in other creative ways.</p>
-
<h3 id="directories-lib">directories.lib</h3>
-
<p>Tell people where the bulk of your library is. Nothing special is done
with the lib folder in any way, but it's useful meta info.</p>
-
<h3 id="directories-bin">directories.bin</h3>
-
<p>If you specify a "bin" directory, then all the files in that folder will
be used as the "bin" hash.</p>
-
<p>If you have a "bin" hash already, then this has no effect.</p>
-
<h3 id="directories-man">directories.man</h3>
-
<p>A folder that is full of man pages. Sugar to generate a "man" array by
walking the folder.</p>
-
<h3 id="directories-doc">directories.doc</h3>
-
<p>Put markdown files in here. Eventually, these will be displayed nicely,
maybe, someday.</p>
-
<h3 id="directories-example">directories.example</h3>
-
<p>Put example scripts in here. Someday, it might be exposed in some clever way.</p>
-
<h2 id="repository">repository</h2>
-
<p>Specify the place where your code lives. This is helpful for people who
want to contribute. If the git repo is on github, then the <code>npm docs</code>
command will be able to find you.</p>
-
<p>Do it like this:</p>
-
<pre><code>"repository" :
{ "type" : "git"
, "url" : "http://github.com/npm/npm.git"
"repository" :
{ "type" : "svn"
, "url" : "http://v8.googlecode.com/svn/trunk/"
- }</code></pre>
-
-<p>The URL should be a publicly available (perhaps read-only) url that can be handed
+ }
+</code></pre><p>The URL should be a publicly available (perhaps read-only) url that can be handed
directly to a VCS program without any modification. It should not be a url to an
html project page that you put in your browser. It's for computers.</p>
-
<h2 id="scripts">scripts</h2>
-
<p>The "scripts" member is an object hash of script commands that are run
at various times in the lifecycle of your package. The key is the lifecycle
event, and the value is the command to run at that point.</p>
-
<p>See <code><a href="../misc/npm-scripts.html">npm-scripts(7)</a></code> to find out more about writing package scripts.</p>
-
<h2 id="config">config</h2>
-
<p>A "config" hash can be used to set configuration
parameters used in package scripts that persist across upgrades. For
instance, if a package had the following:</p>
-
<pre><code>{ "name" : "foo"
-, "config" : { "port" : "8080" } }</code></pre>
-
-<p>and then had a "start" command that then referenced the
+, "config" : { "port" : "8080" } }
+</code></pre><p>and then had a "start" command that then referenced the
<code>npm_package_config_port</code> environment variable, then the user could
override that by doing <code>npm config set foo:port 8001</code>.</p>
-
<p>See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> and <code><a href="../misc/npm-scripts.html">npm-scripts(7)</a></code> for more on package
configs.</p>
-
<h2 id="dependencies">dependencies</h2>
-
<p>Dependencies are specified with a simple hash of package name to
version range. The version range is a string which has one or more
space-separated descriptors. Dependencies can also be identified with
a tarball or git URL.</p>
-
<p><strong>Please do not put test harnesses or transpilers in your
<code>dependencies</code> hash.</strong> See <code>devDependencies</code>, below.</p>
-
<p>See <a href="../misc/semver.html">semver(7)</a> for more details about specifying version ranges.</p>
-
-<ul><li><code>version</code> Must match <code>version</code> exactly</li><li><code>>version</code> Must be greater than <code>version</code></li><li><code>>=version</code> etc</li><li><code><version</code></li><li><code><=version</code></li><li><code>~version</code> "Approximately equivalent to version" See <a href="../misc/semver.html">semver(7)</a></li><li><code>^version</code> "Compatible with version" See <a href="../misc/semver.html">semver(7)</a></li><li><code>1.2.x</code> 1.2.0, 1.2.1, etc., but not 1.3.0</li><li><code>http://...</code> See 'URLs as Dependencies' below</li><li><code>*</code> Matches any version</li><li><code>""</code> (just an empty string) Same as <code>*</code></li><li><code>version1 - version2</code> Same as <code>>=version1 <=version2</code>.</li><li><code>range1 || range2</code> Passes if either range1 or range2 are satisfied.</li><li><code>git...</code> See 'Git URLs as Dependencies' below</li><li><code>user/repo</code> See 'GitHub URLs' below</li></ul>
-
+<ul>
+<li><code>version</code> Must match <code>version</code> exactly</li>
+<li><code>>version</code> Must be greater than <code>version</code></li>
+<li><code>>=version</code> etc</li>
+<li><code><version</code></li>
+<li><code><=version</code></li>
+<li><code>~version</code> "Approximately equivalent to version" See <a href="../misc/semver.html">semver(7)</a></li>
+<li><code>^version</code> "Compatible with version" See <a href="../misc/semver.html">semver(7)</a></li>
+<li><code>1.2.x</code> 1.2.0, 1.2.1, etc., but not 1.3.0</li>
+<li><code>http://...</code> See 'URLs as Dependencies' below</li>
+<li><code>*</code> Matches any version</li>
+<li><code>""</code> (just an empty string) Same as <code>*</code></li>
+<li><code>version1 - version2</code> Same as <code>>=version1 <=version2</code>.</li>
+<li><code>range1 || range2</code> Passes if either range1 or range2 are satisfied.</li>
+<li><code>git...</code> See 'Git URLs as Dependencies' below</li>
+<li><code>user/repo</code> See 'GitHub URLs' below</li>
+</ul>
<p>For example, these are all valid:</p>
-
<pre><code>{ "dependencies" :
{ "foo" : "1.0.0 - 2.9999.9999"
, "bar" : ">=1.0.2 <2.1.2"
, "two" : "2.x"
, "thr" : "3.3.x"
}
-}</code></pre>
-
-<h3 id="URLs-as-Dependencies">URLs as Dependencies</h3>
-
+}
+</code></pre><h3 id="urls-as-dependencies">URLs as Dependencies</h3>
<p>You may specify a tarball URL in place of a version range.</p>
-
<p>This tarball will be downloaded and installed locally to your package at
install time.</p>
-
-<h3 id="Git-URLs-as-Dependencies">Git URLs as Dependencies</h3>
-
+<h3 id="git-urls-as-dependencies">Git URLs as Dependencies</h3>
<p>Git urls can be of the form:</p>
-
<pre><code>git://github.com/user/project.git#commit-ish
git+ssh://user@hostname:project.git#commit-ish
git+ssh://user@hostname/project.git#commit-ish
git+http://user@hostname/project/blah.git#commit-ish
-git+https://user@hostname/project/blah.git#commit-ish</code></pre>
-
-<p>The <code>commit-ish</code> can be any tag, sha, or branch which can be supplied as
+git+https://user@hostname/project/blah.git#commit-ish
+</code></pre><p>The <code>commit-ish</code> can be any tag, sha, or branch which can be supplied as
an argument to <code>git checkout</code>. The default is <code>master</code>.</p>
-
-<h2 id="GitHub-URLs">GitHub URLs</h2>
-
+<h2 id="github-urls">GitHub URLs</h2>
<p>As of version 1.1.65, you can refer to GitHub urls as just "foo": "user/foo-project". For example:</p>
-
<pre><code>{
"name": "foo",
"version": "0.0.0",
"dependencies": {
"express": "visionmedia/express"
}
-}</code></pre>
-
-<h2 id="devDependencies">devDependencies</h2>
-
+}
+</code></pre><h2 id="devdependencies">devDependencies</h2>
<p>If someone is planning on downloading and using your module in their
program, then they probably don't want or need to download and build
the external test or documentation framework that you use.</p>
-
<p>In this case, it's best to list these additional items in a
<code>devDependencies</code> hash.</p>
-
<p>These things will be installed when doing <code>npm link</code> or <code>npm install</code>
from the root of a package, and can be managed like any other npm
configuration param. See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> for more on the topic.</p>
-
<p>For build steps that are not platform-specific, such as compiling
CoffeeScript or other languages to JavaScript, use the <code>prepublish</code>
script to do this, and make the required package a devDependency.</p>
-
<p>For example:</p>
-
<pre><code>{ "name": "ethopia-waza",
"description": "a delightfully fruity coffee varietal",
"version": "1.2.3",
"prepublish": "coffee -o lib/ -c src/waza.coffee"
},
"main": "lib/waza.js"
-}</code></pre>
-
-<p>The <code>prepublish</code> script will be run before publishing, so that users
+}
+</code></pre><p>The <code>prepublish</code> script will be run before publishing, so that users
can consume the functionality without requiring them to compile it
themselves. In dev mode (ie, locally running <code>npm install</code>), it'll
run this script as well, so that you can test it easily.</p>
-
-<h2 id="peerDependencies">peerDependencies</h2>
-
+<h2 id="peerdependencies">peerDependencies</h2>
<p>In some cases, you want to express the compatibility of your package with an
host tool or library, while not necessarily doing a <code>require</code> of this host.
This is usually refered to as a <em>plugin</em>. Notably, your module may be exposing
a specific interface, expected and specified by the host documentation.</p>
-
<p>For example:</p>
-
<pre><code>{
"name": "tea-latte",
"version": "1.3.5"
"peerDependencies": {
"tea": "2.x"
}
-}</code></pre>
-
-<p>This ensures your package <code>tea-latte</code> can be installed <em>along</em> with the second
+}
+</code></pre><p>This ensures your package <code>tea-latte</code> can be installed <em>along</em> with the second
major version of the host package <code>tea</code> only. The host package is automatically
installed if needed. <code>npm install tea-latte</code> could possibly yield the following
dependency graph:</p>
-
<pre><code>├── tea-latte@1.3.5
-└── tea@2.2.0</code></pre>
-
-<p>Trying to install another plugin with a conflicting requirement will cause an
+└── tea@2.2.0
+</code></pre><p>Trying to install another plugin with a conflicting requirement will cause an
error. For this reason, make sure your plugin requirement is as broad as
possible, and not to lock it down to specific patch versions.</p>
-
<p>Assuming the host complies with <a href="http://semver.org/">semver</a>, only changes in
the host package's major version will break your plugin. Thus, if you've worked
with every 1.x version of the host package, use <code>"^1.0"</code> or <code>"1.x"</code> to express
this. If you depend on features introduced in 1.5.2, use <code>">= 1.5.2 < 2"</code>.</p>
-
-<h2 id="bundledDependencies">bundledDependencies</h2>
-
+<h2 id="bundleddependencies">bundledDependencies</h2>
<p>Array of package names that will be bundled when publishing the package.</p>
-
<p>If this is spelled <code>"bundleDependencies"</code>, then that is also honorable.</p>
-
-<h2 id="optionalDependencies">optionalDependencies</h2>
-
+<h2 id="optionaldependencies">optionalDependencies</h2>
<p>If a dependency can be used, but you would like npm to proceed if it
cannot be found or fails to install, then you may put it in the
<code>optionalDependencies</code> hash. This is a map of package name to version
or url, just like the <code>dependencies</code> hash. The difference is that
failure is tolerated.</p>
-
<p>It is still your program's responsibility to handle the lack of the
dependency. For example, something like this:</p>
-
<pre><code>try {
var foo = require('foo')
var fooVersion = require('foo/package.json').version
if (foo) {
foo.doFooThings()
-}</code></pre>
-
-<p>Entries in <code>optionalDependencies</code> will override entries of the same name in
+}
+</code></pre><p>Entries in <code>optionalDependencies</code> will override entries of the same name in
<code>dependencies</code>, so it's usually best to only put in one place.</p>
-
<h2 id="engines">engines</h2>
-
<p>You can specify the version of node that your stuff works on:</p>
-
-<pre><code>{ "engines" : { "node" : ">=0.10.3 <0.12" } }</code></pre>
-
-<p>And, like with dependencies, if you don't specify the version (or if you
+<pre><code>{ "engines" : { "node" : ">=0.10.3 <0.12" } }
+</code></pre><p>And, like with dependencies, if you don't specify the version (or if you
specify "*" as the version), then any version of node will do.</p>
-
<p>If you specify an "engines" field, then npm will require that "node" be
somewhere on that list. If "engines" is omitted, then npm will just assume
that it works on node.</p>
-
<p>You can also use the "engines" field to specify which versions of npm
are capable of properly installing your program. For example:</p>
-
-<pre><code>{ "engines" : { "npm" : "~1.0.20" } }</code></pre>
-
-<p>Note that, unless the user has set the <code>engine-strict</code> config flag, this
+<pre><code>{ "engines" : { "npm" : "~1.0.20" } }
+</code></pre><p>Note that, unless the user has set the <code>engine-strict</code> config flag, this
field is advisory only.</p>
-
-<h2 id="engineStrict">engineStrict</h2>
-
+<h2 id="enginestrict">engineStrict</h2>
<p>If you are sure that your module will <em>definitely not</em> run properly on
versions of Node/npm other than those specified in the <code>engines</code> hash,
then you can set <code>"engineStrict": true</code> in your package.json file.
This will override the user's <code>engine-strict</code> config setting.</p>
-
<p>Please do not do this unless you are really very very sure. If your
engines hash is something overly restrictive, you can quite easily and
inadvertently lock yourself into obscurity and prevent your users from
updating to new versions of Node. Consider this choice carefully. If
people abuse it, it will be removed in a future version of npm.</p>
-
<h2 id="os">os</h2>
-
<p>You can specify which operating systems your
module will run on:</p>
-
-<pre><code>"os" : [ "darwin", "linux" ]</code></pre>
-
-<p>You can also blacklist instead of whitelist operating systems,
+<pre><code>"os" : [ "darwin", "linux" ]
+</code></pre><p>You can also blacklist instead of whitelist operating systems,
just prepend the blacklisted os with a '!':</p>
-
-<pre><code>"os" : [ "!win32" ]</code></pre>
-
-<p>The host operating system is determined by <code>process.platform</code></p>
-
+<pre><code>"os" : [ "!win32" ]
+</code></pre><p>The host operating system is determined by <code>process.platform</code></p>
<p>It is allowed to both blacklist, and whitelist, although there isn't any
good reason to do this.</p>
-
<h2 id="cpu">cpu</h2>
-
<p>If your code only runs on certain cpu architectures,
you can specify which ones.</p>
-
-<pre><code>"cpu" : [ "x64", "ia32" ]</code></pre>
-
-<p>Like the <code>os</code> option, you can also blacklist architectures:</p>
-
-<pre><code>"cpu" : [ "!arm", "!mips" ]</code></pre>
-
-<p>The host architecture is determined by <code>process.arch</code></p>
-
-<h2 id="preferGlobal">preferGlobal</h2>
-
+<pre><code>"cpu" : [ "x64", "ia32" ]
+</code></pre><p>Like the <code>os</code> option, you can also blacklist architectures:</p>
+<pre><code>"cpu" : [ "!arm", "!mips" ]
+</code></pre><p>The host architecture is determined by <code>process.arch</code></p>
+<h2 id="preferglobal">preferGlobal</h2>
<p>If your package is primarily a command-line application that should be
installed globally, then set this value to <code>true</code> to provide a warning
if it is installed locally.</p>
-
<p>It doesn't actually prevent users from installing it locally, but it
does help prevent some confusion if it doesn't work as expected.</p>
-
<h2 id="private">private</h2>
-
<p>If you set <code>"private": true</code> in your package.json, then npm will refuse
to publish it.</p>
-
<p>This is a way to prevent accidental publication of private repositories.
If you would like to ensure that a given package is only ever published
to a specific registry (for example, an internal registry),
then use the <code>publishConfig</code> hash described below
to override the <code>registry</code> config param at publish-time.</p>
-
-<h2 id="publishConfig">publishConfig</h2>
-
+<h2 id="publishconfig">publishConfig</h2>
<p>This is a set of config values that will be used at publish-time. It's
especially handy if you want to set the tag or registry, so that you can
ensure that a given package is not tagged with "latest" or published to
the global public registry by default.</p>
-
<p>Any config values can be overridden, but of course only "tag" and
"registry" probably matter for the purposes of publishing.</p>
-
<p>See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> to see the list of config options that can be
overridden.</p>
-
-<h2 id="DEFAULT-VALUES">DEFAULT VALUES</h2>
-
+<h2 id="default-values">DEFAULT VALUES</h2>
<p>npm will default some values based on package contents.</p>
-
-<ul><li><p><code>"scripts": {"start": "node server.js"}</code></p><p>If there is a <code>server.js</code> file in the root of your package, then npm
-will default the <code>start</code> command to <code>node server.js</code>.</p></li><li><p><code>"scripts":{"preinstall": "node-gyp rebuild"}</code></p><p>If there is a <code>binding.gyp</code> file in the root of your package, npm will
-default the <code>preinstall</code> command to compile using node-gyp.</p></li><li><p><code>"contributors": [...]</code></p><p>If there is an <code>AUTHORS</code> file in the root of your package, npm will
+<ul>
+<li><p><code>"scripts": {"start": "node server.js"}</code></p>
+<p>If there is a <code>server.js</code> file in the root of your package, then npm
+will default the <code>start</code> command to <code>node server.js</code>.</p>
+</li>
+<li><p><code>"scripts":{"preinstall": "node-gyp rebuild"}</code></p>
+<p>If there is a <code>binding.gyp</code> file in the root of your package, npm will
+default the <code>preinstall</code> command to compile using node-gyp.</p>
+</li>
+<li><p><code>"contributors": [...]</code></p>
+<p>If there is an <code>AUTHORS</code> file in the root of your package, npm will
treat each line as a <code>Name <email> (url)</code> format, where email and url
are optional. Lines which start with a <code>#</code> or are blank, will be
-ignored.</p></li></ul>
-
-<h2 id="SEE-ALSO">SEE ALSO</h2>
+ignored.</p>
+</li>
+</ul>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../misc/semver.html">semver(7)</a></li>
+<li><a href="../cli/npm-init.html">npm-init(1)</a></li>
+<li><a href="../cli/npm-version.html">npm-version(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="../cli/npm-help.html">npm-help(1)</a></li>
+<li><a href="../misc/npm-faq.html">npm-faq(7)</a></li>
+<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
+<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
+<li><a href="../cli/npm-rm.html">npm-rm(1)</a></li>
+</ul>
-<ul><li><a href="../misc/semver.html">semver(7)</a></li><li><a href="../cli/npm-init.html">npm-init(1)</a></li><li><a href="../cli/npm-version.html">npm-version(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="../cli/npm-help.html">npm-help(1)</a></li><li><a href="../misc/npm-faq.html">npm-faq(7)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../cli/npm-rm.html">npm-rm(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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">package.json — npm@1.4.9</p>
+<p id="footer">package.json — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../files/npmrc.html">npmrc</a></h1> <p>The npm config files</p>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="description">DESCRIPTION</h2>
<p>npm gets its config settings from the command line, environment
variables, and <code>npmrc</code> files.</p>
-
<p>The <code>npm config</code> command can be used to update and edit the contents
of the user and global npmrc files.</p>
-
<p>For a list of available configuration options, see <a href="../misc/npm-config.html">npm-config(7)</a>.</p>
-
-<h2 id="FILES">FILES</h2>
-
+<h2 id="files">FILES</h2>
<p>The three relevant files are:</p>
-
-<ul><li>per-user config file (~/.npmrc)</li><li>global config file ($PREFIX/npmrc)</li><li>npm builtin config file (/path/to/npm/npmrc)</li></ul>
-
+<ul>
+<li>per-user config file (~/.npmrc)</li>
+<li>global config file ($PREFIX/npmrc)</li>
+<li>npm builtin config file (/path/to/npm/npmrc)</li>
+</ul>
<p>All npm config files are an ini-formatted list of <code>key = value</code>
parameters. Environment variables can be replaced using
<code>${VARIABLE_NAME}</code>. For example:</p>
-
-<pre><code>prefix = ${HOME}/.npm-packages</code></pre>
-
-<p>Each of these files is loaded, and config options are resolved in
+<pre><code>prefix = ${HOME}/.npm-packages
+</code></pre><p>Each of these files is loaded, and config options are resolved in
priority order. For example, a setting in the userconfig file would
override the setting in the globalconfig file.</p>
-
-<h3 id="Per-user-config-file">Per-user config file</h3>
-
+<h3 id="per-user-config-file">Per-user config file</h3>
<p><code>$HOME/.npmrc</code> (or the <code>userconfig</code> param, if set in the environment
or on the command line)</p>
-
-<h3 id="Global-config-file">Global config file</h3>
-
+<h3 id="global-config-file">Global config file</h3>
<p><code>$PREFIX/etc/npmrc</code> (or the <code>globalconfig</code> param, if set above):
This file is an ini-file formatted list of <code>key = value</code> parameters.
Environment variables can be replaced as above.</p>
-
-<h3 id="Built-in-config-file">Built-in config file</h3>
-
+<h3 id="built-in-config-file">Built-in config file</h3>
<p><code>path/to/npm/itself/npmrc</code></p>
-
<p>This is an unchangeable "builtin" configuration file that npm keeps
consistent across updates. Set fields in here using the <code>./configure</code>
script that comes with npm. This is primarily for distribution
maintainers to override default configs in a standard and consistent
manner.</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-config.html">npm-config(1)</a></li>
+<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
+<li><a href="../files/package.json.html">package.json(5)</a></li>
+<li><a href="../cli/npm.html">npm(1)</a></li>
+</ul>
-<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-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../cli/npm.html">npm(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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">npmrc — npm@1.4.9</p>
+<p id="footer">npmrc — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../files/package.json.html">package.json</a></h1> <p>Specifics of npm's package.json handling</p>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="description">DESCRIPTION</h2>
<p>This document is all you need to know about what's required in your package.json
file. It must be actual JSON, not just a JavaScript object literal.</p>
-
<p>A lot of the behavior described in this document is affected by the config
settings described in <code><a href="../misc/npm-config.html">npm-config(7)</a></code>.</p>
-
<h2 id="name">name</h2>
-
<p>The <em>most</em> important things in your package.json are the name and version fields.
Those are actually required, and your package won't install without
them. The name and version together form an identifier that is assumed
to be completely unique. Changes to the package should come along with
changes to the version.</p>
-
<p>The name is what your thing is called. Some tips:</p>
-
-<ul><li>Don't put "js" or "node" in the name. It's assumed that it's js, since you're
+<ul>
+<li>Don't put "js" or "node" in the name. It's assumed that it's js, since you're
writing a package.json file, and you can specify the engine using the "engines"
-field. (See below.)</li><li>The name ends up being part of a URL, an argument on the command line, and a
+field. (See below.)</li>
+<li>The name ends up being part of a URL, an argument on the command line, and a
folder name. Any name with non-url-safe characters will be rejected.
-Also, it can't start with a dot or an underscore.</li><li>The name will probably be passed as an argument to require(), so it should
-be something short, but also reasonably descriptive.</li><li>You may want to check the npm registry to see if there's something by that name
-already, before you get too attached to it. http://registry.npmjs.org/</li></ul>
-
+Also, it can't start with a dot or an underscore.</li>
+<li>The name will probably be passed as an argument to require(), so it should
+be something short, but also reasonably descriptive.</li>
+<li>You may want to check the npm registry to see if there's something by that name
+already, before you get too attached to it. <a href="http://registry.npmjs.org/">http://registry.npmjs.org/</a></li>
+</ul>
<h2 id="version">version</h2>
-
<p>The <em>most</em> important things in your package.json are the name and version fields.
Those are actually required, and your package won't install without
them. The name and version together form an identifier that is assumed
to be completely unique. Changes to the package should come along with
changes to the version.</p>
-
<p>Version must be parseable by
<a href="https://github.com/isaacs/node-semver">node-semver</a>, which is bundled
with npm as a dependency. (<code>npm install semver</code> to use it yourself.)</p>
-
<p>More on version numbers and ranges at <a href="../misc/semver.html">semver(7)</a>.</p>
-
<h2 id="description">description</h2>
-
<p>Put a description in it. It's a string. This helps people discover your
package, as it's listed in <code>npm search</code>.</p>
-
<h2 id="keywords">keywords</h2>
-
<p>Put keywords in it. It's an array of strings. This helps people
discover your package as it's listed in <code>npm search</code>.</p>
-
<h2 id="homepage">homepage</h2>
-
<p>The url to the project homepage.</p>
-
<p><strong>NOTE</strong>: This is <em>not</em> the same as "url". If you put a "url" field,
then the registry will think it's a redirection to your package that has
been published somewhere else, and spit at you.</p>
-
<p>Literally. Spit. I'm so not kidding.</p>
-
<h2 id="bugs">bugs</h2>
-
<p>The url to your project's issue tracker and / or the email address to which
issues should be reported. These are helpful for people who encounter issues
with your package.</p>
-
<p>It should look like this:</p>
-
<pre><code>{ "url" : "http://github.com/owner/project/issues"
, "email" : "project@hostname.com"
-}</code></pre>
-
-<p>You can specify either one or both values. If you want to provide only a url,
+}
+</code></pre><p>You can specify either one or both values. If you want to provide only a url,
you can specify the value for "bugs" as a simple string instead of an object.</p>
-
<p>If a url is provided, it will be used by the <code>npm bugs</code> command.</p>
-
<h2 id="license">license</h2>
-
<p>You should specify a license for your package so that people know how they are
permitted to use it, and any restrictions you're placing on it.</p>
-
<p>The simplest way, assuming you're using a common license such as BSD-3-Clause
or MIT, is to just specify the standard SPDX ID of the license you're using,
like this:</p>
-
-<pre><code>{ "license" : "BSD-3-Clause" }</code></pre>
-
-<p>You can check <a href="https://spdx.org/licenses/">the full list of SPDX license IDs</a>.
+<pre><code>{ "license" : "BSD-3-Clause" }
+</code></pre><p>You can check <a href="https://spdx.org/licenses/">the full list of SPDX license IDs</a>.
Ideally you should pick one that is
<a href="http://opensource.org/licenses/alphabetical">OSI</a> approved.</p>
-
<p>It's also a good idea to include a LICENSE file at the top level in
your package.</p>
-
<h2 id="people-fields-author-contributors">people fields: author, contributors</h2>
-
<p>The "author" is one person. "contributors" is an array of people. A "person"
is an object with a "name" field and optionally "url" and "email", like this:</p>
-
<pre><code>{ "name" : "Barney Rubble"
, "email" : "b@rubble.com"
, "url" : "http://barnyrubble.tumblr.com/"
-}</code></pre>
-
-<p>Or you can shorten that all into a single string, and npm will parse it for you:</p>
-
-<pre><code>"Barney Rubble <b@rubble.com> (http://barnyrubble.tumblr.com/)</code></pre>
-
-<p>Both email and url are optional either way.</p>
-
+}
+</code></pre><p>Or you can shorten that all into a single string, and npm will parse it for you:</p>
+<pre><code>"Barney Rubble <b@rubble.com> (http://barnyrubble.tumblr.com/)
+</code></pre><p>Both email and url are optional either way.</p>
<p>npm also sets a top-level "maintainers" field with your npm user info.</p>
-
<h2 id="files">files</h2>
-
<p>The "files" field is an array of files to include in your project. If
you name a folder in the array, then it will also include the files
inside that folder. (Unless they would be ignored by another rule.)</p>
-
<p>You can also provide a ".npmignore" file in the root of your package,
which will keep files from being included, even if they would be picked
up by the files array. The ".npmignore" file works just like a
".gitignore".</p>
-
<h2 id="main">main</h2>
-
<p>The main field is a module ID that is the primary entry point to your program.
That is, if your package is named <code>foo</code>, and a user installs it, and then does
<code>require("foo")</code>, then your main module's exports object will be returned.</p>
-
<p>This should be a module ID relative to the root of your package folder.</p>
-
<p>For most modules, it makes the most sense to have a main script and often not
much else.</p>
-
<h2 id="bin">bin</h2>
-
<p>A lot of packages have one or more executable files that they'd like to
install into the PATH. npm makes this pretty easy (in fact, it uses this
feature to install the "npm" executable.)</p>
-
<p>To use this, supply a <code>bin</code> field in your package.json which is a map of
command name to local file name. On install, npm will symlink that file into
<code>prefix/bin</code> for global installs, or <code>./node_modules/.bin/</code> for local
installs.</p>
-
<p>For example, npm has this:</p>
-
-<pre><code>{ "bin" : { "npm" : "./cli.js" } }</code></pre>
-
-<p>So, when you install npm, it'll create a symlink from the <code>cli.js</code> script to
+<pre><code>{ "bin" : { "npm" : "./cli.js" } }
+</code></pre><p>So, when you install npm, it'll create a symlink from the <code>cli.js</code> script to
<code>/usr/local/bin/npm</code>.</p>
-
<p>If you have a single executable, and its name should be the name
of the package, then you can just supply it as a string. For example:</p>
-
<pre><code>{ "name": "my-program"
, "version": "1.2.5"
-, "bin": "./path/to/program" }</code></pre>
-
-<p>would be the same as this:</p>
-
+, "bin": "./path/to/program" }
+</code></pre><p>would be the same as this:</p>
<pre><code>{ "name": "my-program"
, "version": "1.2.5"
-, "bin" : { "my-program" : "./path/to/program" } }</code></pre>
-
-<h2 id="man">man</h2>
-
+, "bin" : { "my-program" : "./path/to/program" } }
+</code></pre><h2 id="man">man</h2>
<p>Specify either a single file or an array of filenames to put in place for the
<code>man</code> program to find.</p>
-
<p>If only a single file is provided, then it's installed such that it is the
result from <code>man <pkgname></code>, regardless of its actual filename. For example:</p>
-
<pre><code>{ "name" : "foo"
, "version" : "1.2.3"
, "description" : "A packaged foo fooer for fooing foos"
, "main" : "foo.js"
, "man" : "./man/doc.1"
-}</code></pre>
-
-<p>would link the <code>./man/doc.1</code> file in such that it is the target for <code>man foo</code></p>
-
+}
+</code></pre><p>would link the <code>./man/doc.1</code> file in such that it is the target for <code>man foo</code></p>
<p>If the filename doesn't start with the package name, then it's prefixed.
So, this:</p>
-
<pre><code>{ "name" : "foo"
, "version" : "1.2.3"
, "description" : "A packaged foo fooer for fooing foos"
, "main" : "foo.js"
, "man" : [ "./man/foo.1", "./man/bar.1" ]
-}</code></pre>
-
-<p>will create files to do <code>man foo</code> and <code>man foo-bar</code>.</p>
-
+}
+</code></pre><p>will create files to do <code>man foo</code> and <code>man foo-bar</code>.</p>
<p>Man files must end with a number, and optionally a <code>.gz</code> suffix if they are
compressed. The number dictates which man section the file is installed into.</p>
-
<pre><code>{ "name" : "foo"
, "version" : "1.2.3"
, "description" : "A packaged foo fooer for fooing foos"
, "main" : "foo.js"
, "man" : [ "./man/foo.1", "./man/foo.2" ]
-}</code></pre>
-
-<p>will create entries for <code>man foo</code> and <code>man 2 foo</code></p>
-
+}
+</code></pre><p>will create entries for <code>man foo</code> and <code>man 2 foo</code></p>
<h2 id="directories">directories</h2>
-
<p>The CommonJS <a href="http://wiki.commonjs.org/wiki/Packages/1.0">Packages</a> spec details a
few ways that you can indicate the structure of your package using a <code>directories</code>
hash. If you look at <a href="http://registry.npmjs.org/npm/latest">npm's package.json</a>,
you'll see that it has directories for doc, lib, and man.</p>
-
<p>In the future, this information may be used in other creative ways.</p>
-
<h3 id="directories-lib">directories.lib</h3>
-
<p>Tell people where the bulk of your library is. Nothing special is done
with the lib folder in any way, but it's useful meta info.</p>
-
<h3 id="directories-bin">directories.bin</h3>
-
<p>If you specify a "bin" directory, then all the files in that folder will
be used as the "bin" hash.</p>
-
<p>If you have a "bin" hash already, then this has no effect.</p>
-
<h3 id="directories-man">directories.man</h3>
-
<p>A folder that is full of man pages. Sugar to generate a "man" array by
walking the folder.</p>
-
<h3 id="directories-doc">directories.doc</h3>
-
<p>Put markdown files in here. Eventually, these will be displayed nicely,
maybe, someday.</p>
-
<h3 id="directories-example">directories.example</h3>
-
<p>Put example scripts in here. Someday, it might be exposed in some clever way.</p>
-
<h2 id="repository">repository</h2>
-
<p>Specify the place where your code lives. This is helpful for people who
want to contribute. If the git repo is on github, then the <code>npm docs</code>
command will be able to find you.</p>
-
<p>Do it like this:</p>
-
<pre><code>"repository" :
{ "type" : "git"
, "url" : "http://github.com/npm/npm.git"
"repository" :
{ "type" : "svn"
, "url" : "http://v8.googlecode.com/svn/trunk/"
- }</code></pre>
-
-<p>The URL should be a publicly available (perhaps read-only) url that can be handed
+ }
+</code></pre><p>The URL should be a publicly available (perhaps read-only) url that can be handed
directly to a VCS program without any modification. It should not be a url to an
html project page that you put in your browser. It's for computers.</p>
-
<h2 id="scripts">scripts</h2>
-
<p>The "scripts" member is an object hash of script commands that are run
at various times in the lifecycle of your package. The key is the lifecycle
event, and the value is the command to run at that point.</p>
-
<p>See <code><a href="../misc/npm-scripts.html">npm-scripts(7)</a></code> to find out more about writing package scripts.</p>
-
<h2 id="config">config</h2>
-
<p>A "config" hash can be used to set configuration
parameters used in package scripts that persist across upgrades. For
instance, if a package had the following:</p>
-
<pre><code>{ "name" : "foo"
-, "config" : { "port" : "8080" } }</code></pre>
-
-<p>and then had a "start" command that then referenced the
+, "config" : { "port" : "8080" } }
+</code></pre><p>and then had a "start" command that then referenced the
<code>npm_package_config_port</code> environment variable, then the user could
override that by doing <code>npm config set foo:port 8001</code>.</p>
-
<p>See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> and <code><a href="../misc/npm-scripts.html">npm-scripts(7)</a></code> for more on package
configs.</p>
-
<h2 id="dependencies">dependencies</h2>
-
<p>Dependencies are specified with a simple hash of package name to
version range. The version range is a string which has one or more
space-separated descriptors. Dependencies can also be identified with
a tarball or git URL.</p>
-
<p><strong>Please do not put test harnesses or transpilers in your
<code>dependencies</code> hash.</strong> See <code>devDependencies</code>, below.</p>
-
<p>See <a href="../misc/semver.html">semver(7)</a> for more details about specifying version ranges.</p>
-
-<ul><li><code>version</code> Must match <code>version</code> exactly</li><li><code>>version</code> Must be greater than <code>version</code></li><li><code>>=version</code> etc</li><li><code><version</code></li><li><code><=version</code></li><li><code>~version</code> "Approximately equivalent to version" See <a href="../misc/semver.html">semver(7)</a></li><li><code>^version</code> "Compatible with version" See <a href="../misc/semver.html">semver(7)</a></li><li><code>1.2.x</code> 1.2.0, 1.2.1, etc., but not 1.3.0</li><li><code>http://...</code> See 'URLs as Dependencies' below</li><li><code>*</code> Matches any version</li><li><code>""</code> (just an empty string) Same as <code>*</code></li><li><code>version1 - version2</code> Same as <code>>=version1 <=version2</code>.</li><li><code>range1 || range2</code> Passes if either range1 or range2 are satisfied.</li><li><code>git...</code> See 'Git URLs as Dependencies' below</li><li><code>user/repo</code> See 'GitHub URLs' below</li></ul>
-
+<ul>
+<li><code>version</code> Must match <code>version</code> exactly</li>
+<li><code>>version</code> Must be greater than <code>version</code></li>
+<li><code>>=version</code> etc</li>
+<li><code><version</code></li>
+<li><code><=version</code></li>
+<li><code>~version</code> "Approximately equivalent to version" See <a href="../misc/semver.html">semver(7)</a></li>
+<li><code>^version</code> "Compatible with version" See <a href="../misc/semver.html">semver(7)</a></li>
+<li><code>1.2.x</code> 1.2.0, 1.2.1, etc., but not 1.3.0</li>
+<li><code>http://...</code> See 'URLs as Dependencies' below</li>
+<li><code>*</code> Matches any version</li>
+<li><code>""</code> (just an empty string) Same as <code>*</code></li>
+<li><code>version1 - version2</code> Same as <code>>=version1 <=version2</code>.</li>
+<li><code>range1 || range2</code> Passes if either range1 or range2 are satisfied.</li>
+<li><code>git...</code> See 'Git URLs as Dependencies' below</li>
+<li><code>user/repo</code> See 'GitHub URLs' below</li>
+</ul>
<p>For example, these are all valid:</p>
-
<pre><code>{ "dependencies" :
{ "foo" : "1.0.0 - 2.9999.9999"
, "bar" : ">=1.0.2 <2.1.2"
, "two" : "2.x"
, "thr" : "3.3.x"
}
-}</code></pre>
-
-<h3 id="URLs-as-Dependencies">URLs as Dependencies</h3>
-
+}
+</code></pre><h3 id="urls-as-dependencies">URLs as Dependencies</h3>
<p>You may specify a tarball URL in place of a version range.</p>
-
<p>This tarball will be downloaded and installed locally to your package at
install time.</p>
-
-<h3 id="Git-URLs-as-Dependencies">Git URLs as Dependencies</h3>
-
+<h3 id="git-urls-as-dependencies">Git URLs as Dependencies</h3>
<p>Git urls can be of the form:</p>
-
<pre><code>git://github.com/user/project.git#commit-ish
git+ssh://user@hostname:project.git#commit-ish
git+ssh://user@hostname/project.git#commit-ish
git+http://user@hostname/project/blah.git#commit-ish
-git+https://user@hostname/project/blah.git#commit-ish</code></pre>
-
-<p>The <code>commit-ish</code> can be any tag, sha, or branch which can be supplied as
+git+https://user@hostname/project/blah.git#commit-ish
+</code></pre><p>The <code>commit-ish</code> can be any tag, sha, or branch which can be supplied as
an argument to <code>git checkout</code>. The default is <code>master</code>.</p>
-
-<h2 id="GitHub-URLs">GitHub URLs</h2>
-
+<h2 id="github-urls">GitHub URLs</h2>
<p>As of version 1.1.65, you can refer to GitHub urls as just "foo": "user/foo-project". For example:</p>
-
<pre><code>{
"name": "foo",
"version": "0.0.0",
"dependencies": {
"express": "visionmedia/express"
}
-}</code></pre>
-
-<h2 id="devDependencies">devDependencies</h2>
-
+}
+</code></pre><h2 id="devdependencies">devDependencies</h2>
<p>If someone is planning on downloading and using your module in their
program, then they probably don't want or need to download and build
the external test or documentation framework that you use.</p>
-
<p>In this case, it's best to list these additional items in a
<code>devDependencies</code> hash.</p>
-
<p>These things will be installed when doing <code>npm link</code> or <code>npm install</code>
from the root of a package, and can be managed like any other npm
configuration param. See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> for more on the topic.</p>
-
<p>For build steps that are not platform-specific, such as compiling
CoffeeScript or other languages to JavaScript, use the <code>prepublish</code>
script to do this, and make the required package a devDependency.</p>
-
<p>For example:</p>
-
<pre><code>{ "name": "ethopia-waza",
"description": "a delightfully fruity coffee varietal",
"version": "1.2.3",
"prepublish": "coffee -o lib/ -c src/waza.coffee"
},
"main": "lib/waza.js"
-}</code></pre>
-
-<p>The <code>prepublish</code> script will be run before publishing, so that users
+}
+</code></pre><p>The <code>prepublish</code> script will be run before publishing, so that users
can consume the functionality without requiring them to compile it
themselves. In dev mode (ie, locally running <code>npm install</code>), it'll
run this script as well, so that you can test it easily.</p>
-
-<h2 id="peerDependencies">peerDependencies</h2>
-
+<h2 id="peerdependencies">peerDependencies</h2>
<p>In some cases, you want to express the compatibility of your package with an
host tool or library, while not necessarily doing a <code>require</code> of this host.
This is usually refered to as a <em>plugin</em>. Notably, your module may be exposing
a specific interface, expected and specified by the host documentation.</p>
-
<p>For example:</p>
-
<pre><code>{
"name": "tea-latte",
"version": "1.3.5"
"peerDependencies": {
"tea": "2.x"
}
-}</code></pre>
-
-<p>This ensures your package <code>tea-latte</code> can be installed <em>along</em> with the second
+}
+</code></pre><p>This ensures your package <code>tea-latte</code> can be installed <em>along</em> with the second
major version of the host package <code>tea</code> only. The host package is automatically
installed if needed. <code>npm install tea-latte</code> could possibly yield the following
dependency graph:</p>
-
<pre><code>├── tea-latte@1.3.5
-└── tea@2.2.0</code></pre>
-
-<p>Trying to install another plugin with a conflicting requirement will cause an
+└── tea@2.2.0
+</code></pre><p>Trying to install another plugin with a conflicting requirement will cause an
error. For this reason, make sure your plugin requirement is as broad as
possible, and not to lock it down to specific patch versions.</p>
-
<p>Assuming the host complies with <a href="http://semver.org/">semver</a>, only changes in
the host package's major version will break your plugin. Thus, if you've worked
with every 1.x version of the host package, use <code>"^1.0"</code> or <code>"1.x"</code> to express
this. If you depend on features introduced in 1.5.2, use <code>">= 1.5.2 < 2"</code>.</p>
-
-<h2 id="bundledDependencies">bundledDependencies</h2>
-
+<h2 id="bundleddependencies">bundledDependencies</h2>
<p>Array of package names that will be bundled when publishing the package.</p>
-
<p>If this is spelled <code>"bundleDependencies"</code>, then that is also honorable.</p>
-
-<h2 id="optionalDependencies">optionalDependencies</h2>
-
+<h2 id="optionaldependencies">optionalDependencies</h2>
<p>If a dependency can be used, but you would like npm to proceed if it
cannot be found or fails to install, then you may put it in the
<code>optionalDependencies</code> hash. This is a map of package name to version
or url, just like the <code>dependencies</code> hash. The difference is that
failure is tolerated.</p>
-
<p>It is still your program's responsibility to handle the lack of the
dependency. For example, something like this:</p>
-
<pre><code>try {
var foo = require('foo')
var fooVersion = require('foo/package.json').version
if (foo) {
foo.doFooThings()
-}</code></pre>
-
-<p>Entries in <code>optionalDependencies</code> will override entries of the same name in
+}
+</code></pre><p>Entries in <code>optionalDependencies</code> will override entries of the same name in
<code>dependencies</code>, so it's usually best to only put in one place.</p>
-
<h2 id="engines">engines</h2>
-
<p>You can specify the version of node that your stuff works on:</p>
-
-<pre><code>{ "engines" : { "node" : ">=0.10.3 <0.12" } }</code></pre>
-
-<p>And, like with dependencies, if you don't specify the version (or if you
+<pre><code>{ "engines" : { "node" : ">=0.10.3 <0.12" } }
+</code></pre><p>And, like with dependencies, if you don't specify the version (or if you
specify "*" as the version), then any version of node will do.</p>
-
<p>If you specify an "engines" field, then npm will require that "node" be
somewhere on that list. If "engines" is omitted, then npm will just assume
that it works on node.</p>
-
<p>You can also use the "engines" field to specify which versions of npm
are capable of properly installing your program. For example:</p>
-
-<pre><code>{ "engines" : { "npm" : "~1.0.20" } }</code></pre>
-
-<p>Note that, unless the user has set the <code>engine-strict</code> config flag, this
+<pre><code>{ "engines" : { "npm" : "~1.0.20" } }
+</code></pre><p>Note that, unless the user has set the <code>engine-strict</code> config flag, this
field is advisory only.</p>
-
-<h2 id="engineStrict">engineStrict</h2>
-
+<h2 id="enginestrict">engineStrict</h2>
<p>If you are sure that your module will <em>definitely not</em> run properly on
versions of Node/npm other than those specified in the <code>engines</code> hash,
then you can set <code>"engineStrict": true</code> in your package.json file.
This will override the user's <code>engine-strict</code> config setting.</p>
-
<p>Please do not do this unless you are really very very sure. If your
engines hash is something overly restrictive, you can quite easily and
inadvertently lock yourself into obscurity and prevent your users from
updating to new versions of Node. Consider this choice carefully. If
people abuse it, it will be removed in a future version of npm.</p>
-
<h2 id="os">os</h2>
-
<p>You can specify which operating systems your
module will run on:</p>
-
-<pre><code>"os" : [ "darwin", "linux" ]</code></pre>
-
-<p>You can also blacklist instead of whitelist operating systems,
+<pre><code>"os" : [ "darwin", "linux" ]
+</code></pre><p>You can also blacklist instead of whitelist operating systems,
just prepend the blacklisted os with a '!':</p>
-
-<pre><code>"os" : [ "!win32" ]</code></pre>
-
-<p>The host operating system is determined by <code>process.platform</code></p>
-
+<pre><code>"os" : [ "!win32" ]
+</code></pre><p>The host operating system is determined by <code>process.platform</code></p>
<p>It is allowed to both blacklist, and whitelist, although there isn't any
good reason to do this.</p>
-
<h2 id="cpu">cpu</h2>
-
<p>If your code only runs on certain cpu architectures,
you can specify which ones.</p>
-
-<pre><code>"cpu" : [ "x64", "ia32" ]</code></pre>
-
-<p>Like the <code>os</code> option, you can also blacklist architectures:</p>
-
-<pre><code>"cpu" : [ "!arm", "!mips" ]</code></pre>
-
-<p>The host architecture is determined by <code>process.arch</code></p>
-
-<h2 id="preferGlobal">preferGlobal</h2>
-
+<pre><code>"cpu" : [ "x64", "ia32" ]
+</code></pre><p>Like the <code>os</code> option, you can also blacklist architectures:</p>
+<pre><code>"cpu" : [ "!arm", "!mips" ]
+</code></pre><p>The host architecture is determined by <code>process.arch</code></p>
+<h2 id="preferglobal">preferGlobal</h2>
<p>If your package is primarily a command-line application that should be
installed globally, then set this value to <code>true</code> to provide a warning
if it is installed locally.</p>
-
<p>It doesn't actually prevent users from installing it locally, but it
does help prevent some confusion if it doesn't work as expected.</p>
-
<h2 id="private">private</h2>
-
<p>If you set <code>"private": true</code> in your package.json, then npm will refuse
to publish it.</p>
-
<p>This is a way to prevent accidental publication of private repositories.
If you would like to ensure that a given package is only ever published
to a specific registry (for example, an internal registry),
then use the <code>publishConfig</code> hash described below
to override the <code>registry</code> config param at publish-time.</p>
-
-<h2 id="publishConfig">publishConfig</h2>
-
+<h2 id="publishconfig">publishConfig</h2>
<p>This is a set of config values that will be used at publish-time. It's
especially handy if you want to set the tag or registry, so that you can
ensure that a given package is not tagged with "latest" or published to
the global public registry by default.</p>
-
<p>Any config values can be overridden, but of course only "tag" and
"registry" probably matter for the purposes of publishing.</p>
-
<p>See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> to see the list of config options that can be
overridden.</p>
-
-<h2 id="DEFAULT-VALUES">DEFAULT VALUES</h2>
-
+<h2 id="default-values">DEFAULT VALUES</h2>
<p>npm will default some values based on package contents.</p>
-
-<ul><li><p><code>"scripts": {"start": "node server.js"}</code></p><p>If there is a <code>server.js</code> file in the root of your package, then npm
-will default the <code>start</code> command to <code>node server.js</code>.</p></li><li><p><code>"scripts":{"preinstall": "node-gyp rebuild"}</code></p><p>If there is a <code>binding.gyp</code> file in the root of your package, npm will
-default the <code>preinstall</code> command to compile using node-gyp.</p></li><li><p><code>"contributors": [...]</code></p><p>If there is an <code>AUTHORS</code> file in the root of your package, npm will
+<ul>
+<li><p><code>"scripts": {"start": "node server.js"}</code></p>
+<p>If there is a <code>server.js</code> file in the root of your package, then npm
+will default the <code>start</code> command to <code>node server.js</code>.</p>
+</li>
+<li><p><code>"scripts":{"preinstall": "node-gyp rebuild"}</code></p>
+<p>If there is a <code>binding.gyp</code> file in the root of your package, npm will
+default the <code>preinstall</code> command to compile using node-gyp.</p>
+</li>
+<li><p><code>"contributors": [...]</code></p>
+<p>If there is an <code>AUTHORS</code> file in the root of your package, npm will
treat each line as a <code>Name <email> (url)</code> format, where email and url
are optional. Lines which start with a <code>#</code> or are blank, will be
-ignored.</p></li></ul>
-
-<h2 id="SEE-ALSO">SEE ALSO</h2>
+ignored.</p>
+</li>
+</ul>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../misc/semver.html">semver(7)</a></li>
+<li><a href="../cli/npm-init.html">npm-init(1)</a></li>
+<li><a href="../cli/npm-version.html">npm-version(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="../cli/npm-help.html">npm-help(1)</a></li>
+<li><a href="../misc/npm-faq.html">npm-faq(7)</a></li>
+<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
+<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
+<li><a href="../cli/npm-rm.html">npm-rm(1)</a></li>
+</ul>
-<ul><li><a href="../misc/semver.html">semver(7)</a></li><li><a href="../cli/npm-init.html">npm-init(1)</a></li><li><a href="../cli/npm-version.html">npm-version(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="../cli/npm-help.html">npm-help(1)</a></li><li><a href="../misc/npm-faq.html">npm-faq(7)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../cli/npm-rm.html">npm-rm(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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">package.json — npm@1.4.9</p>
+<p id="footer">package.json — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="misc/npm-index.html">npm-index</a></h1> <p>Index of all npm documentation</p>
-
-<h2 id="README-1"><a href="../doc/README.html">README</a></h2>
-
+<h2 id="readme-1-"><a href="../doc/README.html">README</a></h2>
<p>node package manager</p>
-
-<h1>Command Line Documentation</h1>
-
-<h2 id="npm-1"><a href="cli/npm.html">npm(1)</a></h2>
-
+<h1 id="command-line-documentation">Command Line Documentation</h1>
+<h2 id="npm-1-"><a href="cli/npm.html">npm(1)</a></h2>
<p>node package manager</p>
-
-<h2 id="npm-adduser-1"><a href="cli/npm-adduser.html">npm-adduser(1)</a></h2>
-
+<h2 id="npm-adduser-1-"><a href="cli/npm-adduser.html">npm-adduser(1)</a></h2>
<p>Add a registry user account</p>
-
-<h2 id="npm-bin-1"><a href="cli/npm-bin.html">npm-bin(1)</a></h2>
-
+<h2 id="npm-bin-1-"><a href="cli/npm-bin.html">npm-bin(1)</a></h2>
<p>Display npm bin folder</p>
-
-<h2 id="npm-bugs-1"><a href="cli/npm-bugs.html">npm-bugs(1)</a></h2>
-
+<h2 id="npm-bugs-1-"><a href="cli/npm-bugs.html">npm-bugs(1)</a></h2>
<p>Bugs for a package in a web browser maybe</p>
-
-<h2 id="npm-build-1"><a href="cli/npm-build.html">npm-build(1)</a></h2>
-
+<h2 id="npm-build-1-"><a href="cli/npm-build.html">npm-build(1)</a></h2>
<p>Build a package</p>
-
-<h2 id="npm-bundle-1"><a href="cli/npm-bundle.html">npm-bundle(1)</a></h2>
-
+<h2 id="npm-bundle-1-"><a href="cli/npm-bundle.html">npm-bundle(1)</a></h2>
<p>REMOVED</p>
-
-<h2 id="npm-cache-1"><a href="cli/npm-cache.html">npm-cache(1)</a></h2>
-
+<h2 id="npm-cache-1-"><a href="cli/npm-cache.html">npm-cache(1)</a></h2>
<p>Manipulates packages cache</p>
-
-<h2 id="npm-completion-1"><a href="cli/npm-completion.html">npm-completion(1)</a></h2>
-
+<h2 id="npm-completion-1-"><a href="cli/npm-completion.html">npm-completion(1)</a></h2>
<p>Tab Completion for npm</p>
-
-<h2 id="npm-config-1"><a href="cli/npm-config.html">npm-config(1)</a></h2>
-
+<h2 id="npm-config-1-"><a href="cli/npm-config.html">npm-config(1)</a></h2>
<p>Manage the npm configuration files</p>
-
-<h2 id="npm-dedupe-1"><a href="cli/npm-dedupe.html">npm-dedupe(1)</a></h2>
-
+<h2 id="npm-dedupe-1-"><a href="cli/npm-dedupe.html">npm-dedupe(1)</a></h2>
<p>Reduce duplication</p>
-
-<h2 id="npm-deprecate-1"><a href="cli/npm-deprecate.html">npm-deprecate(1)</a></h2>
-
+<h2 id="npm-deprecate-1-"><a href="cli/npm-deprecate.html">npm-deprecate(1)</a></h2>
<p>Deprecate a version of a package</p>
-
-<h2 id="npm-docs-1"><a href="cli/npm-docs.html">npm-docs(1)</a></h2>
-
+<h2 id="npm-docs-1-"><a href="cli/npm-docs.html">npm-docs(1)</a></h2>
<p>Docs for a package in a web browser maybe</p>
-
-<h2 id="npm-edit-1"><a href="cli/npm-edit.html">npm-edit(1)</a></h2>
-
+<h2 id="npm-edit-1-"><a href="cli/npm-edit.html">npm-edit(1)</a></h2>
<p>Edit an installed package</p>
-
-<h2 id="npm-explore-1"><a href="cli/npm-explore.html">npm-explore(1)</a></h2>
-
+<h2 id="npm-explore-1-"><a href="cli/npm-explore.html">npm-explore(1)</a></h2>
<p>Browse an installed package</p>
-
-<h2 id="npm-help-search-1"><a href="cli/npm-help-search.html">npm-help-search(1)</a></h2>
-
+<h2 id="npm-help-search-1-"><a href="cli/npm-help-search.html">npm-help-search(1)</a></h2>
<p>Search npm help documentation</p>
-
-<h2 id="npm-help-1"><a href="cli/npm-help.html">npm-help(1)</a></h2>
-
+<h2 id="npm-help-1-"><a href="cli/npm-help.html">npm-help(1)</a></h2>
<p>Get help on npm</p>
-
-<h2 id="npm-init-1"><a href="cli/npm-init.html">npm-init(1)</a></h2>
-
+<h2 id="npm-init-1-"><a href="cli/npm-init.html">npm-init(1)</a></h2>
<p>Interactively create a package.json file</p>
-
-<h2 id="npm-install-1"><a href="cli/npm-install.html">npm-install(1)</a></h2>
-
+<h2 id="npm-install-1-"><a href="cli/npm-install.html">npm-install(1)</a></h2>
<p>Install a package</p>
-
-<h2 id="npm-link-1"><a href="cli/npm-link.html">npm-link(1)</a></h2>
-
+<h2 id="npm-link-1-"><a href="cli/npm-link.html">npm-link(1)</a></h2>
<p>Symlink a package folder</p>
-
-<h2 id="npm-ls-1"><a href="cli/npm-ls.html">npm-ls(1)</a></h2>
-
+<h2 id="npm-ls-1-"><a href="cli/npm-ls.html">npm-ls(1)</a></h2>
<p>List installed packages</p>
-
-<h2 id="npm-outdated-1"><a href="cli/npm-outdated.html">npm-outdated(1)</a></h2>
-
+<h2 id="npm-outdated-1-"><a href="cli/npm-outdated.html">npm-outdated(1)</a></h2>
<p>Check for outdated packages</p>
-
-<h2 id="npm-owner-1"><a href="cli/npm-owner.html">npm-owner(1)</a></h2>
-
+<h2 id="npm-owner-1-"><a href="cli/npm-owner.html">npm-owner(1)</a></h2>
<p>Manage package owners</p>
-
-<h2 id="npm-pack-1"><a href="cli/npm-pack.html">npm-pack(1)</a></h2>
-
+<h2 id="npm-pack-1-"><a href="cli/npm-pack.html">npm-pack(1)</a></h2>
<p>Create a tarball from a package</p>
-
-<h2 id="npm-prefix-1"><a href="cli/npm-prefix.html">npm-prefix(1)</a></h2>
-
+<h2 id="npm-prefix-1-"><a href="cli/npm-prefix.html">npm-prefix(1)</a></h2>
<p>Display prefix</p>
-
-<h2 id="npm-prune-1"><a href="cli/npm-prune.html">npm-prune(1)</a></h2>
-
+<h2 id="npm-prune-1-"><a href="cli/npm-prune.html">npm-prune(1)</a></h2>
<p>Remove extraneous packages</p>
-
-<h2 id="npm-publish-1"><a href="cli/npm-publish.html">npm-publish(1)</a></h2>
-
+<h2 id="npm-publish-1-"><a href="cli/npm-publish.html">npm-publish(1)</a></h2>
<p>Publish a package</p>
-
-<h2 id="npm-rebuild-1"><a href="cli/npm-rebuild.html">npm-rebuild(1)</a></h2>
-
+<h2 id="npm-rebuild-1-"><a href="cli/npm-rebuild.html">npm-rebuild(1)</a></h2>
<p>Rebuild a package</p>
-
-<h2 id="npm-repo-1"><a href="cli/npm-repo.html">npm-repo(1)</a></h2>
-
+<h2 id="npm-repo-1-"><a href="cli/npm-repo.html">npm-repo(1)</a></h2>
<p>Open package repository page in the browser</p>
-
-<h2 id="npm-restart-1"><a href="cli/npm-restart.html">npm-restart(1)</a></h2>
-
+<h2 id="npm-restart-1-"><a href="cli/npm-restart.html">npm-restart(1)</a></h2>
<p>Start a package</p>
-
-<h2 id="npm-rm-1"><a href="cli/npm-rm.html">npm-rm(1)</a></h2>
-
+<h2 id="npm-rm-1-"><a href="cli/npm-rm.html">npm-rm(1)</a></h2>
<p>Remove a package</p>
-
-<h2 id="npm-root-1"><a href="cli/npm-root.html">npm-root(1)</a></h2>
-
+<h2 id="npm-root-1-"><a href="cli/npm-root.html">npm-root(1)</a></h2>
<p>Display npm root</p>
-
-<h2 id="npm-run-script-1"><a href="cli/npm-run-script.html">npm-run-script(1)</a></h2>
-
+<h2 id="npm-run-script-1-"><a href="cli/npm-run-script.html">npm-run-script(1)</a></h2>
<p>Run arbitrary package scripts</p>
-
-<h2 id="npm-search-1"><a href="cli/npm-search.html">npm-search(1)</a></h2>
-
+<h2 id="npm-search-1-"><a href="cli/npm-search.html">npm-search(1)</a></h2>
<p>Search for packages</p>
-
-<h2 id="npm-shrinkwrap-1"><a href="cli/npm-shrinkwrap.html">npm-shrinkwrap(1)</a></h2>
-
+<h2 id="npm-shrinkwrap-1-"><a href="cli/npm-shrinkwrap.html">npm-shrinkwrap(1)</a></h2>
<p>Lock down dependency versions</p>
-
-<h2 id="npm-star-1"><a href="cli/npm-star.html">npm-star(1)</a></h2>
-
+<h2 id="npm-star-1-"><a href="cli/npm-star.html">npm-star(1)</a></h2>
<p>Mark your favorite packages</p>
-
-<h2 id="npm-stars-1"><a href="cli/npm-stars.html">npm-stars(1)</a></h2>
-
+<h2 id="npm-stars-1-"><a href="cli/npm-stars.html">npm-stars(1)</a></h2>
<p>View packages marked as favorites</p>
-
-<h2 id="npm-start-1"><a href="cli/npm-start.html">npm-start(1)</a></h2>
-
+<h2 id="npm-start-1-"><a href="cli/npm-start.html">npm-start(1)</a></h2>
<p>Start a package</p>
-
-<h2 id="npm-stop-1"><a href="cli/npm-stop.html">npm-stop(1)</a></h2>
-
+<h2 id="npm-stop-1-"><a href="cli/npm-stop.html">npm-stop(1)</a></h2>
<p>Stop a package</p>
-
-<h2 id="npm-submodule-1"><a href="cli/npm-submodule.html">npm-submodule(1)</a></h2>
-
+<h2 id="npm-submodule-1-"><a href="cli/npm-submodule.html">npm-submodule(1)</a></h2>
<p>Add a package as a git submodule</p>
-
-<h2 id="npm-tag-1"><a href="cli/npm-tag.html">npm-tag(1)</a></h2>
-
+<h2 id="npm-tag-1-"><a href="cli/npm-tag.html">npm-tag(1)</a></h2>
<p>Tag a published version</p>
-
-<h2 id="npm-test-1"><a href="cli/npm-test.html">npm-test(1)</a></h2>
-
+<h2 id="npm-test-1-"><a href="cli/npm-test.html">npm-test(1)</a></h2>
<p>Test a package</p>
-
-<h2 id="npm-uninstall-1"><a href="cli/npm-uninstall.html">npm-uninstall(1)</a></h2>
-
+<h2 id="npm-uninstall-1-"><a href="cli/npm-uninstall.html">npm-uninstall(1)</a></h2>
<p>Remove a package</p>
-
-<h2 id="npm-unpublish-1"><a href="cli/npm-unpublish.html">npm-unpublish(1)</a></h2>
-
+<h2 id="npm-unpublish-1-"><a href="cli/npm-unpublish.html">npm-unpublish(1)</a></h2>
<p>Remove a package from the registry</p>
-
-<h2 id="npm-update-1"><a href="cli/npm-update.html">npm-update(1)</a></h2>
-
+<h2 id="npm-update-1-"><a href="cli/npm-update.html">npm-update(1)</a></h2>
<p>Update a package</p>
-
-<h2 id="npm-version-1"><a href="cli/npm-version.html">npm-version(1)</a></h2>
-
+<h2 id="npm-version-1-"><a href="cli/npm-version.html">npm-version(1)</a></h2>
<p>Bump a package version</p>
-
-<h2 id="npm-view-1"><a href="cli/npm-view.html">npm-view(1)</a></h2>
-
+<h2 id="npm-view-1-"><a href="cli/npm-view.html">npm-view(1)</a></h2>
<p>View registry info</p>
-
-<h2 id="npm-whoami-1"><a href="cli/npm-whoami.html">npm-whoami(1)</a></h2>
-
+<h2 id="npm-whoami-1-"><a href="cli/npm-whoami.html">npm-whoami(1)</a></h2>
<p>Display npm username</p>
-
-<h1>API Documentation</h1>
-
-<h2 id="npm-3"><a href="api/npm.html">npm(3)</a></h2>
-
+<h1 id="api-documentation">API Documentation</h1>
+<h2 id="npm-3-"><a href="api/npm.html">npm(3)</a></h2>
<p>node package manager</p>
-
-<h2 id="npm-bin-3"><a href="api/npm-bin.html">npm-bin(3)</a></h2>
-
+<h2 id="npm-bin-3-"><a href="api/npm-bin.html">npm-bin(3)</a></h2>
<p>Display npm bin folder</p>
-
-<h2 id="npm-bugs-3"><a href="api/npm-bugs.html">npm-bugs(3)</a></h2>
-
+<h2 id="npm-bugs-3-"><a href="api/npm-bugs.html">npm-bugs(3)</a></h2>
<p>Bugs for a package in a web browser maybe</p>
-
-<h2 id="npm-commands-3"><a href="api/npm-commands.html">npm-commands(3)</a></h2>
-
+<h2 id="npm-commands-3-"><a href="api/npm-commands.html">npm-commands(3)</a></h2>
<p>npm commands</p>
-
-<h2 id="npm-config-3"><a href="api/npm-config.html">npm-config(3)</a></h2>
-
+<h2 id="npm-config-3-"><a href="api/npm-config.html">npm-config(3)</a></h2>
<p>Manage the npm configuration files</p>
-
-<h2 id="npm-deprecate-3"><a href="api/npm-deprecate.html">npm-deprecate(3)</a></h2>
-
+<h2 id="npm-deprecate-3-"><a href="api/npm-deprecate.html">npm-deprecate(3)</a></h2>
<p>Deprecate a version of a package</p>
-
-<h2 id="npm-docs-3"><a href="api/npm-docs.html">npm-docs(3)</a></h2>
-
+<h2 id="npm-docs-3-"><a href="api/npm-docs.html">npm-docs(3)</a></h2>
<p>Docs for a package in a web browser maybe</p>
-
-<h2 id="npm-edit-3"><a href="api/npm-edit.html">npm-edit(3)</a></h2>
-
+<h2 id="npm-edit-3-"><a href="api/npm-edit.html">npm-edit(3)</a></h2>
<p>Edit an installed package</p>
-
-<h2 id="npm-explore-3"><a href="api/npm-explore.html">npm-explore(3)</a></h2>
-
+<h2 id="npm-explore-3-"><a href="api/npm-explore.html">npm-explore(3)</a></h2>
<p>Browse an installed package</p>
-
-<h2 id="npm-help-search-3"><a href="api/npm-help-search.html">npm-help-search(3)</a></h2>
-
+<h2 id="npm-help-search-3-"><a href="api/npm-help-search.html">npm-help-search(3)</a></h2>
<p>Search the help pages</p>
-
-<h2 id="npm-init-3"><a href="api/npm-init.html">npm-init(3)</a></h2>
-
+<h2 id="npm-init-3-"><a href="api/npm-init.html">npm-init(3)</a></h2>
<p>Interactively create a package.json file</p>
-
-<h2 id="npm-install-3"><a href="api/npm-install.html">npm-install(3)</a></h2>
-
+<h2 id="npm-install-3-"><a href="api/npm-install.html">npm-install(3)</a></h2>
<p>install a package programmatically</p>
-
-<h2 id="npm-link-3"><a href="api/npm-link.html">npm-link(3)</a></h2>
-
+<h2 id="npm-link-3-"><a href="api/npm-link.html">npm-link(3)</a></h2>
<p>Symlink a package folder</p>
-
-<h2 id="npm-load-3"><a href="api/npm-load.html">npm-load(3)</a></h2>
-
+<h2 id="npm-load-3-"><a href="api/npm-load.html">npm-load(3)</a></h2>
<p>Load config settings</p>
-
-<h2 id="npm-ls-3"><a href="api/npm-ls.html">npm-ls(3)</a></h2>
-
+<h2 id="npm-ls-3-"><a href="api/npm-ls.html">npm-ls(3)</a></h2>
<p>List installed packages</p>
-
-<h2 id="npm-outdated-3"><a href="api/npm-outdated.html">npm-outdated(3)</a></h2>
-
+<h2 id="npm-outdated-3-"><a href="api/npm-outdated.html">npm-outdated(3)</a></h2>
<p>Check for outdated packages</p>
-
-<h2 id="npm-owner-3"><a href="api/npm-owner.html">npm-owner(3)</a></h2>
-
+<h2 id="npm-owner-3-"><a href="api/npm-owner.html">npm-owner(3)</a></h2>
<p>Manage package owners</p>
-
-<h2 id="npm-pack-3"><a href="api/npm-pack.html">npm-pack(3)</a></h2>
-
+<h2 id="npm-pack-3-"><a href="api/npm-pack.html">npm-pack(3)</a></h2>
<p>Create a tarball from a package</p>
-
-<h2 id="npm-prefix-3"><a href="api/npm-prefix.html">npm-prefix(3)</a></h2>
-
+<h2 id="npm-prefix-3-"><a href="api/npm-prefix.html">npm-prefix(3)</a></h2>
<p>Display prefix</p>
-
-<h2 id="npm-prune-3"><a href="api/npm-prune.html">npm-prune(3)</a></h2>
-
+<h2 id="npm-prune-3-"><a href="api/npm-prune.html">npm-prune(3)</a></h2>
<p>Remove extraneous packages</p>
-
-<h2 id="npm-publish-3"><a href="api/npm-publish.html">npm-publish(3)</a></h2>
-
+<h2 id="npm-publish-3-"><a href="api/npm-publish.html">npm-publish(3)</a></h2>
<p>Publish a package</p>
-
-<h2 id="npm-rebuild-3"><a href="api/npm-rebuild.html">npm-rebuild(3)</a></h2>
-
+<h2 id="npm-rebuild-3-"><a href="api/npm-rebuild.html">npm-rebuild(3)</a></h2>
<p>Rebuild a package</p>
-
-<h2 id="npm-repo-3"><a href="api/npm-repo.html">npm-repo(3)</a></h2>
-
+<h2 id="npm-repo-3-"><a href="api/npm-repo.html">npm-repo(3)</a></h2>
<p>Open package repository page in the browser</p>
-
-<h2 id="npm-restart-3"><a href="api/npm-restart.html">npm-restart(3)</a></h2>
-
+<h2 id="npm-restart-3-"><a href="api/npm-restart.html">npm-restart(3)</a></h2>
<p>Start a package</p>
-
-<h2 id="npm-root-3"><a href="api/npm-root.html">npm-root(3)</a></h2>
-
+<h2 id="npm-root-3-"><a href="api/npm-root.html">npm-root(3)</a></h2>
<p>Display npm root</p>
-
-<h2 id="npm-run-script-3"><a href="api/npm-run-script.html">npm-run-script(3)</a></h2>
-
+<h2 id="npm-run-script-3-"><a href="api/npm-run-script.html">npm-run-script(3)</a></h2>
<p>Run arbitrary package scripts</p>
-
-<h2 id="npm-search-3"><a href="api/npm-search.html">npm-search(3)</a></h2>
-
+<h2 id="npm-search-3-"><a href="api/npm-search.html">npm-search(3)</a></h2>
<p>Search for packages</p>
-
-<h2 id="npm-shrinkwrap-3"><a href="api/npm-shrinkwrap.html">npm-shrinkwrap(3)</a></h2>
-
+<h2 id="npm-shrinkwrap-3-"><a href="api/npm-shrinkwrap.html">npm-shrinkwrap(3)</a></h2>
<p>programmatically generate package shrinkwrap file</p>
-
-<h2 id="npm-start-3"><a href="api/npm-start.html">npm-start(3)</a></h2>
-
+<h2 id="npm-start-3-"><a href="api/npm-start.html">npm-start(3)</a></h2>
<p>Start a package</p>
-
-<h2 id="npm-stop-3"><a href="api/npm-stop.html">npm-stop(3)</a></h2>
-
+<h2 id="npm-stop-3-"><a href="api/npm-stop.html">npm-stop(3)</a></h2>
<p>Stop a package</p>
-
-<h2 id="npm-submodule-3"><a href="api/npm-submodule.html">npm-submodule(3)</a></h2>
-
+<h2 id="npm-submodule-3-"><a href="api/npm-submodule.html">npm-submodule(3)</a></h2>
<p>Add a package as a git submodule</p>
-
-<h2 id="npm-tag-3"><a href="api/npm-tag.html">npm-tag(3)</a></h2>
-
+<h2 id="npm-tag-3-"><a href="api/npm-tag.html">npm-tag(3)</a></h2>
<p>Tag a published version</p>
-
-<h2 id="npm-test-3"><a href="api/npm-test.html">npm-test(3)</a></h2>
-
+<h2 id="npm-test-3-"><a href="api/npm-test.html">npm-test(3)</a></h2>
<p>Test a package</p>
-
-<h2 id="npm-uninstall-3"><a href="api/npm-uninstall.html">npm-uninstall(3)</a></h2>
-
+<h2 id="npm-uninstall-3-"><a href="api/npm-uninstall.html">npm-uninstall(3)</a></h2>
<p>uninstall a package programmatically</p>
-
-<h2 id="npm-unpublish-3"><a href="api/npm-unpublish.html">npm-unpublish(3)</a></h2>
-
+<h2 id="npm-unpublish-3-"><a href="api/npm-unpublish.html">npm-unpublish(3)</a></h2>
<p>Remove a package from the registry</p>
-
-<h2 id="npm-update-3"><a href="api/npm-update.html">npm-update(3)</a></h2>
-
+<h2 id="npm-update-3-"><a href="api/npm-update.html">npm-update(3)</a></h2>
<p>Update a package</p>
-
-<h2 id="npm-version-3"><a href="api/npm-version.html">npm-version(3)</a></h2>
-
+<h2 id="npm-version-3-"><a href="api/npm-version.html">npm-version(3)</a></h2>
<p>Bump a package version</p>
-
-<h2 id="npm-view-3"><a href="api/npm-view.html">npm-view(3)</a></h2>
-
+<h2 id="npm-view-3-"><a href="api/npm-view.html">npm-view(3)</a></h2>
<p>View registry info</p>
-
-<h2 id="npm-whoami-3"><a href="api/npm-whoami.html">npm-whoami(3)</a></h2>
-
+<h2 id="npm-whoami-3-"><a href="api/npm-whoami.html">npm-whoami(3)</a></h2>
<p>Display npm username</p>
-
-<h1>Files</h1>
-
-<h2 id="npm-folders-5"><a href="files/npm-folders.html">npm-folders(5)</a></h2>
-
+<h1 id="files">Files</h1>
+<h2 id="npm-folders-5-"><a href="files/npm-folders.html">npm-folders(5)</a></h2>
<p>Folder Structures Used by npm</p>
-
-<h2 id="npmrc-5"><a href="files/npmrc.html">npmrc(5)</a></h2>
-
+<h2 id="npmrc-5-"><a href="files/npmrc.html">npmrc(5)</a></h2>
<p>The npm config files</p>
-
-<h2 id="package-json-5"><a href="files/package.json.html">package.json(5)</a></h2>
-
+<h2 id="package-json-5-"><a href="files/package.json.html">package.json(5)</a></h2>
<p>Specifics of npm's package.json handling</p>
-
-<h1>Misc</h1>
-
-<h2 id="npm-coding-style-7"><a href="misc/npm-coding-style.html">npm-coding-style(7)</a></h2>
-
+<h1 id="misc">Misc</h1>
+<h2 id="npm-coding-style-7-"><a href="misc/npm-coding-style.html">npm-coding-style(7)</a></h2>
<p>npm's "funny" coding style</p>
-
-<h2 id="npm-config-7"><a href="misc/npm-config.html">npm-config(7)</a></h2>
-
+<h2 id="npm-config-7-"><a href="misc/npm-config.html">npm-config(7)</a></h2>
<p>More than you probably want to know about npm configuration</p>
-
-<h2 id="npm-developers-7"><a href="misc/npm-developers.html">npm-developers(7)</a></h2>
-
+<h2 id="npm-developers-7-"><a href="misc/npm-developers.html">npm-developers(7)</a></h2>
<p>Developer Guide</p>
-
-<h2 id="npm-disputes-7"><a href="misc/npm-disputes.html">npm-disputes(7)</a></h2>
-
+<h2 id="npm-disputes-7-"><a href="misc/npm-disputes.html">npm-disputes(7)</a></h2>
<p>Handling Module Name Disputes</p>
-
-<h2 id="npm-faq-7"><a href="misc/npm-faq.html">npm-faq(7)</a></h2>
-
+<h2 id="npm-faq-7-"><a href="misc/npm-faq.html">npm-faq(7)</a></h2>
<p>Frequently Asked Questions</p>
-
-<h2 id="npm-index-7"><a href="misc/npm-index.html">npm-index(7)</a></h2>
-
+<h2 id="npm-index-7-"><a href="misc/npm-index.html">npm-index(7)</a></h2>
<p>Index of all npm documentation</p>
-
-<h2 id="npm-registry-7"><a href="misc/npm-registry.html">npm-registry(7)</a></h2>
-
+<h2 id="npm-registry-7-"><a href="misc/npm-registry.html">npm-registry(7)</a></h2>
<p>The JavaScript Package Registry</p>
-
-<h2 id="npm-scripts-7"><a href="misc/npm-scripts.html">npm-scripts(7)</a></h2>
-
+<h2 id="npm-scripts-7-"><a href="misc/npm-scripts.html">npm-scripts(7)</a></h2>
<p>How npm handles the "scripts" field</p>
-
-<h2 id="removing-npm-7"><a href="misc/removing-npm.html">removing-npm(7)</a></h2>
-
+<h2 id="removing-npm-7-"><a href="misc/removing-npm.html">removing-npm(7)</a></h2>
<p>Cleaning the Slate</p>
-
-<h2 id="semver-7"><a href="misc/semver.html">semver(7)</a></h2>
-
+<h2 id="semver-7-"><a href="misc/semver.html">semver(7)</a></h2>
<p>The semantic versioner for npm</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-index — npm@1.4.9</p>
+<p id="footer">npm-index — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../misc/npm-coding-style.html">npm-coding-style</a></h1> <p>npm's "funny" coding style</p>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="description">DESCRIPTION</h2>
<p>npm's coding style is a bit unconventional. It is not different for
difference's sake, but rather a carefully crafted style that is
designed to reduce visual clutter and make bugs more apparent.</p>
-
<p>If you want to contribute to npm (which is very encouraged), you should
make your code conform to npm's style.</p>
-
<p>Note: this concerns npm's code not the specific packages at npmjs.org</p>
-
-<h2 id="Line-Length">Line Length</h2>
-
+<h2 id="line-length">Line Length</h2>
<p>Keep lines shorter than 80 characters. It's better for lines to be
too short than to be too long. Break up long lists, objects, and other
statements onto multiple lines.</p>
-
-<h2 id="Indentation">Indentation</h2>
-
+<h2 id="indentation">Indentation</h2>
<p>Two-spaces. Tabs are better, but they look like hell in web browsers
(and on github), and node uses 2 spaces, so that's that.</p>
-
<p>Configure your editor appropriately.</p>
-
-<h2 id="Curly-braces">Curly braces</h2>
-
+<h2 id="curly-braces">Curly braces</h2>
<p>Curly braces belong on the same line as the thing that necessitates them.</p>
-
<p>Bad:</p>
-
<pre><code>function ()
-{</code></pre>
-
-<p>Good:</p>
-
-<pre><code>function () {</code></pre>
-
-<p>If a block needs to wrap to the next line, use a curly brace. Don't
+{
+</code></pre><p>Good:</p>
+<pre><code>function () {
+</code></pre><p>If a block needs to wrap to the next line, use a curly brace. Don't
use it if it doesn't.</p>
-
<p>Bad:</p>
-
<pre><code>if (foo) { bar() }
while (foo)
- bar()</code></pre>
-
-<p>Good:</p>
-
+ bar()
+</code></pre><p>Good:</p>
<pre><code>if (foo) bar()
while (foo) {
bar()
-}</code></pre>
-
-<h2 id="Semicolons">Semicolons</h2>
-
+}
+</code></pre><h2 id="semicolons">Semicolons</h2>
<p>Don't use them except in four situations:</p>
-
-<ul><li><code>for (;;)</code> loops. They're actually required.</li><li>null loops like: <code>while (something) ;</code> (But you'd better have a good
-reason for doing that.)</li><li><code>case "foo": doSomething(); break</code></li><li>In front of a leading <code>(</code> or <code>[</code> at the start of the line.
+<ul>
+<li><code>for (;;)</code> loops. They're actually required.</li>
+<li>null loops like: <code>while (something) ;</code> (But you'd better have a good
+reason for doing that.)</li>
+<li><code>case "foo": doSomething(); break</code></li>
+<li>In front of a leading <code>(</code> or <code>[</code> at the start of the line.
This prevents the expression from being interpreted
-as a function call or property access, respectively.</li></ul>
-
+as a function call or property access, respectively.</li>
+</ul>
<p>Some examples of good semicolon usage:</p>
-
<pre><code>;(x || y).doSomething()
;[a, b, c].forEach(doSomething)
for (var i = 0; i < 10; i ++) {
default: throw new Error("unknown state")
}
end()
-}</code></pre>
-
-<p>Note that starting lines with <code>-</code> and <code>+</code> also should be prefixed
+}
+</code></pre><p>Note that starting lines with <code>-</code> and <code>+</code> also should be prefixed
with a semicolon, but this is much less common.</p>
-
-<h2 id="Comma-First">Comma First</h2>
-
+<h2 id="comma-first">Comma First</h2>
<p>If there is a list of things separated by commas, and it wraps
across multiple lines, put the comma at the start of the next
line, directly below the token that starts the list. Put the
final token in the list on a line by itself. For example:</p>
-
<pre><code>var magicWords = [ "abracadabra"
, "gesundheit"
, "ventrilo"
, a = 1
, b = "abc"
, etc
- , somethingElse</code></pre>
-
-<h2 id="Whitespace">Whitespace</h2>
-
+ , somethingElse
+</code></pre><h2 id="whitespace">Whitespace</h2>
<p>Put a single space in front of ( for anything other than a function call.
Also use a single space wherever it makes things more readable.</p>
-
<p>Don't leave trailing whitespace at the end of lines. Don't indent empty
lines. Don't use more spaces than are helpful.</p>
-
-<h2 id="Functions">Functions</h2>
-
+<h2 id="functions">Functions</h2>
<p>Use named functions. They make stack traces a lot easier to read.</p>
-
-<h2 id="Callbacks-Sync-async-Style">Callbacks, Sync/async Style</h2>
-
+<h2 id="callbacks-sync-async-style">Callbacks, Sync/async Style</h2>
<p>Use the asynchronous/non-blocking versions of things as much as possible.
It might make more sense for npm to use the synchronous fs APIs, but this
way, the fs and http and child process stuff all uses the same callback-passing
methodology.</p>
-
<p>The callback should always be the last argument in the list. Its first
argument is the Error or null.</p>
-
<p>Be very careful never to ever ever throw anything. It's worse than useless.
Just send the error message back as the first argument to the callback.</p>
-
-<h2 id="Errors">Errors</h2>
-
+<h2 id="errors">Errors</h2>
<p>Always create a new Error object with your message. Don't just return a
string message to the callback. Stack traces are handy.</p>
-
-<h2 id="Logging">Logging</h2>
-
+<h2 id="logging">Logging</h2>
<p>Logging is done using the <a href="https://github.com/npm/npmlog">npmlog</a>
utility.</p>
-
<p>Please clean up logs when they are no longer helpful. In particular,
logging the same object over and over again is not helpful. Logs should
report what's happening so that it's easier to track down where a fault
occurs.</p>
-
<p>Use appropriate log levels. See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> and search for
"loglevel".</p>
-
-<h2 id="Case-naming-etc">Case, naming, etc.</h2>
-
+<h2 id="case-naming-etc-">Case, naming, etc.</h2>
<p>Use <code>lowerCamelCase</code> for multiword identifiers when they refer to objects,
functions, methods, members, or anything not specified in this section.</p>
-
<p>Use <code>UpperCamelCase</code> for class names (things that you'd pass to "new").</p>
-
<p>Use <code>all-lower-hyphen-css-case</code> for multiword filenames and config keys.</p>
-
<p>Use named functions. They make stack traces easier to follow.</p>
-
<p>Use <code>CAPS_SNAKE_CASE</code> for constants, things that should never change
and are rarely used.</p>
-
<p>Use a single uppercase letter for function names where the function
would normally be anonymous, but needs to call itself recursively. It
makes it clear that it's a "throwaway" function.</p>
-
<h2 id="null-undefined-false-0">null, undefined, false, 0</h2>
-
<p>Boolean variables and functions should always be either <code>true</code> or
<code>false</code>. Don't set it to 0 unless it's supposed to be a number.</p>
-
<p>When something is intentionally missing or removed, set it to <code>null</code>.</p>
-
<p>Don't set things to <code>undefined</code>. Reserve that value to mean "not yet
set to anything."</p>
-
<p>Boolean objects are verboten.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<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="../cli/npm.html">npm(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<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="../cli/npm.html">npm(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-coding-style — npm@1.4.9</p>
+<p id="footer">npm-coding-style — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../misc/npm-config.html">npm-config</a></h1> <p>More than you probably want to know about npm configuration</p>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="description">DESCRIPTION</h2>
<p>npm gets its configuration values from 6 sources, in this priority:</p>
-
-<h3 id="Command-Line-Flags">Command Line Flags</h3>
-
+<h3 id="command-line-flags">Command Line Flags</h3>
<p>Putting <code>--foo bar</code> on the command line sets the <code>foo</code> configuration
parameter to <code>"bar"</code>. A <code>--</code> argument tells the cli parser to stop
reading flags. A <code>--flag</code> parameter that is at the <em>end</em> of the
command will be given the value of <code>true</code>.</p>
-
-<h3 id="Environment-Variables">Environment Variables</h3>
-
+<h3 id="environment-variables">Environment Variables</h3>
<p>Any environment variables that start with <code>npm_config_</code> will be
interpreted as a configuration parameter. For example, putting
<code>npm_config_foo=bar</code> in your environment will set the <code>foo</code>
are not given a value will be given the value of <code>true</code>. Config
values are case-insensitive, so <code>NPM_CONFIG_FOO=bar</code> will work the
same.</p>
-
-<h3 id="npmrc-Files">npmrc Files</h3>
-
+<h3 id="npmrc-files">npmrc Files</h3>
<p>The three relevant files are:</p>
-
-<ul><li>per-user config file (~/.npmrc)</li><li>global config file ($PREFIX/npmrc)</li><li>npm builtin config file (/path/to/npm/npmrc)</li></ul>
-
+<ul>
+<li>per-user config file (~/.npmrc)</li>
+<li>global config file ($PREFIX/npmrc)</li>
+<li>npm builtin config file (/path/to/npm/npmrc)</li>
+</ul>
<p>See <a href="../files/npmrc.html">npmrc(5)</a> for more details.</p>
-
-<h3 id="Default-Configs">Default Configs</h3>
-
+<h3 id="default-configs">Default Configs</h3>
<p>A set of configuration parameters that are internal to npm, and are
defaults if nothing else is specified.</p>
-
-<h2 id="Shorthands-and-Other-CLI-Niceties">Shorthands and Other CLI Niceties</h2>
-
+<h2 id="shorthands-and-other-cli-niceties">Shorthands and Other CLI Niceties</h2>
<p>The following shorthands are parsed on the command-line:</p>
-
-<ul><li><code>-v</code>: <code>--version</code></li><li><code>-h</code>, <code>-?</code>, <code>--help</code>, <code>-H</code>: <code>--usage</code></li><li><code>-s</code>, <code>--silent</code>: <code>--loglevel silent</code></li><li><code>-q</code>, <code>--quiet</code>: <code>--loglevel warn</code></li><li><code>-d</code>: <code>--loglevel info</code></li><li><code>-dd</code>, <code>--verbose</code>: <code>--loglevel verbose</code></li><li><code>-ddd</code>: <code>--loglevel silly</code></li><li><code>-g</code>: <code>--global</code></li><li><code>-l</code>: <code>--long</code></li><li><code>-m</code>: <code>--message</code></li><li><code>-p</code>, <code>--porcelain</code>: <code>--parseable</code></li><li><code>-reg</code>: <code>--registry</code></li><li><code>-v</code>: <code>--version</code></li><li><code>-f</code>: <code>--force</code></li><li><code>-desc</code>: <code>--description</code></li><li><code>-S</code>: <code>--save</code></li><li><code>-D</code>: <code>--save-dev</code></li><li><code>-O</code>: <code>--save-optional</code></li><li><code>-B</code>: <code>--save-bundle</code></li><li><code>-E</code>: <code>--save-exact</code></li><li><code>-y</code>: <code>--yes</code></li><li><code>-n</code>: <code>--yes false</code></li><li><code>ll</code> and <code>la</code> commands: <code>ls --long</code></li></ul>
-
+<ul>
+<li><code>-v</code>: <code>--version</code></li>
+<li><code>-h</code>, <code>-?</code>, <code>--help</code>, <code>-H</code>: <code>--usage</code></li>
+<li><code>-s</code>, <code>--silent</code>: <code>--loglevel silent</code></li>
+<li><code>-q</code>, <code>--quiet</code>: <code>--loglevel warn</code></li>
+<li><code>-d</code>: <code>--loglevel info</code></li>
+<li><code>-dd</code>, <code>--verbose</code>: <code>--loglevel verbose</code></li>
+<li><code>-ddd</code>: <code>--loglevel silly</code></li>
+<li><code>-g</code>: <code>--global</code></li>
+<li><code>-l</code>: <code>--long</code></li>
+<li><code>-m</code>: <code>--message</code></li>
+<li><code>-p</code>, <code>--porcelain</code>: <code>--parseable</code></li>
+<li><code>-reg</code>: <code>--registry</code></li>
+<li><code>-v</code>: <code>--version</code></li>
+<li><code>-f</code>: <code>--force</code></li>
+<li><code>-desc</code>: <code>--description</code></li>
+<li><code>-S</code>: <code>--save</code></li>
+<li><code>-D</code>: <code>--save-dev</code></li>
+<li><code>-O</code>: <code>--save-optional</code></li>
+<li><code>-B</code>: <code>--save-bundle</code></li>
+<li><code>-E</code>: <code>--save-exact</code></li>
+<li><code>-y</code>: <code>--yes</code></li>
+<li><code>-n</code>: <code>--yes false</code></li>
+<li><code>ll</code> and <code>la</code> commands: <code>ls --long</code></li>
+</ul>
<p>If the specified configuration param resolves unambiguously to a known
configuration parameter, then it is expanded to that configuration
parameter. For example:</p>
-
<pre><code>npm ls --par
# same as:
-npm ls --parseable</code></pre>
-
-<p>If multiple single-character shorthands are strung together, and the
+npm ls --parseable
+</code></pre><p>If multiple single-character shorthands are strung together, and the
resulting combination is unambiguously not some other configuration
param, then it is expanded to its various component pieces. For
example:</p>
-
<pre><code>npm ls -gpld
# same as:
-npm ls --global --parseable --long --loglevel info</code></pre>
-
-<h2 id="Per-Package-Config-Settings">Per-Package Config Settings</h2>
-
+npm ls --global --parseable --long --loglevel info
+</code></pre><h2 id="per-package-config-settings">Per-Package Config Settings</h2>
<p>When running scripts (see <code><a href="../misc/npm-scripts.html">npm-scripts(7)</a></code>) the package.json "config"
keys are overwritten in the environment if there is a config param of
<code><name>[@<version>]:<key></code>. For example, if the package.json has
this:</p>
-
<pre><code>{ "name" : "foo"
, "config" : { "port" : "8080" }
-, "scripts" : { "start" : "node server.js" } }</code></pre>
-
-<p>and the server.js is this:</p>
-
-<pre><code>http.createServer(...).listen(process.env.npm_package_config_port)</code></pre>
-
-<p>then the user could change the behavior by doing:</p>
-
-<pre><code>npm config set foo:port 80</code></pre>
-
-<p>See <a href="../files/package.json.html">package.json(5)</a> for more information.</p>
-
-<h2 id="Config-Settings">Config Settings</h2>
-
+, "scripts" : { "start" : "node server.js" } }
+</code></pre><p>and the server.js is this:</p>
+<pre><code>http.createServer(...).listen(process.env.npm_package_config_port)
+</code></pre><p>then the user could change the behavior by doing:</p>
+<pre><code>npm config set foo:port 80
+</code></pre><p>See <a href="../files/package.json.html">package.json(5)</a> for more information.</p>
+<h2 id="config-settings">Config Settings</h2>
<h3 id="always-auth">always-auth</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Force npm to always require authentication when accessing the registry,
even for <code>GET</code> requests.</p>
-
<h3 id="bin-links">bin-links</h3>
-
-<ul><li>Default: <code>true</code></li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: <code>true</code></li>
+<li>Type: Boolean</li>
+</ul>
<p>Tells npm to create symlinks (or <code>.cmd</code> shims on Windows) for package
executables.</p>
-
<p>Set to false to have it not do this. This can be used to work around
the fact that some file systems don't support symlinks, even on
ostensibly Unix systems.</p>
-
<h3 id="browser">browser</h3>
-
-<ul><li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li><li>Type: String</li></ul>
-
+<ul>
+<li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li>
+<li>Type: String</li>
+</ul>
<p>The browser that is called by the <code>npm docs</code> command to open websites.</p>
-
<h3 id="ca">ca</h3>
-
-<ul><li>Default: The npm CA certificate</li><li>Type: String or null</li></ul>
-
+<ul>
+<li>Default: The npm CA certificate</li>
+<li>Type: String or null</li>
+</ul>
<p>The Certificate Authority signing certificate that is trusted for SSL
connections to the registry.</p>
-
<p>Set to <code>null</code> to only allow "known" registrars, or to a specific CA cert
to trust only that specific signing authority.</p>
-
<p>See also the <code>strict-ssl</code> config.</p>
-
<h3 id="cache">cache</h3>
-
-<ul><li>Default: Windows: <code>%AppData%\npm-cache</code>, Posix: <code>~/.npm</code></li><li>Type: path</li></ul>
-
+<ul>
+<li>Default: Windows: <code>%AppData%\npm-cache</code>, Posix: <code>~/.npm</code></li>
+<li>Type: path</li>
+</ul>
<p>The location of npm's cache directory. See <code><a href="../cli/npm-cache.html">npm-cache(1)</a></code></p>
-
<h3 id="cache-lock-stale">cache-lock-stale</h3>
-
-<ul><li>Default: 60000 (1 minute)</li><li>Type: Number</li></ul>
-
+<ul>
+<li>Default: 60000 (1 minute)</li>
+<li>Type: Number</li>
+</ul>
<p>The number of ms before cache folder lockfiles are considered stale.</p>
-
<h3 id="cache-lock-retries">cache-lock-retries</h3>
-
-<ul><li>Default: 10</li><li>Type: Number</li></ul>
-
+<ul>
+<li>Default: 10</li>
+<li>Type: Number</li>
+</ul>
<p>Number of times to retry to acquire a lock on cache folder lockfiles.</p>
-
<h3 id="cache-lock-wait">cache-lock-wait</h3>
-
-<ul><li>Default: 10000 (10 seconds)</li><li>Type: Number</li></ul>
-
+<ul>
+<li>Default: 10000 (10 seconds)</li>
+<li>Type: Number</li>
+</ul>
<p>Number of ms to wait for cache lock files to expire.</p>
-
<h3 id="cache-max">cache-max</h3>
-
-<ul><li>Default: Infinity</li><li>Type: Number</li></ul>
-
+<ul>
+<li>Default: Infinity</li>
+<li>Type: Number</li>
+</ul>
<p>The maximum time (in seconds) to keep items in the registry cache before
re-checking against the registry.</p>
-
<p>Note that no purging is done unless the <code>npm cache clean</code> command is
explicitly used, and that only GET requests use the cache.</p>
-
<h3 id="cache-min">cache-min</h3>
-
-<ul><li>Default: 10</li><li>Type: Number</li></ul>
-
+<ul>
+<li>Default: 10</li>
+<li>Type: Number</li>
+</ul>
<p>The minimum time (in seconds) to keep items in the registry cache before
re-checking against the registry.</p>
-
<p>Note that no purging is done unless the <code>npm cache clean</code> command is
explicitly used, and that only GET requests use the cache.</p>
-
<h3 id="cert">cert</h3>
-
-<ul><li>Default: <code>null</code></li><li>Type: String</li></ul>
-
+<ul>
+<li>Default: <code>null</code></li>
+<li>Type: String</li>
+</ul>
<p>A client certificate to pass when accessing the registry.</p>
-
<h3 id="color">color</h3>
-
-<ul><li>Default: true on Posix, false on Windows</li><li>Type: Boolean or <code>"always"</code></li></ul>
-
+<ul>
+<li>Default: true on Posix, false on Windows</li>
+<li>Type: Boolean or <code>"always"</code></li>
+</ul>
<p>If false, never shows colors. If <code>"always"</code> then always shows colors.
If true, then only prints color codes for tty file descriptors.</p>
-
<h3 id="depth">depth</h3>
-
-<ul><li>Default: Infinity</li><li>Type: Number</li></ul>
-
+<ul>
+<li>Default: Infinity</li>
+<li>Type: Number</li>
+</ul>
<p>The depth to go when recursing directories for <code>npm ls</code> and
<code>npm cache ls</code>.</p>
-
<h3 id="description">description</h3>
-
-<ul><li>Default: true</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: true</li>
+<li>Type: Boolean</li>
+</ul>
<p>Show the description in <code>npm search</code></p>
-
<h3 id="dev">dev</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Install <code>dev-dependencies</code> along with packages.</p>
-
<p>Note that <code>dev-dependencies</code> are also installed if the <code>npat</code> flag is
set.</p>
-
<h3 id="editor">editor</h3>
-
-<ul><li>Default: <code>EDITOR</code> environment variable if set, or <code>"vi"</code> on Posix,
-or <code>"notepad"</code> on Windows.</li><li>Type: path</li></ul>
-
+<ul>
+<li>Default: <code>EDITOR</code> environment variable if set, or <code>"vi"</code> on Posix,
+or <code>"notepad"</code> on Windows.</li>
+<li>Type: path</li>
+</ul>
<p>The command to run for <code>npm edit</code> or <code>npm config edit</code>.</p>
-
<h3 id="email">email</h3>
-
<p>The email of the logged-in user.</p>
-
<p>Set by the <code>npm adduser</code> command. Should not be set explicitly.</p>
-
<h3 id="engine-strict">engine-strict</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>If set to true, then npm will stubbornly refuse to install (or even
consider installing) any package that claims to not be compatible with
the current Node.js version.</p>
-
<h3 id="force">force</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Makes various commands more forceful.</p>
-
-<ul><li>lifecycle script failure does not block progress.</li><li>publishing clobbers previously published versions.</li><li>skips cache when requesting from the registry.</li><li>prevents checks against clobbering non-npm files.</li></ul>
-
+<ul>
+<li>lifecycle script failure does not block progress.</li>
+<li>publishing clobbers previously published versions.</li>
+<li>skips cache when requesting from the registry.</li>
+<li>prevents checks against clobbering non-npm files.</li>
+</ul>
<h3 id="fetch-retries">fetch-retries</h3>
-
-<ul><li>Default: 2</li><li>Type: Number</li></ul>
-
+<ul>
+<li>Default: 2</li>
+<li>Type: Number</li>
+</ul>
<p>The "retries" config for the <code>retry</code> module to use when fetching
packages from the registry.</p>
-
<h3 id="fetch-retry-factor">fetch-retry-factor</h3>
-
-<ul><li>Default: 10</li><li>Type: Number</li></ul>
-
+<ul>
+<li>Default: 10</li>
+<li>Type: Number</li>
+</ul>
<p>The "factor" config for the <code>retry</code> module to use when fetching
packages.</p>
-
<h3 id="fetch-retry-mintimeout">fetch-retry-mintimeout</h3>
-
-<ul><li>Default: 10000 (10 seconds)</li><li>Type: Number</li></ul>
-
+<ul>
+<li>Default: 10000 (10 seconds)</li>
+<li>Type: Number</li>
+</ul>
<p>The "minTimeout" config for the <code>retry</code> module to use when fetching
packages.</p>
-
<h3 id="fetch-retry-maxtimeout">fetch-retry-maxtimeout</h3>
-
-<ul><li>Default: 60000 (1 minute)</li><li>Type: Number</li></ul>
-
+<ul>
+<li>Default: 60000 (1 minute)</li>
+<li>Type: Number</li>
+</ul>
<p>The "maxTimeout" config for the <code>retry</code> module to use when fetching
packages.</p>
-
<h3 id="git">git</h3>
-
-<ul><li>Default: <code>"git"</code></li><li>Type: String</li></ul>
-
+<ul>
+<li>Default: <code>"git"</code></li>
+<li>Type: String</li>
+</ul>
<p>The command to use for git commands. If git is installed on the
computer, but is not in the <code>PATH</code>, then set this to the full path to
the git binary.</p>
-
<h3 id="git-tag-version">git-tag-version</h3>
-
-<ul><li>Default: <code>true</code></li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: <code>true</code></li>
+<li>Type: Boolean</li>
+</ul>
<p>Tag the commit when using the <code>npm version</code> command.</p>
-
<h3 id="global">global</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Operates in "global" mode, so that packages are installed into the
<code>prefix</code> folder instead of the current working directory. See
<code><a href="../files/npm-folders.html">npm-folders(5)</a></code> for more on the differences in behavior.</p>
-
-<ul><li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead of the
-current working directory.</li><li>bin files are linked to <code>{prefix}/bin</code></li><li>man pages are linked to <code>{prefix}/share/man</code></li></ul>
-
+<ul>
+<li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead of the
+current working directory.</li>
+<li>bin files are linked to <code>{prefix}/bin</code></li>
+<li>man pages are linked to <code>{prefix}/share/man</code></li>
+</ul>
<h3 id="globalconfig">globalconfig</h3>
-
-<ul><li>Default: {prefix}/etc/npmrc</li><li>Type: path</li></ul>
-
+<ul>
+<li>Default: {prefix}/etc/npmrc</li>
+<li>Type: path</li>
+</ul>
<p>The config file to read for global config options.</p>
-
<h3 id="group">group</h3>
-
-<ul><li>Default: GID of the current process</li><li>Type: String or Number</li></ul>
-
+<ul>
+<li>Default: GID of the current process</li>
+<li>Type: String or Number</li>
+</ul>
<p>The group to use when running package scripts in global mode as the root
user.</p>
-
<h3 id="heading">heading</h3>
-
-<ul><li>Default: <code>"npm"</code></li><li>Type: String</li></ul>
-
+<ul>
+<li>Default: <code>"npm"</code></li>
+<li>Type: String</li>
+</ul>
<p>The string that starts all the debugging log output.</p>
-
<h3 id="https-proxy">https-proxy</h3>
-
-<ul><li>Default: the <code>HTTPS_PROXY</code> or <code>https_proxy</code> or <code>HTTP_PROXY</code> or
-<code>http_proxy</code> environment variables.</li><li>Type: url</li></ul>
-
+<ul>
+<li>Default: the <code>HTTPS_PROXY</code> or <code>https_proxy</code> or <code>HTTP_PROXY</code> or
+<code>http_proxy</code> environment variables.</li>
+<li>Type: url</li>
+</ul>
<p>A proxy to use for outgoing https requests.</p>
-
<h3 id="ignore-scripts">ignore-scripts</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>If true, npm does not run scripts specified in package.json files.</p>
-
<h3 id="init-module">init-module</h3>
-
-<ul><li>Default: ~/.npm-init.js</li><li>Type: path</li></ul>
-
+<ul>
+<li>Default: ~/.npm-init.js</li>
+<li>Type: path</li>
+</ul>
<p>A module that will be loaded by the <code>npm init</code> command. See the
documentation for the
<a href="https://github.com/isaacs/init-package-json">init-package-json</a> module
for more information, or <a href="../cli/npm-init.html">npm-init(1)</a>.</p>
-
<h3 id="init-author-name">init.author.name</h3>
-
-<ul><li>Default: ""</li><li>Type: String</li></ul>
-
+<ul>
+<li>Default: ""</li>
+<li>Type: String</li>
+</ul>
<p>The value <code>npm init</code> should use by default for the package author's name.</p>
-
<h3 id="init-author-email">init.author.email</h3>
-
-<ul><li>Default: ""</li><li>Type: String</li></ul>
-
+<ul>
+<li>Default: ""</li>
+<li>Type: String</li>
+</ul>
<p>The value <code>npm init</code> should use by default for the package author's email.</p>
-
<h3 id="init-author-url">init.author.url</h3>
-
-<ul><li>Default: ""</li><li>Type: String</li></ul>
-
+<ul>
+<li>Default: ""</li>
+<li>Type: String</li>
+</ul>
<p>The value <code>npm init</code> should use by default for the package author's homepage.</p>
-
<h3 id="init-license">init.license</h3>
-
-<ul><li>Default: "ISC"</li><li>Type: String</li></ul>
-
+<ul>
+<li>Default: "ISC"</li>
+<li>Type: String</li>
+</ul>
<p>The value <code>npm init</code> should use by default for the package license.</p>
-
<h3 id="json">json</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Whether or not to output JSON data, rather than the normal output.</p>
-
<p>This feature is currently experimental, and the output data structures
for many commands is either not implemented in JSON yet, or subject to
change. Only the output from <code>npm ls --json</code> is currently valid.</p>
-
<h3 id="key">key</h3>
-
-<ul><li>Default: <code>null</code></li><li>Type: String</li></ul>
-
+<ul>
+<li>Default: <code>null</code></li>
+<li>Type: String</li>
+</ul>
<p>A client key to pass when accessing the registry.</p>
-
<h3 id="link">link</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>If true, then local installs will link if there is a suitable globally
installed package.</p>
-
<p>Note that this means that local installs can cause things to be
installed into the global space at the same time. The link is only done
if one of the two conditions are met:</p>
-
-<ul><li>The package is not already installed globally, or</li><li>the globally installed version is identical to the version that is
-being installed locally.</li></ul>
-
+<ul>
+<li>The package is not already installed globally, or</li>
+<li>the globally installed version is identical to the version that is
+being installed locally.</li>
+</ul>
<h3 id="local-address">local-address</h3>
-
-<ul><li>Default: undefined</li><li>Type: IP Address</li></ul>
-
+<ul>
+<li>Default: undefined</li>
+<li>Type: IP Address</li>
+</ul>
<p>The IP address of the local interface to use when making connections
to the npm registry. Must be IPv4 in versions of Node prior to 0.12.</p>
-
<h3 id="loglevel">loglevel</h3>
-
-<ul><li>Default: "http"</li><li>Type: String</li><li>Values: "silent", "win", "error", "warn", "http", "info", "verbose", "silly"</li></ul>
-
+<ul>
+<li>Default: "http"</li>
+<li>Type: String</li>
+<li>Values: "silent", "win", "error", "warn", "http", "info", "verbose", "silly"</li>
+</ul>
<p>What level of logs to report. On failure, <em>all</em> logs are written to
<code>npm-debug.log</code> in the current working directory.</p>
-
<p>Any logs of a higher level than the setting are shown.
The default is "http", which shows http, warn, and error output.</p>
-
<h3 id="logstream">logstream</h3>
-
-<ul><li>Default: process.stderr</li><li>Type: Stream</li></ul>
-
+<ul>
+<li>Default: process.stderr</li>
+<li>Type: Stream</li>
+</ul>
<p>This is the stream that is passed to the
<a href="https://github.com/npm/npmlog">npmlog</a> module at run time.</p>
-
<p>It cannot be set from the command line, but if you are using npm
programmatically, you may wish to send logs to somewhere other than
stderr.</p>
-
<p>If the <code>color</code> config is set to true, then this stream will receive
colored output if it is a TTY.</p>
-
<h3 id="long">long</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Show extended information in <code>npm ls</code> and <code>npm search</code>.</p>
-
<h3 id="message">message</h3>
-
-<ul><li>Default: "%s"</li><li>Type: String</li></ul>
-
+<ul>
+<li>Default: "%s"</li>
+<li>Type: String</li>
+</ul>
<p>Commit message which is used by <code>npm version</code> when creating version commit.</p>
-
<p>Any "%s" in the message will be replaced with the version number.</p>
-
<h3 id="node-version">node-version</h3>
-
-<ul><li>Default: process.version</li><li>Type: semver or false</li></ul>
-
+<ul>
+<li>Default: process.version</li>
+<li>Type: semver or false</li>
+</ul>
<p>The node version to use when checking package's "engines" hash.</p>
-
<h3 id="npat">npat</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Run tests on installation.</p>
-
<h3 id="onload-script">onload-script</h3>
-
-<ul><li>Default: false</li><li>Type: path</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: path</li>
+</ul>
<p>A node module to <code>require()</code> when npm loads. Useful for programmatic
usage.</p>
-
<h3 id="optional">optional</h3>
-
-<ul><li>Default: true</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: true</li>
+<li>Type: Boolean</li>
+</ul>
<p>Attempt to install packages in the <code>optionalDependencies</code> hash. Note
that if these packages fail to install, the overall installation
process is not aborted.</p>
-
<h3 id="parseable">parseable</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Output parseable results from commands that write to
standard output.</p>
-
<h3 id="prefix">prefix</h3>
-
-<ul><li>Default: see <a href="../files/npm-folders.html">npm-folders(5)</a></li><li>Type: path</li></ul>
-
+<ul>
+<li>Default: see <a href="../files/npm-folders.html">npm-folders(5)</a></li>
+<li>Type: path</li>
+</ul>
<p>The location to install global items. If set on the command line, then
it forces non-global commands to run in the specified folder.</p>
-
<h3 id="production">production</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Set to true to run in "production" mode.</p>
-
-<ol><li>devDependencies are not installed at the topmost level when running
-local <code>npm install</code> without any arguments.</li><li>Set the NODE_ENV="production" for lifecycle scripts.</li></ol>
-
+<ol>
+<li>devDependencies are not installed at the topmost level when running
+local <code>npm install</code> without any arguments.</li>
+<li>Set the NODE_ENV="production" for lifecycle scripts.</li>
+</ol>
<h3 id="proprietary-attribs">proprietary-attribs</h3>
-
-<ul><li>Default: true</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: true</li>
+<li>Type: Boolean</li>
+</ul>
<p>Whether or not to include proprietary extended attributes in the
tarballs created by npm.</p>
-
<p>Unless you are expecting to unpack package tarballs with something other
than npm -- particularly a very outdated tar implementation -- leave
this as true.</p>
-
<h3 id="proxy">proxy</h3>
-
-<ul><li>Default: <code>HTTP_PROXY</code> or <code>http_proxy</code> environment variable, or null</li><li>Type: url</li></ul>
-
+<ul>
+<li>Default: <code>HTTP_PROXY</code> or <code>http_proxy</code> environment variable, or null</li>
+<li>Type: url</li>
+</ul>
<p>A proxy to use for outgoing http requests.</p>
-
<h3 id="rebuild-bundle">rebuild-bundle</h3>
-
-<ul><li>Default: true</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: true</li>
+<li>Type: Boolean</li>
+</ul>
<p>Rebuild bundled dependencies after installation.</p>
-
<h3 id="registry">registry</h3>
-
-<ul><li>Default: https://registry.npmjs.org/</li><li>Type: url</li></ul>
-
+<ul>
+<li>Default: <a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a></li>
+<li>Type: url</li>
+</ul>
<p>The base URL of the npm package registry.</p>
-
<h3 id="rollback">rollback</h3>
-
-<ul><li>Default: true</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: true</li>
+<li>Type: Boolean</li>
+</ul>
<p>Remove failed installs.</p>
-
<h3 id="save">save</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Save installed packages to a package.json file as dependencies.</p>
-
<p>When used with the <code>npm rm</code> command, it removes it from the dependencies
hash.</p>
-
<p>Only works if there is already a package.json file present.</p>
-
<h3 id="save-bundle">save-bundle</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>If a package would be saved at install time by the use of <code>--save</code>,
<code>--save-dev</code>, or <code>--save-optional</code>, then also put it in the
<code>bundleDependencies</code> list.</p>
-
<p>When used with the <code>npm rm</code> command, it removes it from the
bundledDependencies list.</p>
-
<h3 id="save-dev">save-dev</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Save installed packages to a package.json file as devDependencies.</p>
-
<p>When used with the <code>npm rm</code> command, it removes it from the
devDependencies hash.</p>
-
<p>Only works if there is already a package.json file present.</p>
-
<h3 id="save-exact">save-exact</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Dependencies saved to package.json using <code>--save</code>, <code>--save-dev</code> or
<code>--save-optional</code> will be configured with an exact version rather than
using npm's default semver range operator.</p>
-
<h3 id="save-optional">save-optional</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Save installed packages to a package.json file as
optionalDependencies.</p>
-
<p>When used with the <code>npm rm</code> command, it removes it from the
devDependencies hash.</p>
-
<p>Only works if there is already a package.json file present.</p>
-
<h3 id="save-prefix">save-prefix</h3>
-
-<ul><li>Default: '^'</li><li>Type: String</li></ul>
-
+<ul>
+<li>Default: '^'</li>
+<li>Type: String</li>
+</ul>
<p>Configure how versions of packages installed to a package.json file via
<code>--save</code> or <code>--save-dev</code> get prefixed.</p>
-
<p>For example if a package has version <code>1.2.3</code>, by default it's version is
-set to <code>^1.2.3</code> which allows minor upgrades for that package, but after<br /><code>npm config set save-prefix='~'</code> it would be set to <code>~1.2.3</code> which only allows
+set to <code>^1.2.3</code> which allows minor upgrades for that package, but after<br><code>npm config set save-prefix='~'</code> it would be set to <code>~1.2.3</code> which only allows
patch upgrades.</p>
-
<h3 id="searchopts">searchopts</h3>
-
-<ul><li>Default: ""</li><li>Type: String</li></ul>
-
+<ul>
+<li>Default: ""</li>
+<li>Type: String</li>
+</ul>
<p>Space-separated options that are always passed to search.</p>
-
<h3 id="searchexclude">searchexclude</h3>
-
-<ul><li>Default: ""</li><li>Type: String</li></ul>
-
+<ul>
+<li>Default: ""</li>
+<li>Type: String</li>
+</ul>
<p>Space-separated options that limit the results from search.</p>
-
<h3 id="searchsort">searchsort</h3>
-
-<ul><li>Default: "name"</li><li>Type: String</li><li>Values: "name", "-name", "date", "-date", "description",
-"-description", "keywords", "-keywords"</li></ul>
-
+<ul>
+<li>Default: "name"</li>
+<li>Type: String</li>
+<li>Values: "name", "-name", "date", "-date", "description",
+"-description", "keywords", "-keywords"</li>
+</ul>
<p>Indication of which field to sort search results by. Prefix with a <code>-</code>
character to indicate reverse sort.</p>
-
<h3 id="shell">shell</h3>
-
-<ul><li>Default: SHELL environment variable, or "bash" on Posix, or "cmd" on
-Windows</li><li>Type: path</li></ul>
-
+<ul>
+<li>Default: SHELL environment variable, or "bash" on Posix, or "cmd" on
+Windows</li>
+<li>Type: path</li>
+</ul>
<p>The shell to run for the <code>npm explore</code> command.</p>
-
<h3 id="shrinkwrap">shrinkwrap</h3>
-
-<ul><li>Default: true</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: true</li>
+<li>Type: Boolean</li>
+</ul>
<p>If set to false, then ignore <code>npm-shrinkwrap.json</code> files when
installing.</p>
-
<h3 id="sign-git-tag">sign-git-tag</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>If set to true, then the <code>npm version</code> command will tag the version
using <code>-s</code> to add a signature.</p>
-
<p>Note that git requires you to have set up GPG keys in your git configs
for this to work properly.</p>
-
<h3 id="strict-ssl">strict-ssl</h3>
-
-<ul><li>Default: true</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: true</li>
+<li>Type: Boolean</li>
+</ul>
<p>Whether or not to do SSL key validation when making requests to the
registry via https.</p>
-
<p>See also the <code>ca</code> config.</p>
-
<h3 id="tag">tag</h3>
-
-<ul><li>Default: latest</li><li>Type: String</li></ul>
-
+<ul>
+<li>Default: latest</li>
+<li>Type: String</li>
+</ul>
<p>If you ask npm to install a package and don't tell it a specific version, then
it will install the specified tag.</p>
-
<p>Also the tag that is added to the package@version specified by the <code>npm
tag</code> command, if no explicit tag is given.</p>
-
<h3 id="tmp">tmp</h3>
-
-<ul><li>Default: TMPDIR environment variable, or "/tmp"</li><li>Type: path</li></ul>
-
+<ul>
+<li>Default: TMPDIR environment variable, or "/tmp"</li>
+<li>Type: path</li>
+</ul>
<p>Where to store temporary files and folders. All temp files are deleted
on success, but left behind on failure for forensic purposes.</p>
-
<h3 id="unicode">unicode</h3>
-
-<ul><li>Default: true</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: true</li>
+<li>Type: Boolean</li>
+</ul>
<p>When set to true, npm uses unicode characters in the tree output. When
false, it uses ascii characters to draw trees.</p>
-
<h3 id="unsafe-perm">unsafe-perm</h3>
-
-<ul><li>Default: false if running as root, true otherwise</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false if running as root, true otherwise</li>
+<li>Type: Boolean</li>
+</ul>
<p>Set to true to suppress the UID/GID switching when running package
scripts. If set explicitly to false, then installing as a non-root user
will fail.</p>
-
<h3 id="usage">usage</h3>
-
-<ul><li>Default: false</li><li>Type: Boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: Boolean</li>
+</ul>
<p>Set to show short usage output (like the -H output)
instead of complete help when doing <code><a href="../cli/npm-help.html">npm-help(1)</a></code>.</p>
-
<h3 id="user">user</h3>
-
-<ul><li>Default: "nobody"</li><li>Type: String or Number</li></ul>
-
+<ul>
+<li>Default: "nobody"</li>
+<li>Type: String or Number</li>
+</ul>
<p>The UID to set to when running package scripts as root.</p>
-
<h3 id="username">username</h3>
-
-<ul><li>Default: null</li><li>Type: String</li></ul>
-
+<ul>
+<li>Default: null</li>
+<li>Type: String</li>
+</ul>
<p>The username on the npm registry. Set with <code>npm adduser</code></p>
-
<h3 id="userconfig">userconfig</h3>
-
-<ul><li>Default: ~/.npmrc</li><li>Type: path</li></ul>
-
+<ul>
+<li>Default: ~/.npmrc</li>
+<li>Type: path</li>
+</ul>
<p>The location of user-level configuration settings.</p>
-
<h3 id="umask">umask</h3>
-
-<ul><li>Default: 022</li><li>Type: Octal numeric string</li></ul>
-
+<ul>
+<li>Default: 022</li>
+<li>Type: Octal numeric string</li>
+</ul>
<p>The "umask" value to use when setting the file creation mode on files
and folders.</p>
-
<p>Folders and executables are given a mode which is <code>0777</code> masked against
this value. Other files are given a mode which is <code>0666</code> masked against
this value. Thus, the defaults are <code>0755</code> and <code>0644</code> respectively.</p>
-
<h3 id="user-agent">user-agent</h3>
-
-<ul><li>Default: node/{process.version} {process.platform} {process.arch}</li><li>Type: String</li></ul>
-
+<ul>
+<li>Default: node/{process.version} {process.platform} {process.arch}</li>
+<li>Type: String</li>
+</ul>
<p>Sets a User-Agent to the request header</p>
-
<h3 id="version">version</h3>
-
-<ul><li>Default: false</li><li>Type: boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: boolean</li>
+</ul>
<p>If true, output the npm version and exit successfully.</p>
-
<p>Only relevant when specified explicitly on the command line.</p>
-
<h3 id="versions">versions</h3>
-
-<ul><li>Default: false</li><li>Type: boolean</li></ul>
-
+<ul>
+<li>Default: false</li>
+<li>Type: boolean</li>
+</ul>
<p>If true, output the npm version as well as node's <code>process.versions</code>
hash, and exit successfully.</p>
-
<p>Only relevant when specified explicitly on the command line.</p>
-
<h3 id="viewer">viewer</h3>
-
-<ul><li>Default: "man" on Posix, "browser" on Windows</li><li>Type: path</li></ul>
-
+<ul>
+<li>Default: "man" on Posix, "browser" on Windows</li>
+<li>Type: path</li>
+</ul>
<p>The program to use to view help content.</p>
-
<p>Set to <code>"browser"</code> to view html help content in the default web browser.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<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-scripts.html">npm-scripts(7)</a></li>
+<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
+<li><a href="../cli/npm.html">npm(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><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-scripts.html">npm-scripts(7)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm.html">npm(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-config — npm@1.4.9</p>
+<p id="footer">npm-config — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../misc/npm-developers.html">npm-developers</a></h1> <p>Developer Guide</p>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="description">DESCRIPTION</h2>
<p>So, you've decided to use npm to develop (and maybe publish/deploy)
your project.</p>
-
<p>Fantastic!</p>
-
<p>There are a few things that you need to do above the simple steps
that your users will do to install your program.</p>
-
-<h2 id="About-These-Documents">About These Documents</h2>
-
+<h2 id="about-these-documents">About These Documents</h2>
<p>These are man pages. If you install npm, you should be able to
then do <code>man npm-thing</code> to get the documentation on a particular
topic, or <code>npm help thing</code> to see the same information.</p>
-
-<h2 id="What-is-a-package">What is a <code>package</code></h2>
-
+<h2 id="what-is-a-package-">What is a <code>package</code></h2>
<p>A package is:</p>
-
-<ul><li>a) a folder containing a program described by a package.json file</li><li>b) a gzipped tarball containing (a)</li><li>c) a url that resolves to (b)</li><li>d) a <code><name>@<version></code> that is published on the registry with (c)</li><li>e) a <code><name>@<tag></code> that points to (d)</li><li>f) a <code><name></code> that has a "latest" tag satisfying (e)</li><li>g) a <code>git</code> url that, when cloned, results in (a).</li></ul>
-
+<ul>
+<li>a) a folder containing a program described by a package.json file</li>
+<li>b) a gzipped tarball containing (a)</li>
+<li>c) a url that resolves to (b)</li>
+<li>d) a <code><name>@<version></code> that is published on the registry with (c)</li>
+<li>e) a <code><name>@<tag></code> that points to (d)</li>
+<li>f) a <code><name></code> that has a "latest" tag satisfying (e)</li>
+<li>g) a <code>git</code> url that, when cloned, results in (a).</li>
+</ul>
<p>Even if you never publish your package, you can still get a lot of
benefits of using npm if you just want to write a node program (a), and
perhaps if you also want to be able to easily install it elsewhere
after packing it up into a tarball (b).</p>
-
<p>Git urls can be of the form:</p>
-
<pre><code>git://github.com/user/project.git#commit-ish
git+ssh://user@hostname:project.git#commit-ish
git+http://user@hostname/project/blah.git#commit-ish
-git+https://user@hostname/project/blah.git#commit-ish</code></pre>
-
-<p>The <code>commit-ish</code> can be any tag, sha, or branch which can be supplied as
+git+https://user@hostname/project/blah.git#commit-ish
+</code></pre><p>The <code>commit-ish</code> can be any tag, sha, or branch which can be supplied as
an argument to <code>git checkout</code>. The default is <code>master</code>.</p>
-
-<h2 id="The-package-json-File">The package.json File</h2>
-
+<h2 id="the-package-json-file">The package.json File</h2>
<p>You need to have a <code>package.json</code> file in the root of your project to do
much of anything with npm. That is basically the whole interface.</p>
-
<p>See <code><a href="../files/package.json.html">package.json(5)</a></code> for details about what goes in that file. At the very
least, you need:</p>
-
+<ul>
+<li><p>name:
This should be a string that identifies your project. Please do not
use the name to specify that it runs on node, or is in JavaScript.
You can use the "engines" field to explicitly state the versions of
node (or whatever else) that your program requires, and it's pretty
-well assumed that it's javascript.</p><p>It does not necessarily need to match your github repository name.</p><p>So, <code>node-foo</code> and <code>bar-js</code> are bad names. <code>foo</code> or <code>bar</code> are better.</p></li><li><p>version:
-A semver-compatible version.</p></li><li><p>engines:
+well assumed that it's javascript.</p>
+<p>It does not necessarily need to match your github repository name.</p>
+<p>So, <code>node-foo</code> and <code>bar-js</code> are bad names. <code>foo</code> or <code>bar</code> are better.</p>
+</li>
+<li><p>version:
+A semver-compatible version.</p>
+</li>
+<li><p>engines:
Specify the versions of node (or whatever else) that your program
runs on. The node API changes a lot, and there may be bugs or new
-functionality that you depend on. Be explicit.</p></li><li><p>author:
-Take some credit.</p></li><li><p>scripts:
+functionality that you depend on. Be explicit.</p>
+</li>
+<li><p>author:
+Take some credit.</p>
+</li>
+<li><p>scripts:
If you have a special compilation or installation script, then you
should put it in the <code>scripts</code> hash. You should definitely have at
least a basic smoke-test command as the "scripts.test" field.
-See <a href="../misc/npm-scripts.html">npm-scripts(7)</a>.</p></li><li><p>main:
+See <a href="../misc/npm-scripts.html">npm-scripts(7)</a>.</p>
+</li>
+<li><p>main:
If you have a single module that serves as the entry point to your
program (like what the "foo" package gives you at require("foo")),
-then you need to specify that in the "main" field.</p></li><li><p>directories:
+then you need to specify that in the "main" field.</p>
+</li>
+<li><p>directories:
This is a hash of folders. The best ones to include are "lib" and
"doc", but if you specify a folder full of man pages in "man", then
-they'll get installed just like these ones.</p></li></ul>
-
+they'll get installed just like these ones.</p>
+</li>
+</ul>
<p>You can use <code>npm init</code> in the root of your package in order to get you
started with a pretty basic package.json file. See <code><a href="../cli/npm-init.html">npm-init(1)</a></code> for
more info.</p>
-
-<h2 id="Keeping-files-out-of-your-package">Keeping files <em>out</em> of your package</h2>
-
+<h2 id="keeping-files-out-of-your-package">Keeping files <em>out</em> of your package</h2>
<p>Use a <code>.npmignore</code> file to keep stuff out of your package. If there's
no <code>.npmignore</code> file, but there <em>is</em> a <code>.gitignore</code> file, then npm will
ignore the stuff matched by the <code>.gitignore</code> file. If you <em>want</em> to
include something that is excluded by your <code>.gitignore</code> file, you can
create an empty <code>.npmignore</code> file to override it.</p>
-
<p>By default, the following paths and files are ignored, so there's no
need to add them to <code>.npmignore</code> explicitly:</p>
-
-<ul><li><code>.*.swp</code></li><li><code>._*</code></li><li><code>.DS_Store</code></li><li><code>.git</code></li><li><code>.hg</code></li><li><code>.lock-wscript</code></li><li><code>.svn</code></li><li><code>.wafpickle-*</code></li><li><code>CVS</code></li><li><code>npm-debug.log</code></li></ul>
-
+<ul>
+<li><code>.*.swp</code></li>
+<li><code>._*</code></li>
+<li><code>.DS_Store</code></li>
+<li><code>.git</code></li>
+<li><code>.hg</code></li>
+<li><code>.lock-wscript</code></li>
+<li><code>.svn</code></li>
+<li><code>.wafpickle-*</code></li>
+<li><code>CVS</code></li>
+<li><code>npm-debug.log</code></li>
+</ul>
<p>Additionally, everything in <code>node_modules</code> is ignored, except for
bundled dependencies. npm automatically handles this for you, so don't
bother adding <code>node_modules</code> to <code>.npmignore</code>.</p>
-
<p>The following paths and files are never ignored, so adding them to
<code>.npmignore</code> is pointless:</p>
-
-<ul><li><code>package.json</code></li><li><code><a href="../../doc/README.html">README</a>.*</code></li></ul>
-
-<h2 id="Link-Packages">Link Packages</h2>
-
+<ul>
+<li><code>package.json</code></li>
+<li><code><a href="../../doc/README.html">README</a>.*</code></li>
+</ul>
+<h2 id="link-packages">Link Packages</h2>
<p><code>npm link</code> is designed to install a development package and see the
changes in real time without having to keep re-installing it. (You do
need to either re-link or <code>npm rebuild -g</code> to update compiled packages,
of course.)</p>
-
<p>More info at <code><a href="../cli/npm-link.html">npm-link(1)</a></code>.</p>
-
-<h2 id="Before-Publishing-Make-Sure-Your-Package-Installs-and-Works">Before Publishing: Make Sure Your Package Installs and Works</h2>
-
+<h2 id="before-publishing-make-sure-your-package-installs-and-works">Before Publishing: Make Sure Your Package Installs and Works</h2>
<p><strong>This is important.</strong></p>
-
<p>If you can not install it locally, you'll have
problems trying to publish it. Or, worse yet, you'll be able to
publish it, but you'll be publishing a broken or pointless package.
So don't do that.</p>
-
<p>In the root of your package, do this:</p>
-
-<pre><code>npm install . -g</code></pre>
-
-<p>That'll show you that it's working. If you'd rather just create a symlink
+<pre><code>npm install . -g
+</code></pre><p>That'll show you that it's working. If you'd rather just create a symlink
package that points to your working directory, then do this:</p>
-
-<pre><code>npm link</code></pre>
-
-<p>Use <code>npm ls -g</code> to see if it's there.</p>
-
+<pre><code>npm link
+</code></pre><p>Use <code>npm ls -g</code> to see if it's there.</p>
<p>To test a local install, go into some other folder, and then do:</p>
-
<pre><code>cd ../some-other-folder
-npm install ../my-package</code></pre>
-
-<p>to install it locally into the node_modules folder in that other place.</p>
-
+npm install ../my-package
+</code></pre><p>to install it locally into the node_modules folder in that other place.</p>
<p>Then go into the node-repl, and try using require("my-thing") to
bring in your module's main module.</p>
-
-<h2 id="Create-a-User-Account">Create a User Account</h2>
-
+<h2 id="create-a-user-account">Create a User Account</h2>
<p>Create a user with the adduser command. It works like this:</p>
-
-<pre><code>npm adduser</code></pre>
-
-<p>and then follow the prompts.</p>
-
+<pre><code>npm adduser
+</code></pre><p>and then follow the prompts.</p>
<p>This is documented better in <a href="../cli/npm-adduser.html">npm-adduser(1)</a>.</p>
-
-<h2 id="Publish-your-package">Publish your package</h2>
-
+<h2 id="publish-your-package">Publish your package</h2>
<p>This part's easy. IN the root of your folder, do this:</p>
-
-<pre><code>npm publish</code></pre>
-
-<p>You can give publish a url to a tarball, or a filename of a tarball,
+<pre><code>npm publish
+</code></pre><p>You can give publish a url to a tarball, or a filename of a tarball,
or a path to a folder.</p>
-
<p>Note that pretty much <strong>everything in that folder will be exposed</strong>
by default. So, if you have secret stuff in there, use a
<code>.npmignore</code> file to list out the globs to ignore, or publish
from a fresh checkout.</p>
-
-<h2 id="Brag-about-it">Brag about it</h2>
-
+<h2 id="brag-about-it">Brag about it</h2>
<p>Send emails, write blogs, blab in IRC.</p>
-
<p>Tell the world how easy it is to install your program!</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../misc/npm-faq.html">npm-faq(7)</a></li>
+<li><a href="../cli/npm.html">npm(1)</a></li>
+<li><a href="../cli/npm-init.html">npm-init(1)</a></li>
+<li><a href="../files/package.json.html">package.json(5)</a></li>
+<li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li>
+<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
+<li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li>
+<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../misc/npm-faq.html">npm-faq(7)</a></li><li><a href="../cli/npm.html">npm(1)</a></li><li><a href="../cli/npm-init.html">npm-init(1)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-developers — npm@1.4.9</p>
+<p id="footer">npm-developers — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../misc/npm-disputes.html">npm-disputes</a></h1> <p>Handling Module Name Disputes</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<ol><li>Get the author email with <code>npm owner ls <pkgname></code></li><li>Email the author, CC <a href="mailto:support@npmjs.com">support@npmjs.com</a></li><li>After a few weeks, if there's no resolution, we'll sort it out.</li></ol>
-
+<h2 id="synopsis">SYNOPSIS</h2>
+<ol>
+<li>Get the author email with <code>npm owner ls <pkgname></code></li>
+<li>Email the author, CC <a href="mailto:support@npmjs.com">support@npmjs.com</a></li>
+<li>After a few weeks, if there's no resolution, we'll sort it out.</li>
+</ol>
<p>Don't squat on package names. Publish code or move out of the way.</p>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="description">DESCRIPTION</h2>
<p>There sometimes arise cases where a user publishes a module, and then
later, some other user wants to use that name. Here are some common
ways that happens (each of these is based on actual events.)</p>
-
-<ol><li>Joe writes a JavaScript module <code>foo</code>, which is not node-specific.
+<ol>
+<li>Joe writes a JavaScript module <code>foo</code>, which is not node-specific.
Joe doesn't use node at all. Bob wants to use <code>foo</code> in node, so he
wraps it in an npm module. Some time later, Joe starts using node,
-and wants to take over management of his program.</li><li>Bob writes an npm module <code>foo</code>, and publishes it. Perhaps much
+and wants to take over management of his program.</li>
+<li>Bob writes an npm module <code>foo</code>, and publishes it. Perhaps much
later, Joe finds a bug in <code>foo</code>, and fixes it. He sends a pull
request to Bob, but Bob doesn't have the time to deal with it,
because he has a new job and a new baby and is focused on his new
erlang project, and kind of not involved with node any more. Joe
would like to publish a new <code>foo</code>, but can't, because the name is
-taken.</li><li>Bob writes a 10-line flow-control library, and calls it <code>foo</code>, and
+taken.</li>
+<li>Bob writes a 10-line flow-control library, and calls it <code>foo</code>, and
publishes it to the npm registry. Being a simple little thing, it
never really has to be updated. Joe works for Foo Inc, the makers
of the critically acclaimed and widely-marketed <code>foo</code> JavaScript
toolkit framework. They publish it to npm as <code>foojs</code>, but people are
-routinely confused when <code>npm install foo</code> is some different thing.</li><li>Bob writes a parser for the widely-known <code>foo</code> file format, because
+routinely confused when <code>npm install foo</code> is some different thing.</li>
+<li>Bob writes a parser for the widely-known <code>foo</code> file format, because
he needs it for work. Then, he gets a new job, and never updates the
prototype. Later on, Joe writes a much more complete <code>foo</code> parser,
-but can't publish, because Bob's <code>foo</code> is in the way.</li></ol>
-
+but can't publish, because Bob's <code>foo</code> is in the way.</li>
+</ol>
<p>The validity of Joe's claim in each situation can be debated. However,
Joe's appropriate course of action in each case is the same.</p>
-
-<ol><li><code>npm owner ls foo</code>. This will tell Joe the email address of the
-owner (Bob).</li><li>Joe emails Bob, explaining the situation <strong>as respectfully as
+<ol>
+<li><code>npm owner ls foo</code>. This will tell Joe the email address of the
+owner (Bob).</li>
+<li>Joe emails Bob, explaining the situation <strong>as respectfully as
possible</strong>, and what he would like to do with the module name. He
-adds the npm support staff <a href="mailto:support@npmjs.com">support@npmjs.com</a> to the CC list of
+adds the npm support staff <a href="mailto:support@npmjs.com">support@npmjs.com</a> to the CC list of
the email. Mention in the email that Bob can run <code>npm owner add
-joe foo</code> to add Joe as an owner of the <code>foo</code> package.</li><li>After a reasonable amount of time, if Bob has not responded, or if
+joe foo</code> to add Joe as an owner of the <code>foo</code> package.</li>
+<li>After a reasonable amount of time, if Bob has not responded, or if
Bob and Joe can't come to any sort of resolution, email support
-<a href="mailto:support@npmjs.com">support@npmjs.com</a> and we'll sort it out. ("Reasonable" is
+<a href="mailto:support@npmjs.com">support@npmjs.com</a> and we'll sort it out. ("Reasonable" is
usually at least 4 weeks, but extra time is allowed around common
-holidays.)</li></ol>
-
-<h2 id="REASONING">REASONING</h2>
-
+holidays.)</li>
+</ol>
+<h2 id="reasoning">REASONING</h2>
<p>In almost every case so far, the parties involved have been able to reach
an amicable resolution without any major intervention. Most people
really do want to be reasonable, and are probably not even aware that
they're in your way.</p>
-
<p>Module ecosystems are most vibrant and powerful when they are as
self-directed as possible. If an admin one day deletes something you
had worked on, then that is going to make most people quite upset,
regardless of the justification. When humans solve their problems by
talking to other humans with respect, everyone has the chance to end up
feeling good about the interaction.</p>
-
-<h2 id="EXCEPTIONS">EXCEPTIONS</h2>
-
+<h2 id="exceptions">EXCEPTIONS</h2>
<p>Some things are not allowed, and will be removed without discussion if
they are brought to the attention of the npm registry admins, including
but not limited to:</p>
-
-<ol><li>Malware (that is, a package designed to exploit or harm the machine on
-which it is installed).</li><li>Violations of copyright or licenses (for example, cloning an
+<ol>
+<li>Malware (that is, a package designed to exploit or harm the machine on
+which it is installed).</li>
+<li>Violations of copyright or licenses (for example, cloning an
MIT-licensed program, and then removing or changing the copyright and
-license statement).</li><li>Illegal content.</li><li>"Squatting" on a package name that you <em>plan</em> to use, but aren't
+license statement).</li>
+<li>Illegal content.</li>
+<li>"Squatting" on a package name that you <em>plan</em> to use, but aren't
actually using. Sorry, I don't care how great the name is, or how
perfect a fit it is for the thing that someday might happen. If
someone wants to use it today, and you're just taking up space with
-an empty tarball, you're going to be evicted.</li><li>Putting empty packages in the registry. Packages must have SOME
+an empty tarball, you're going to be evicted.</li>
+<li>Putting empty packages in the registry. Packages must have SOME
functionality. It can be silly, but it can't be <em>nothing</em>. (See
-also: squatting.)</li><li>Doing weird things with the registry, like using it as your own
+also: squatting.)</li>
+<li>Doing weird things with the registry, like using it as your own
personal application database or otherwise putting non-packagey
-things into it.</li></ol>
-
+things into it.</li>
+</ol>
<p>If you see bad behavior like this, please report it right away.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
+<li><a href="../cli/npm-owner.html">npm-owner(1)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-owner.html">npm-owner(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-disputes — npm@1.4.9</p>
+<p id="footer">npm-disputes — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../misc/npm-faq.html">npm-faq</a></h1> <p>Frequently Asked Questions</p>
-
-<h2 id="Where-can-I-find-these-docs-in-HTML">Where can I find these docs in HTML?</h2>
-
+<h2 id="where-can-i-find-these-docs-in-html-">Where can I find these docs in HTML?</h2>
<p><a href="https://www.npmjs.org/doc/">https://www.npmjs.org/doc/</a>, or run:</p>
-
-<pre><code>npm config set viewer browser</code></pre>
-
-<p>to open these documents in your default web browser rather than <code>man</code>.</p>
-
-<h2 id="It-didn-t-work">It didn't work.</h2>
-
+<pre><code>npm config set viewer browser
+</code></pre><p>to open these documents in your default web browser rather than <code>man</code>.</p>
+<h2 id="it-didn-t-work-">It didn't work.</h2>
<p>That's not really a question.</p>
-
-<h2 id="Why-didn-t-it-work">Why didn't it work?</h2>
-
+<h2 id="why-didn-t-it-work-">Why didn't it work?</h2>
<p>I don't know yet.</p>
-
<p>Read the error output, and if you can't figure out what it means,
do what it says and post a bug with all the information it asks for.</p>
-
-<h2 id="Where-does-npm-put-stuff">Where does npm put stuff?</h2>
-
+<h2 id="where-does-npm-put-stuff-">Where does npm put stuff?</h2>
<p>See <code><a href="../files/npm-folders.html">npm-folders(5)</a></code></p>
-
<p>tl;dr:</p>
-
-<ul><li>Use the <code>npm root</code> command to see where modules go, and the <code>npm bin</code>
-command to see where executables go</li><li>Global installs are different from local installs. If you install
+<ul>
+<li>Use the <code>npm root</code> command to see where modules go, and the <code>npm bin</code>
+command to see where executables go</li>
+<li>Global installs are different from local installs. If you install
something with the <code>-g</code> flag, then its executables go in <code>npm bin -g</code>
-and its modules go in <code>npm root -g</code>.</li></ul>
-
-<h2 id="How-do-I-install-something-on-my-computer-in-a-central-location">How do I install something on my computer in a central location?</h2>
-
+and its modules go in <code>npm root -g</code>.</li>
+</ul>
+<h2 id="how-do-i-install-something-on-my-computer-in-a-central-location-">How do I install something on my computer in a central location?</h2>
<p>Install it globally by tacking <code>-g</code> or <code>--global</code> to the command. (This
is especially important for command line utilities that need to add
their bins to the global system <code>PATH</code>.)</p>
-
-<h2 id="I-installed-something-globally-but-I-can-t-require-it">I installed something globally, but I can't <code>require()</code> it</h2>
-
+<h2 id="i-installed-something-globally-but-i-can-t-require-it">I installed something globally, but I can't <code>require()</code> it</h2>
<p>Install it locally.</p>
-
<p>The global install location is a place for command-line utilities
to put their bins in the system <code>PATH</code>. It's not for use with <code>require()</code>.</p>
-
<p>If you <code>require()</code> a module in your code, then that means it's a
dependency, and a part of your program. You need to install it locally
in your program.</p>
-
-<h2 id="Why-can-t-npm-just-put-everything-in-one-place-like-other-package-managers">Why can't npm just put everything in one place, like other package managers?</h2>
-
+<h2 id="why-can-t-npm-just-put-everything-in-one-place-like-other-package-managers-">Why can't npm just put everything in one place, like other package managers?</h2>
<p>Not every change is an improvement, but every improvement is a change.
This would be like asking git to do network IO for every commit. It's
not going to happen, because it's a terrible idea that causes more
problems than it solves.</p>
-
<p>It is much harder to avoid dependency conflicts without nesting
dependencies. This is fundamental to the way that npm works, and has
proven to be an extremely successful approach. See <code><a href="../files/npm-folders.html">npm-folders(5)</a></code> for
more details.</p>
-
<p>If you want a package to be installed in one place, and have all your
programs reference the same copy of it, then use the <code>npm link</code> command.
That's what it's for. Install it globally, then link it into each
program that uses it.</p>
-
-<h2 id="Whatever-I-really-want-the-old-style-everything-global-style">Whatever, I really want the old style 'everything global' style.</h2>
-
+<h2 id="whatever-i-really-want-the-old-style-everything-global-style-">Whatever, I really want the old style 'everything global' style.</h2>
<p>Write your own package manager. You could probably even wrap up <code>npm</code>
in a shell script if you really wanted to.</p>
-
<p>npm will not help you do something that is known to be a bad idea.</p>
-
-<h2 id="Should-I-check-my-node_modules-folder-into-git">Should I check my <code>node_modules</code> folder into git?</h2>
-
+<h2 id="should-i-check-my-node_modules-folder-into-git-">Should I check my <code>node_modules</code> folder into git?</h2>
<p>Mikeal Rogers answered this question very well:</p>
-
<p><a href="http://www.futurealoof.com/posts/nodemodules-in-git.html">http://www.futurealoof.com/posts/nodemodules-in-git.html</a></p>
-
<p>tl;dr</p>
-
-<ul><li>Check <code>node_modules</code> into git for things you <strong>deploy</strong>, such as
-websites and apps.</li><li>Do not check <code>node_modules</code> into git for libraries and modules
-intended to be reused.</li><li>Use npm to manage dependencies in your dev environment, but not in
-your deployment scripts.</li></ul>
-
-<h2 id="Is-it-npm-or-NPM-or-Npm">Is it 'npm' or 'NPM' or 'Npm'?</h2>
-
+<ul>
+<li>Check <code>node_modules</code> into git for things you <strong>deploy</strong>, such as
+websites and apps.</li>
+<li>Do not check <code>node_modules</code> into git for libraries and modules
+intended to be reused.</li>
+<li>Use npm to manage dependencies in your dev environment, but not in
+your deployment scripts.</li>
+</ul>
+<h2 id="is-it-npm-or-npm-or-npm-">Is it 'npm' or 'NPM' or 'Npm'?</h2>
<p>npm should never be capitalized unless it is being displayed in a
location that is customarily all-caps (such as the title of man pages.)</p>
-
-<h2 id="If-npm-is-an-acronym-why-is-it-never-capitalized">If 'npm' is an acronym, why is it never capitalized?</h2>
-
+<h2 id="if-npm-is-an-acronym-why-is-it-never-capitalized-">If 'npm' is an acronym, why is it never capitalized?</h2>
<p>Contrary to the belief of many, "npm" is not in fact an abbreviation for
"Node Package Manager". It is a recursive bacronymic abbreviation for
"npm is not an acronym". (If it was "ninaa", then it would be an
acronym, and thus incorrectly named.)</p>
-
<p>"NPM", however, <em>is</em> an acronym (more precisely, a capitonym) for the
National Association of Pastoral Musicians. You can learn more
about them at <a href="http://npm.org/">http://npm.org/</a>.</p>
-
<p>In software, "NPM" is a Non-Parametric Mapping utility written by
Chris Rorden. You can analyze pictures of brains with it. Learn more
about the (capitalized) NPM program at <a href="http://www.cabiatl.com/mricro/npm/">http://www.cabiatl.com/mricro/npm/</a>.</p>
-
<p>The first seed that eventually grew into this flower was a bash utility
named "pm", which was a shortened descendent of "pkgmakeinst", a
bash function that was used to install various different things on different
platforms, most often using Yahoo's <code>yinst</code>. If <code>npm</code> was ever an
acronym for anything, it was <code>node pm</code> or maybe <code>new pm</code>.</p>
-
<p>So, in all seriousness, the "npm" project is named after its command-line
utility, which was organically selected to be easily typed by a right-handed
programmer using a US QWERTY keyboard layout, ending with the
right-ring-finger in a postition to type the <code>-</code> key for flags and
other command-line arguments. That command-line utility is always
lower-case, though it starts most sentences it is a part of.</p>
-
-<h2 id="How-do-I-list-installed-packages">How do I list installed packages?</h2>
-
+<h2 id="how-do-i-list-installed-packages-">How do I list installed packages?</h2>
<p><code>npm ls</code></p>
-
-<h2 id="How-do-I-search-for-packages">How do I search for packages?</h2>
-
+<h2 id="how-do-i-search-for-packages-">How do I search for packages?</h2>
<p><code>npm search</code></p>
-
<p>Arguments are greps. <code>npm search jsdom</code> shows jsdom packages.</p>
-
-<h2 id="How-do-I-update-npm">How do I update npm?</h2>
-
-<pre><code>npm update npm -g</code></pre>
-
-<p>You can also update all outdated local packages by doing <code>npm update</code> without
+<h2 id="how-do-i-update-npm-">How do I update npm?</h2>
+<pre><code>npm update npm -g
+</code></pre><p>You can also update all outdated local packages by doing <code>npm update</code> without
any arguments, or global packages by doing <code>npm update -g</code>.</p>
-
<p>Occasionally, the version of npm will progress such that the current
version cannot be properly installed with the version that you have
installed already. (Consider, if there is ever a bug in the <code>update</code>
command.)</p>
-
<p>In those cases, you can do this:</p>
-
-<pre><code>curl https://www.npmjs.org/install.sh | sh</code></pre>
-
-<h2 id="What-is-a-package">What is a <code>package</code>?</h2>
-
+<pre><code>curl https://www.npmjs.org/install.sh | sh
+</code></pre><h2 id="what-is-a-package-">What is a <code>package</code>?</h2>
<p>A package is:</p>
-
-<ul><li>a) a folder containing a program described by a package.json file</li><li>b) a gzipped tarball containing (a)</li><li>c) a url that resolves to (b)</li><li>d) a <code><name>@<version></code> that is published on the registry with (c)</li><li>e) a <code><name>@<tag></code> that points to (d)</li><li>f) a <code><name></code> that has a "latest" tag satisfying (e)</li><li>g) a <code>git</code> url that, when cloned, results in (a).</li></ul>
-
+<ul>
+<li>a) a folder containing a program described by a package.json file</li>
+<li>b) a gzipped tarball containing (a)</li>
+<li>c) a url that resolves to (b)</li>
+<li>d) a <code><name>@<version></code> that is published on the registry with (c)</li>
+<li>e) a <code><name>@<tag></code> that points to (d)</li>
+<li>f) a <code><name></code> that has a "latest" tag satisfying (e)</li>
+<li>g) a <code>git</code> url that, when cloned, results in (a).</li>
+</ul>
<p>Even if you never publish your package, you can still get a lot of
benefits of using npm if you just want to write a node program (a), and
perhaps if you also want to be able to easily install it elsewhere
after packing it up into a tarball (b).</p>
-
<p>Git urls can be of the form:</p>
-
<pre><code>git://github.com/user/project.git#commit-ish
git+ssh://user@hostname:project.git#commit-ish
git+http://user@hostname/project/blah.git#commit-ish
-git+https://user@hostname/project/blah.git#commit-ish</code></pre>
-
-<p>The <code>commit-ish</code> can be any tag, sha, or branch which can be supplied as
+git+https://user@hostname/project/blah.git#commit-ish
+</code></pre><p>The <code>commit-ish</code> can be any tag, sha, or branch which can be supplied as
an argument to <code>git checkout</code>. The default is <code>master</code>.</p>
-
-<h2 id="What-is-a-module">What is a <code>module</code>?</h2>
-
+<h2 id="what-is-a-module-">What is a <code>module</code>?</h2>
<p>A module is anything that can be loaded with <code>require()</code> in a Node.js
program. The following things are all examples of things that can be
loaded as modules:</p>
-
-<ul><li>A folder with a <code>package.json</code> file containing a <code>main</code> field.</li><li>A folder with an <code>index.js</code> file in it.</li><li>A JavaScript file.</li></ul>
-
+<ul>
+<li>A folder with a <code>package.json</code> file containing a <code>main</code> field.</li>
+<li>A folder with an <code>index.js</code> file in it.</li>
+<li>A JavaScript file.</li>
+</ul>
<p>Most npm packages are modules, because they are libraries that you
load with <code>require</code>. However, there's no requirement that an npm
package be a module! Some only contain an executable command-line
interface, and don't provide a <code>main</code> field for use in Node programs.</p>
-
<p>Almost all npm packages (at least, those that are Node programs)
<em>contain</em> many modules within them (because every file they load with
<code>require()</code> is a module).</p>
-
<p>In the context of a Node program, the <code>module</code> is also the thing that
was loaded <em>from</em> a file. For example, in the following program:</p>
-
-<pre><code>var req = require('request')</code></pre>
-
-<p>we might say that "The variable <code>req</code> refers to the <code>request</code> module".</p>
-
-<h2 id="So-why-is-it-the-node_modules-folder-but-package-json-file-Why-not-node_packages-or-module-json">So, why is it the "<code>node_modules</code>" folder, but "<code>package.json</code>" file? Why not <code>node_packages</code> or <code>module.json</code>?</h2>
-
+<pre><code>var req = require('request')
+</code></pre><p>we might say that "The variable <code>req</code> refers to the <code>request</code> module".</p>
+<h2 id="so-why-is-it-the-node_modules-folder-but-package-json-file-why-not-node_packages-or-module-json-">So, why is it the "<code>node_modules</code>" folder, but "<code>package.json</code>" file? Why not <code>node_packages</code> or <code>module.json</code>?</h2>
<p>The <code>package.json</code> file defines the package. (See "What is a
package?" above.)</p>
-
<p>The <code>node_modules</code> folder is the place Node.js looks for modules.
(See "What is a module?" above.)</p>
-
<p>For example, if you create a file at <code>node_modules/foo.js</code> and then
had a program that did <code>var f = require('foo.js')</code> then it would load
the module. However, <code>foo.js</code> is not a "package" in this case,
because it does not have a package.json.</p>
-
<p>Alternatively, if you create a package which does not have an
<code>index.js</code> or a <code>"main"</code> field in the <code>package.json</code> file, then it is
not a module. Even if it's installed in <code>node_modules</code>, it can't be
an argument to <code>require()</code>.</p>
-
-<h2 id="node_modules-is-the-name-of-my-deity-s-arch-rival-and-a-Forbidden-Word-in-my-religion-Can-I-configure-npm-to-use-a-different-folder"><code>"node_modules"</code> is the name of my deity's arch-rival, and a Forbidden Word in my religion. Can I configure npm to use a different folder?</h2>
-
+<h2 id="-node_modules-is-the-name-of-my-deity-s-arch-rival-and-a-forbidden-word-in-my-religion-can-i-configure-npm-to-use-a-different-folder-"><code>"node_modules"</code> is the name of my deity's arch-rival, and a Forbidden Word in my religion. Can I configure npm to use a different folder?</h2>
<p>No. This will never happen. This question comes up sometimes,
because it seems silly from the outside that npm couldn't just be
configured to put stuff somewhere else, and then npm could load them
from there. It's an arbitrary spelling choice, right? What's the big
deal?</p>
-
<p>At the time of this writing, the string <code>'node_modules'</code> appears 151
times in 53 separate files in npm and node core (excluding tests and
documentation).</p>
-
<p>Some of these references are in node's built-in module loader. Since
npm is not involved <strong>at all</strong> at run-time, node itself would have to
be configured to know where you've decided to stick stuff. Complexity
hurdle #1. Since the Node module system is locked, this cannot be
changed, and is enough to kill this request. But I'll continue, in
deference to your deity's delicate feelings regarding spelling.</p>
-
<p>Many of the others are in dependencies that npm uses, which are not
necessarily tightly coupled to npm (in the sense that they do not read
npm's configuration files, etc.) Each of these would have to be
configured to take the name of the <code>node_modules</code> folder as a
parameter. Complexity hurdle #2.</p>
-
<p>Furthermore, npm has the ability to "bundle" dependencies by adding
the dep names to the <code>"bundledDependencies"</code> list in package.json,
which causes the folder to be included in the package tarball. What
different spelling for <code>node_modules</code>? npm would have to rename the
folder at publish time, and then be smart enough to unpack it using
your locally configured name. Complexity hurdle #3.</p>
-
<p>Furthermore, what happens when you <em>change</em> this name? Fine, it's
easy enough the first time, just rename the <code>node_modules</code> folders to
<code>./blergyblerp/</code> or whatever name you choose. But what about when you
properly. It would have to track every previous value for this
config, and always accept any of them, or else yesterday's install may
be broken tomorrow. Complexity hurdle #5.</p>
-
<p>Never going to happen. The folder is named <code>node_modules</code>. It is
written indelibly in the Node Way, handed down from the ancient times
of Node 0.3.</p>
-
-<h2 id="How-do-I-install-node-with-npm">How do I install node with npm?</h2>
-
+<h2 id="how-do-i-install-node-with-npm-">How do I install node with npm?</h2>
<p>You don't. Try one of these node version managers:</p>
-
<p>Unix:</p>
-
-<ul><li><a href="http://github.com/isaacs/nave">http://github.com/isaacs/nave</a></li><li><a href="http://github.com/visionmedia/n">http://github.com/visionmedia/n</a></li><li><a href="http://github.com/creationix/nvm">http://github.com/creationix/nvm</a></li></ul>
-
+<ul>
+<li><a href="http://github.com/isaacs/nave">http://github.com/isaacs/nave</a></li>
+<li><a href="http://github.com/visionmedia/n">http://github.com/visionmedia/n</a></li>
+<li><a href="http://github.com/creationix/nvm">http://github.com/creationix/nvm</a></li>
+</ul>
<p>Windows:</p>
-
-<ul><li><a href="http://github.com/marcelklehr/nodist">http://github.com/marcelklehr/nodist</a></li><li><a href="https://github.com/hakobera/nvmw">https://github.com/hakobera/nvmw</a></li><li><a href="https://github.com/nanjingboy/nvmw">https://github.com/nanjingboy/nvmw</a></li></ul>
-
-<h2 id="How-can-I-use-npm-for-development">How can I use npm for development?</h2>
-
+<ul>
+<li><a href="http://github.com/marcelklehr/nodist">http://github.com/marcelklehr/nodist</a></li>
+<li><a href="https://github.com/hakobera/nvmw">https://github.com/hakobera/nvmw</a></li>
+<li><a href="https://github.com/nanjingboy/nvmw">https://github.com/nanjingboy/nvmw</a></li>
+</ul>
+<h2 id="how-can-i-use-npm-for-development-">How can I use npm for development?</h2>
<p>See <code><a href="../misc/npm-developers.html">npm-developers(7)</a></code> and <code><a href="../files/package.json.html">package.json(5)</a></code>.</p>
-
<p>You'll most likely want to <code>npm link</code> your development folder. That's
awesomely handy.</p>
-
<p>To set up your own private registry, check out <code><a href="../misc/npm-registry.html">npm-registry(7)</a></code>.</p>
-
-<h2 id="Can-I-list-a-url-as-a-dependency">Can I list a url as a dependency?</h2>
-
+<h2 id="can-i-list-a-url-as-a-dependency-">Can I list a url as a dependency?</h2>
<p>Yes. It should be a url to a gzipped tarball containing a single folder
that has a package.json in its root, or a git url.
(See "what is a package?" above.)</p>
-
-<h2 id="How-do-I-symlink-to-a-dev-folder-so-I-don-t-have-to-keep-re-installing">How do I symlink to a dev folder so I don't have to keep re-installing?</h2>
-
+<h2 id="how-do-i-symlink-to-a-dev-folder-so-i-don-t-have-to-keep-re-installing-">How do I symlink to a dev folder so I don't have to keep re-installing?</h2>
<p>See <code><a href="../cli/npm-link.html">npm-link(1)</a></code></p>
-
-<h2 id="The-package-registry-website-What-is-that-exactly">The package registry website. What is that exactly?</h2>
-
+<h2 id="the-package-registry-website-what-is-that-exactly-">The package registry website. What is that exactly?</h2>
<p>See <code><a href="../misc/npm-registry.html">npm-registry(7)</a></code>.</p>
-
-<h2 id="I-forgot-my-password-and-can-t-publish-How-do-I-reset-it">I forgot my password, and can't publish. How do I reset it?</h2>
-
+<h2 id="i-forgot-my-password-and-can-t-publish-how-do-i-reset-it-">I forgot my password, and can't publish. How do I reset it?</h2>
<p>Go to <a href="https://npmjs.org/forgot">https://npmjs.org/forgot</a>.</p>
-
-<h2 id="I-get-ECONNREFUSED-a-lot-What-s-up">I get ECONNREFUSED a lot. What's up?</h2>
-
+<h2 id="i-get-econnrefused-a-lot-what-s-up-">I get ECONNREFUSED a lot. What's up?</h2>
<p>Either the registry is down, or node's DNS isn't able to reach out.</p>
-
<p>To check if the registry is down, open up
<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a> in a web browser. This will also tell
you if you are just unable to access the internet for some reason.</p>
-
-<p>If the registry IS down, let us know by emailing <a href="mailto:support@npmjs.com">support@npmjs.com</a>
+<p>If the registry IS down, let us know by emailing <a href="mailto:support@npmjs.com">support@npmjs.com</a>
or posting an issue at <a href="https://github.com/npm/npm/issues">https://github.com/npm/npm/issues</a>. If it's
down for the world (and not just on your local network) then we're
probably already being pinged about it.</p>
-
<p>You can also often get a faster response by visiting the #npm channel
on Freenode IRC.</p>
-
-<h2 id="Why-no-namespaces">Why no namespaces?</h2>
-
+<h2 id="why-no-namespaces-">Why no namespaces?</h2>
<p>Please see this discussion: <a href="https://github.com/npm/npm/issues/798">https://github.com/npm/npm/issues/798</a></p>
-
<p>tl;dr - It doesn't actually make things better, and can make them worse.</p>
-
<p>If you want to namespace your own packages, you may: simply use the
<code>-</code> character to separate the names. npm is a mostly anarchic system.
There is not sufficient need to impose namespace rules on everyone.</p>
-
-<h2 id="Who-does-npm">Who does npm?</h2>
-
+<h2 id="who-does-npm-">Who does npm?</h2>
<p>npm was originally written by Isaac Z. Schlueter, and many others have
contributed to it, some of them quite substantially.</p>
-
<p>The npm open source project, The npm Registry, and <a href="https://www.npmjs.org">the community
website</a> are maintained and operated by the
good folks at <a href="https://www.npmjs.com">npm, Inc.</a></p>
-
-<h2 id="I-have-a-question-or-request-not-addressed-here-Where-should-I-put-it">I have a question or request not addressed here. Where should I put it?</h2>
-
+<h2 id="i-have-a-question-or-request-not-addressed-here-where-should-i-put-it-">I have a question or request not addressed here. Where should I put it?</h2>
<p>Post an issue on the github project:</p>
-
-<ul><li><a href="https://github.com/npm/npm/issues">https://github.com/npm/npm/issues</a></li></ul>
-
-<h2 id="Why-does-npm-hate-me">Why does npm hate me?</h2>
-
+<ul>
+<li><a href="https://github.com/npm/npm/issues">https://github.com/npm/npm/issues</a></li>
+</ul>
+<h2 id="why-does-npm-hate-me-">Why does npm hate me?</h2>
<p>npm is not capable of hatred. It loves everyone, especially you.</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm.html">npm(1)</a></li>
+<li><a href="../misc/npm-developers.html">npm-developers(7)</a></li>
+<li><a href="../files/package.json.html">package.json(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>
+<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
+<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../cli/npm.html">npm(1)</a></li><li><a href="../misc/npm-developers.html">npm-developers(7)</a></li><li><a href="../files/package.json.html">package.json(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><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-faq — npm@1.4.9</p>
+<p id="footer">npm-faq — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../misc/npm-index.html">npm-index</a></h1> <p>Index of all npm documentation</p>
-
-<h2 id="README-1"><a href="../../doc/README.html">README</a></h2>
-
+<h2 id="readme-1-"><a href="../../doc/README.html">README</a></h2>
<p>node package manager</p>
-
-<h1>Command Line Documentation</h1>
-
-<h2 id="npm-1"><a href="../cli/npm.html">npm(1)</a></h2>
-
+<h1 id="command-line-documentation">Command Line Documentation</h1>
+<h2 id="npm-1-"><a href="../cli/npm.html">npm(1)</a></h2>
<p>node package manager</p>
-
-<h2 id="npm-adduser-1"><a href="../cli/npm-adduser.html">npm-adduser(1)</a></h2>
-
+<h2 id="npm-adduser-1-"><a href="../cli/npm-adduser.html">npm-adduser(1)</a></h2>
<p>Add a registry user account</p>
-
-<h2 id="npm-bin-1"><a href="../cli/npm-bin.html">npm-bin(1)</a></h2>
-
+<h2 id="npm-bin-1-"><a href="../cli/npm-bin.html">npm-bin(1)</a></h2>
<p>Display npm bin folder</p>
-
-<h2 id="npm-bugs-1"><a href="../cli/npm-bugs.html">npm-bugs(1)</a></h2>
-
+<h2 id="npm-bugs-1-"><a href="../cli/npm-bugs.html">npm-bugs(1)</a></h2>
<p>Bugs for a package in a web browser maybe</p>
-
-<h2 id="npm-build-1"><a href="../cli/npm-build.html">npm-build(1)</a></h2>
-
+<h2 id="npm-build-1-"><a href="../cli/npm-build.html">npm-build(1)</a></h2>
<p>Build a package</p>
-
-<h2 id="npm-bundle-1"><a href="../cli/npm-bundle.html">npm-bundle(1)</a></h2>
-
+<h2 id="npm-bundle-1-"><a href="../cli/npm-bundle.html">npm-bundle(1)</a></h2>
<p>REMOVED</p>
-
-<h2 id="npm-cache-1"><a href="../cli/npm-cache.html">npm-cache(1)</a></h2>
-
+<h2 id="npm-cache-1-"><a href="../cli/npm-cache.html">npm-cache(1)</a></h2>
<p>Manipulates packages cache</p>
-
-<h2 id="npm-completion-1"><a href="../cli/npm-completion.html">npm-completion(1)</a></h2>
-
+<h2 id="npm-completion-1-"><a href="../cli/npm-completion.html">npm-completion(1)</a></h2>
<p>Tab Completion for npm</p>
-
-<h2 id="npm-config-1"><a href="../cli/npm-config.html">npm-config(1)</a></h2>
-
+<h2 id="npm-config-1-"><a href="../cli/npm-config.html">npm-config(1)</a></h2>
<p>Manage the npm configuration files</p>
-
-<h2 id="npm-dedupe-1"><a href="../cli/npm-dedupe.html">npm-dedupe(1)</a></h2>
-
+<h2 id="npm-dedupe-1-"><a href="../cli/npm-dedupe.html">npm-dedupe(1)</a></h2>
<p>Reduce duplication</p>
-
-<h2 id="npm-deprecate-1"><a href="../cli/npm-deprecate.html">npm-deprecate(1)</a></h2>
-
+<h2 id="npm-deprecate-1-"><a href="../cli/npm-deprecate.html">npm-deprecate(1)</a></h2>
<p>Deprecate a version of a package</p>
-
-<h2 id="npm-docs-1"><a href="../cli/npm-docs.html">npm-docs(1)</a></h2>
-
+<h2 id="npm-docs-1-"><a href="../cli/npm-docs.html">npm-docs(1)</a></h2>
<p>Docs for a package in a web browser maybe</p>
-
-<h2 id="npm-edit-1"><a href="../cli/npm-edit.html">npm-edit(1)</a></h2>
-
+<h2 id="npm-edit-1-"><a href="../cli/npm-edit.html">npm-edit(1)</a></h2>
<p>Edit an installed package</p>
-
-<h2 id="npm-explore-1"><a href="../cli/npm-explore.html">npm-explore(1)</a></h2>
-
+<h2 id="npm-explore-1-"><a href="../cli/npm-explore.html">npm-explore(1)</a></h2>
<p>Browse an installed package</p>
-
-<h2 id="npm-help-search-1"><a href="../cli/npm-help-search.html">npm-help-search(1)</a></h2>
-
+<h2 id="npm-help-search-1-"><a href="../cli/npm-help-search.html">npm-help-search(1)</a></h2>
<p>Search npm help documentation</p>
-
-<h2 id="npm-help-1"><a href="../cli/npm-help.html">npm-help(1)</a></h2>
-
+<h2 id="npm-help-1-"><a href="../cli/npm-help.html">npm-help(1)</a></h2>
<p>Get help on npm</p>
-
-<h2 id="npm-init-1"><a href="../cli/npm-init.html">npm-init(1)</a></h2>
-
+<h2 id="npm-init-1-"><a href="../cli/npm-init.html">npm-init(1)</a></h2>
<p>Interactively create a package.json file</p>
-
-<h2 id="npm-install-1"><a href="../cli/npm-install.html">npm-install(1)</a></h2>
-
+<h2 id="npm-install-1-"><a href="../cli/npm-install.html">npm-install(1)</a></h2>
<p>Install a package</p>
-
-<h2 id="npm-link-1"><a href="../cli/npm-link.html">npm-link(1)</a></h2>
-
+<h2 id="npm-link-1-"><a href="../cli/npm-link.html">npm-link(1)</a></h2>
<p>Symlink a package folder</p>
-
-<h2 id="npm-ls-1"><a href="../cli/npm-ls.html">npm-ls(1)</a></h2>
-
+<h2 id="npm-ls-1-"><a href="../cli/npm-ls.html">npm-ls(1)</a></h2>
<p>List installed packages</p>
-
-<h2 id="npm-outdated-1"><a href="../cli/npm-outdated.html">npm-outdated(1)</a></h2>
-
+<h2 id="npm-outdated-1-"><a href="../cli/npm-outdated.html">npm-outdated(1)</a></h2>
<p>Check for outdated packages</p>
-
-<h2 id="npm-owner-1"><a href="../cli/npm-owner.html">npm-owner(1)</a></h2>
-
+<h2 id="npm-owner-1-"><a href="../cli/npm-owner.html">npm-owner(1)</a></h2>
<p>Manage package owners</p>
-
-<h2 id="npm-pack-1"><a href="../cli/npm-pack.html">npm-pack(1)</a></h2>
-
+<h2 id="npm-pack-1-"><a href="../cli/npm-pack.html">npm-pack(1)</a></h2>
<p>Create a tarball from a package</p>
-
-<h2 id="npm-prefix-1"><a href="../cli/npm-prefix.html">npm-prefix(1)</a></h2>
-
+<h2 id="npm-prefix-1-"><a href="../cli/npm-prefix.html">npm-prefix(1)</a></h2>
<p>Display prefix</p>
-
-<h2 id="npm-prune-1"><a href="../cli/npm-prune.html">npm-prune(1)</a></h2>
-
+<h2 id="npm-prune-1-"><a href="../cli/npm-prune.html">npm-prune(1)</a></h2>
<p>Remove extraneous packages</p>
-
-<h2 id="npm-publish-1"><a href="../cli/npm-publish.html">npm-publish(1)</a></h2>
-
+<h2 id="npm-publish-1-"><a href="../cli/npm-publish.html">npm-publish(1)</a></h2>
<p>Publish a package</p>
-
-<h2 id="npm-rebuild-1"><a href="../cli/npm-rebuild.html">npm-rebuild(1)</a></h2>
-
+<h2 id="npm-rebuild-1-"><a href="../cli/npm-rebuild.html">npm-rebuild(1)</a></h2>
<p>Rebuild a package</p>
-
-<h2 id="npm-repo-1"><a href="../cli/npm-repo.html">npm-repo(1)</a></h2>
-
+<h2 id="npm-repo-1-"><a href="../cli/npm-repo.html">npm-repo(1)</a></h2>
<p>Open package repository page in the browser</p>
-
-<h2 id="npm-restart-1"><a href="../cli/npm-restart.html">npm-restart(1)</a></h2>
-
+<h2 id="npm-restart-1-"><a href="../cli/npm-restart.html">npm-restart(1)</a></h2>
<p>Start a package</p>
-
-<h2 id="npm-rm-1"><a href="../cli/npm-rm.html">npm-rm(1)</a></h2>
-
+<h2 id="npm-rm-1-"><a href="../cli/npm-rm.html">npm-rm(1)</a></h2>
<p>Remove a package</p>
-
-<h2 id="npm-root-1"><a href="../cli/npm-root.html">npm-root(1)</a></h2>
-
+<h2 id="npm-root-1-"><a href="../cli/npm-root.html">npm-root(1)</a></h2>
<p>Display npm root</p>
-
-<h2 id="npm-run-script-1"><a href="../cli/npm-run-script.html">npm-run-script(1)</a></h2>
-
+<h2 id="npm-run-script-1-"><a href="../cli/npm-run-script.html">npm-run-script(1)</a></h2>
<p>Run arbitrary package scripts</p>
-
-<h2 id="npm-search-1"><a href="../cli/npm-search.html">npm-search(1)</a></h2>
-
+<h2 id="npm-search-1-"><a href="../cli/npm-search.html">npm-search(1)</a></h2>
<p>Search for packages</p>
-
-<h2 id="npm-shrinkwrap-1"><a href="../cli/npm-shrinkwrap.html">npm-shrinkwrap(1)</a></h2>
-
+<h2 id="npm-shrinkwrap-1-"><a href="../cli/npm-shrinkwrap.html">npm-shrinkwrap(1)</a></h2>
<p>Lock down dependency versions</p>
-
-<h2 id="npm-star-1"><a href="../cli/npm-star.html">npm-star(1)</a></h2>
-
+<h2 id="npm-star-1-"><a href="../cli/npm-star.html">npm-star(1)</a></h2>
<p>Mark your favorite packages</p>
-
-<h2 id="npm-stars-1"><a href="../cli/npm-stars.html">npm-stars(1)</a></h2>
-
+<h2 id="npm-stars-1-"><a href="../cli/npm-stars.html">npm-stars(1)</a></h2>
<p>View packages marked as favorites</p>
-
-<h2 id="npm-start-1"><a href="../cli/npm-start.html">npm-start(1)</a></h2>
-
+<h2 id="npm-start-1-"><a href="../cli/npm-start.html">npm-start(1)</a></h2>
<p>Start a package</p>
-
-<h2 id="npm-stop-1"><a href="../cli/npm-stop.html">npm-stop(1)</a></h2>
-
+<h2 id="npm-stop-1-"><a href="../cli/npm-stop.html">npm-stop(1)</a></h2>
<p>Stop a package</p>
-
-<h2 id="npm-submodule-1"><a href="../cli/npm-submodule.html">npm-submodule(1)</a></h2>
-
+<h2 id="npm-submodule-1-"><a href="../cli/npm-submodule.html">npm-submodule(1)</a></h2>
<p>Add a package as a git submodule</p>
-
-<h2 id="npm-tag-1"><a href="../cli/npm-tag.html">npm-tag(1)</a></h2>
-
+<h2 id="npm-tag-1-"><a href="../cli/npm-tag.html">npm-tag(1)</a></h2>
<p>Tag a published version</p>
-
-<h2 id="npm-test-1"><a href="../cli/npm-test.html">npm-test(1)</a></h2>
-
+<h2 id="npm-test-1-"><a href="../cli/npm-test.html">npm-test(1)</a></h2>
<p>Test a package</p>
-
-<h2 id="npm-uninstall-1"><a href="../cli/npm-uninstall.html">npm-uninstall(1)</a></h2>
-
+<h2 id="npm-uninstall-1-"><a href="../cli/npm-uninstall.html">npm-uninstall(1)</a></h2>
<p>Remove a package</p>
-
-<h2 id="npm-unpublish-1"><a href="../cli/npm-unpublish.html">npm-unpublish(1)</a></h2>
-
+<h2 id="npm-unpublish-1-"><a href="../cli/npm-unpublish.html">npm-unpublish(1)</a></h2>
<p>Remove a package from the registry</p>
-
-<h2 id="npm-update-1"><a href="../cli/npm-update.html">npm-update(1)</a></h2>
-
+<h2 id="npm-update-1-"><a href="../cli/npm-update.html">npm-update(1)</a></h2>
<p>Update a package</p>
-
-<h2 id="npm-version-1"><a href="../cli/npm-version.html">npm-version(1)</a></h2>
-
+<h2 id="npm-version-1-"><a href="../cli/npm-version.html">npm-version(1)</a></h2>
<p>Bump a package version</p>
-
-<h2 id="npm-view-1"><a href="../cli/npm-view.html">npm-view(1)</a></h2>
-
+<h2 id="npm-view-1-"><a href="../cli/npm-view.html">npm-view(1)</a></h2>
<p>View registry info</p>
-
-<h2 id="npm-whoami-1"><a href="../cli/npm-whoami.html">npm-whoami(1)</a></h2>
-
+<h2 id="npm-whoami-1-"><a href="../cli/npm-whoami.html">npm-whoami(1)</a></h2>
<p>Display npm username</p>
-
-<h1>API Documentation</h1>
-
-<h2 id="npm-3"><a href="../api/npm.html">npm(3)</a></h2>
-
+<h1 id="api-documentation">API Documentation</h1>
+<h2 id="npm-3-"><a href="../api/npm.html">npm(3)</a></h2>
<p>node package manager</p>
-
-<h2 id="npm-bin-3"><a href="../api/npm-bin.html">npm-bin(3)</a></h2>
-
+<h2 id="npm-bin-3-"><a href="../api/npm-bin.html">npm-bin(3)</a></h2>
<p>Display npm bin folder</p>
-
-<h2 id="npm-bugs-3"><a href="../api/npm-bugs.html">npm-bugs(3)</a></h2>
-
+<h2 id="npm-bugs-3-"><a href="../api/npm-bugs.html">npm-bugs(3)</a></h2>
<p>Bugs for a package in a web browser maybe</p>
-
-<h2 id="npm-commands-3"><a href="../api/npm-commands.html">npm-commands(3)</a></h2>
-
+<h2 id="npm-commands-3-"><a href="../api/npm-commands.html">npm-commands(3)</a></h2>
<p>npm commands</p>
-
-<h2 id="npm-config-3"><a href="../api/npm-config.html">npm-config(3)</a></h2>
-
+<h2 id="npm-config-3-"><a href="../api/npm-config.html">npm-config(3)</a></h2>
<p>Manage the npm configuration files</p>
-
-<h2 id="npm-deprecate-3"><a href="../api/npm-deprecate.html">npm-deprecate(3)</a></h2>
-
+<h2 id="npm-deprecate-3-"><a href="../api/npm-deprecate.html">npm-deprecate(3)</a></h2>
<p>Deprecate a version of a package</p>
-
-<h2 id="npm-docs-3"><a href="../api/npm-docs.html">npm-docs(3)</a></h2>
-
+<h2 id="npm-docs-3-"><a href="../api/npm-docs.html">npm-docs(3)</a></h2>
<p>Docs for a package in a web browser maybe</p>
-
-<h2 id="npm-edit-3"><a href="../api/npm-edit.html">npm-edit(3)</a></h2>
-
+<h2 id="npm-edit-3-"><a href="../api/npm-edit.html">npm-edit(3)</a></h2>
<p>Edit an installed package</p>
-
-<h2 id="npm-explore-3"><a href="../api/npm-explore.html">npm-explore(3)</a></h2>
-
+<h2 id="npm-explore-3-"><a href="../api/npm-explore.html">npm-explore(3)</a></h2>
<p>Browse an installed package</p>
-
-<h2 id="npm-help-search-3"><a href="../api/npm-help-search.html">npm-help-search(3)</a></h2>
-
+<h2 id="npm-help-search-3-"><a href="../api/npm-help-search.html">npm-help-search(3)</a></h2>
<p>Search the help pages</p>
-
-<h2 id="npm-init-3"><a href="../api/npm-init.html">npm-init(3)</a></h2>
-
+<h2 id="npm-init-3-"><a href="../api/npm-init.html">npm-init(3)</a></h2>
<p>Interactively create a package.json file</p>
-
-<h2 id="npm-install-3"><a href="../api/npm-install.html">npm-install(3)</a></h2>
-
+<h2 id="npm-install-3-"><a href="../api/npm-install.html">npm-install(3)</a></h2>
<p>install a package programmatically</p>
-
-<h2 id="npm-link-3"><a href="../api/npm-link.html">npm-link(3)</a></h2>
-
+<h2 id="npm-link-3-"><a href="../api/npm-link.html">npm-link(3)</a></h2>
<p>Symlink a package folder</p>
-
-<h2 id="npm-load-3"><a href="../api/npm-load.html">npm-load(3)</a></h2>
-
+<h2 id="npm-load-3-"><a href="../api/npm-load.html">npm-load(3)</a></h2>
<p>Load config settings</p>
-
-<h2 id="npm-ls-3"><a href="../api/npm-ls.html">npm-ls(3)</a></h2>
-
+<h2 id="npm-ls-3-"><a href="../api/npm-ls.html">npm-ls(3)</a></h2>
<p>List installed packages</p>
-
-<h2 id="npm-outdated-3"><a href="../api/npm-outdated.html">npm-outdated(3)</a></h2>
-
+<h2 id="npm-outdated-3-"><a href="../api/npm-outdated.html">npm-outdated(3)</a></h2>
<p>Check for outdated packages</p>
-
-<h2 id="npm-owner-3"><a href="../api/npm-owner.html">npm-owner(3)</a></h2>
-
+<h2 id="npm-owner-3-"><a href="../api/npm-owner.html">npm-owner(3)</a></h2>
<p>Manage package owners</p>
-
-<h2 id="npm-pack-3"><a href="../api/npm-pack.html">npm-pack(3)</a></h2>
-
+<h2 id="npm-pack-3-"><a href="../api/npm-pack.html">npm-pack(3)</a></h2>
<p>Create a tarball from a package</p>
-
-<h2 id="npm-prefix-3"><a href="../api/npm-prefix.html">npm-prefix(3)</a></h2>
-
+<h2 id="npm-prefix-3-"><a href="../api/npm-prefix.html">npm-prefix(3)</a></h2>
<p>Display prefix</p>
-
-<h2 id="npm-prune-3"><a href="../api/npm-prune.html">npm-prune(3)</a></h2>
-
+<h2 id="npm-prune-3-"><a href="../api/npm-prune.html">npm-prune(3)</a></h2>
<p>Remove extraneous packages</p>
-
-<h2 id="npm-publish-3"><a href="../api/npm-publish.html">npm-publish(3)</a></h2>
-
+<h2 id="npm-publish-3-"><a href="../api/npm-publish.html">npm-publish(3)</a></h2>
<p>Publish a package</p>
-
-<h2 id="npm-rebuild-3"><a href="../api/npm-rebuild.html">npm-rebuild(3)</a></h2>
-
+<h2 id="npm-rebuild-3-"><a href="../api/npm-rebuild.html">npm-rebuild(3)</a></h2>
<p>Rebuild a package</p>
-
-<h2 id="npm-repo-3"><a href="../api/npm-repo.html">npm-repo(3)</a></h2>
-
+<h2 id="npm-repo-3-"><a href="../api/npm-repo.html">npm-repo(3)</a></h2>
<p>Open package repository page in the browser</p>
-
-<h2 id="npm-restart-3"><a href="../api/npm-restart.html">npm-restart(3)</a></h2>
-
+<h2 id="npm-restart-3-"><a href="../api/npm-restart.html">npm-restart(3)</a></h2>
<p>Start a package</p>
-
-<h2 id="npm-root-3"><a href="../api/npm-root.html">npm-root(3)</a></h2>
-
+<h2 id="npm-root-3-"><a href="../api/npm-root.html">npm-root(3)</a></h2>
<p>Display npm root</p>
-
-<h2 id="npm-run-script-3"><a href="../api/npm-run-script.html">npm-run-script(3)</a></h2>
-
+<h2 id="npm-run-script-3-"><a href="../api/npm-run-script.html">npm-run-script(3)</a></h2>
<p>Run arbitrary package scripts</p>
-
-<h2 id="npm-search-3"><a href="../api/npm-search.html">npm-search(3)</a></h2>
-
+<h2 id="npm-search-3-"><a href="../api/npm-search.html">npm-search(3)</a></h2>
<p>Search for packages</p>
-
-<h2 id="npm-shrinkwrap-3"><a href="../api/npm-shrinkwrap.html">npm-shrinkwrap(3)</a></h2>
-
+<h2 id="npm-shrinkwrap-3-"><a href="../api/npm-shrinkwrap.html">npm-shrinkwrap(3)</a></h2>
<p>programmatically generate package shrinkwrap file</p>
-
-<h2 id="npm-start-3"><a href="../api/npm-start.html">npm-start(3)</a></h2>
-
+<h2 id="npm-start-3-"><a href="../api/npm-start.html">npm-start(3)</a></h2>
<p>Start a package</p>
-
-<h2 id="npm-stop-3"><a href="../api/npm-stop.html">npm-stop(3)</a></h2>
-
+<h2 id="npm-stop-3-"><a href="../api/npm-stop.html">npm-stop(3)</a></h2>
<p>Stop a package</p>
-
-<h2 id="npm-submodule-3"><a href="../api/npm-submodule.html">npm-submodule(3)</a></h2>
-
+<h2 id="npm-submodule-3-"><a href="../api/npm-submodule.html">npm-submodule(3)</a></h2>
<p>Add a package as a git submodule</p>
-
-<h2 id="npm-tag-3"><a href="../api/npm-tag.html">npm-tag(3)</a></h2>
-
+<h2 id="npm-tag-3-"><a href="../api/npm-tag.html">npm-tag(3)</a></h2>
<p>Tag a published version</p>
-
-<h2 id="npm-test-3"><a href="../api/npm-test.html">npm-test(3)</a></h2>
-
+<h2 id="npm-test-3-"><a href="../api/npm-test.html">npm-test(3)</a></h2>
<p>Test a package</p>
-
-<h2 id="npm-uninstall-3"><a href="../api/npm-uninstall.html">npm-uninstall(3)</a></h2>
-
+<h2 id="npm-uninstall-3-"><a href="../api/npm-uninstall.html">npm-uninstall(3)</a></h2>
<p>uninstall a package programmatically</p>
-
-<h2 id="npm-unpublish-3"><a href="../api/npm-unpublish.html">npm-unpublish(3)</a></h2>
-
+<h2 id="npm-unpublish-3-"><a href="../api/npm-unpublish.html">npm-unpublish(3)</a></h2>
<p>Remove a package from the registry</p>
-
-<h2 id="npm-update-3"><a href="../api/npm-update.html">npm-update(3)</a></h2>
-
+<h2 id="npm-update-3-"><a href="../api/npm-update.html">npm-update(3)</a></h2>
<p>Update a package</p>
-
-<h2 id="npm-version-3"><a href="../api/npm-version.html">npm-version(3)</a></h2>
-
+<h2 id="npm-version-3-"><a href="../api/npm-version.html">npm-version(3)</a></h2>
<p>Bump a package version</p>
-
-<h2 id="npm-view-3"><a href="../api/npm-view.html">npm-view(3)</a></h2>
-
+<h2 id="npm-view-3-"><a href="../api/npm-view.html">npm-view(3)</a></h2>
<p>View registry info</p>
-
-<h2 id="npm-whoami-3"><a href="../api/npm-whoami.html">npm-whoami(3)</a></h2>
-
+<h2 id="npm-whoami-3-"><a href="../api/npm-whoami.html">npm-whoami(3)</a></h2>
<p>Display npm username</p>
-
-<h1>Files</h1>
-
-<h2 id="npm-folders-5"><a href="../files/npm-folders.html">npm-folders(5)</a></h2>
-
+<h1 id="files">Files</h1>
+<h2 id="npm-folders-5-"><a href="../files/npm-folders.html">npm-folders(5)</a></h2>
<p>Folder Structures Used by npm</p>
-
-<h2 id="npmrc-5"><a href="../files/npmrc.html">npmrc(5)</a></h2>
-
+<h2 id="npmrc-5-"><a href="../files/npmrc.html">npmrc(5)</a></h2>
<p>The npm config files</p>
-
-<h2 id="package-json-5"><a href="../files/package.json.html">package.json(5)</a></h2>
-
+<h2 id="package-json-5-"><a href="../files/package.json.html">package.json(5)</a></h2>
<p>Specifics of npm's package.json handling</p>
-
-<h1>Misc</h1>
-
-<h2 id="npm-coding-style-7"><a href="../misc/npm-coding-style.html">npm-coding-style(7)</a></h2>
-
+<h1 id="misc">Misc</h1>
+<h2 id="npm-coding-style-7-"><a href="../misc/npm-coding-style.html">npm-coding-style(7)</a></h2>
<p>npm's "funny" coding style</p>
-
-<h2 id="npm-config-7"><a href="../misc/npm-config.html">npm-config(7)</a></h2>
-
+<h2 id="npm-config-7-"><a href="../misc/npm-config.html">npm-config(7)</a></h2>
<p>More than you probably want to know about npm configuration</p>
-
-<h2 id="npm-developers-7"><a href="../misc/npm-developers.html">npm-developers(7)</a></h2>
-
+<h2 id="npm-developers-7-"><a href="../misc/npm-developers.html">npm-developers(7)</a></h2>
<p>Developer Guide</p>
-
-<h2 id="npm-disputes-7"><a href="../misc/npm-disputes.html">npm-disputes(7)</a></h2>
-
+<h2 id="npm-disputes-7-"><a href="../misc/npm-disputes.html">npm-disputes(7)</a></h2>
<p>Handling Module Name Disputes</p>
-
-<h2 id="npm-faq-7"><a href="../misc/npm-faq.html">npm-faq(7)</a></h2>
-
+<h2 id="npm-faq-7-"><a href="../misc/npm-faq.html">npm-faq(7)</a></h2>
<p>Frequently Asked Questions</p>
-
-<h2 id="npm-index-7"><a href="../misc/npm-index.html">npm-index(7)</a></h2>
-
+<h2 id="npm-index-7-"><a href="../misc/npm-index.html">npm-index(7)</a></h2>
<p>Index of all npm documentation</p>
-
-<h2 id="npm-registry-7"><a href="../misc/npm-registry.html">npm-registry(7)</a></h2>
-
+<h2 id="npm-registry-7-"><a href="../misc/npm-registry.html">npm-registry(7)</a></h2>
<p>The JavaScript Package Registry</p>
-
-<h2 id="npm-scripts-7"><a href="../misc/npm-scripts.html">npm-scripts(7)</a></h2>
-
+<h2 id="npm-scripts-7-"><a href="../misc/npm-scripts.html">npm-scripts(7)</a></h2>
<p>How npm handles the "scripts" field</p>
-
-<h2 id="removing-npm-7"><a href="../misc/removing-npm.html">removing-npm(7)</a></h2>
-
+<h2 id="removing-npm-7-"><a href="../misc/removing-npm.html">removing-npm(7)</a></h2>
<p>Cleaning the Slate</p>
-
-<h2 id="semver-7"><a href="../misc/semver.html">semver(7)</a></h2>
-
+<h2 id="semver-7-"><a href="../misc/semver.html">semver(7)</a></h2>
<p>The semantic versioner for npm</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-index — npm@1.4.9</p>
+<p id="footer">npm-index — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../misc/npm-registry.html">npm-registry</a></h1> <p>The JavaScript Package Registry</p>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="description">DESCRIPTION</h2>
<p>To resolve packages by name and version, npm talks to a registry website
that implements the CommonJS Package Registry specification for reading
package info.</p>
-
<p>Additionally, npm's package registry implementation supports several
write APIs as well, to allow for publishing packages and managing user
account information.</p>
-
<p>The official public npm registry is at <a href="http://registry.npmjs.org/">http://registry.npmjs.org/</a>. It
is powered by a CouchDB database at
<a href="http://isaacs.iriscouch.com/registry">http://isaacs.iriscouch.com/registry</a>. The code for the couchapp is
available at <a href="http://github.com/npm/npmjs.org">http://github.com/npm/npmjs.org</a>. npm user accounts
are CouchDB users, stored in the <a href="http://isaacs.iriscouch.com/_users">http://isaacs.iriscouch.com/_users</a>
database.</p>
-
<p>The registry URL is supplied by the <code>registry</code> config parameter. See
<code><a href="../cli/npm-config.html">npm-config(1)</a></code>, <code><a href="../files/npmrc.html">npmrc(5)</a></code>, and <code><a href="../misc/npm-config.html">npm-config(7)</a></code> for more on managing
npm's configuration.</p>
-
-<h2 id="Can-I-run-my-own-private-registry">Can I run my own private registry?</h2>
-
+<h2 id="can-i-run-my-own-private-registry-">Can I run my own private registry?</h2>
<p>Yes!</p>
-
<p>The easiest way is to replicate the couch database, and use the same (or
similar) design doc to implement the APIs.</p>
-
<p>If you set up continuous replication from the official CouchDB, and then
set your internal CouchDB as the registry config, then you'll be able
to read any published packages, in addition to your private ones, and by
default will only publish internally. If you then want to publish a
package for the whole world to see, you can simply override the
<code>--registry</code> config for that command.</p>
-
-<h2 id="I-don-t-want-my-package-published-in-the-official-registry-It-s-private">I don't want my package published in the official registry. It's private.</h2>
-
+<h2 id="i-don-t-want-my-package-published-in-the-official-registry-it-s-private-">I don't want my package published in the official registry. It's private.</h2>
<p>Set <code>"private": true</code> in your package.json to prevent it from being
published at all, or
<code>"publishConfig":{"registry":"http://my-internal-registry.local"}</code>
to force it to be published only to your internal registry.</p>
-
<p>See <code><a href="../files/package.json.html">package.json(5)</a></code> for more info on what goes in the package.json file.</p>
-
-<h2 id="Will-you-replicate-from-my-registry-into-the-public-one">Will you replicate from my registry into the public one?</h2>
-
+<h2 id="will-you-replicate-from-my-registry-into-the-public-one-">Will you replicate from my registry into the public one?</h2>
<p>No. If you want things to be public, then publish them into the public
registry using npm. What little security there is would be for nought
otherwise.</p>
-
-<h2 id="Do-I-have-to-use-couchdb-to-build-a-registry-that-npm-can-talk-to">Do I have to use couchdb to build a registry that npm can talk to?</h2>
-
+<h2 id="do-i-have-to-use-couchdb-to-build-a-registry-that-npm-can-talk-to-">Do I have to use couchdb to build a registry that npm can talk to?</h2>
<p>No, but it's way easier. Basically, yes, you do, or you have to
effectively implement the entire CouchDB API anyway.</p>
-
-<h2 id="Is-there-a-website-or-something-to-see-package-docs-and-such">Is there a website or something to see package docs and such?</h2>
-
+<h2 id="is-there-a-website-or-something-to-see-package-docs-and-such-">Is there a website or something to see package docs and such?</h2>
<p>Yes, head over to <a href="https://npmjs.org/">https://npmjs.org/</a></p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<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-developers.html">npm-developers(7)</a></li>
+<li><a href="../misc/npm-disputes.html">npm-disputes(7)</a></li>
+</ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><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-developers.html">npm-developers(7)</a></li><li><a href="../misc/npm-disputes.html">npm-disputes(7)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-registry — npm@1.4.9</p>
+<p id="footer">npm-registry — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../misc/npm-scripts.html">npm-scripts</a></h1> <p>How npm handles the "scripts" field</p>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
+<h2 id="description">DESCRIPTION</h2>
<p>npm supports the "scripts" member of the package.json script, for the
following scripts:</p>
-
-<ul><li>prepublish:
+<ul>
+<li>prepublish:
Run BEFORE the package is published. (Also run on local <code>npm
-install</code> without any arguments.)</li><li>publish, postpublish:
-Run AFTER the package is published.</li><li>preinstall:
-Run BEFORE the package is installed</li><li>install, postinstall:
-Run AFTER the package is installed.</li><li>preuninstall, uninstall:
-Run BEFORE the package is uninstalled.</li><li>postuninstall:
-Run AFTER the package is uninstalled.</li><li>preupdate:
-Run BEFORE the package is updated with the update command.</li><li>update, postupdate:
-Run AFTER the package is updated with the update command.</li><li>pretest, test, posttest:
-Run by the <code>npm test</code> command.</li><li>prestop, stop, poststop:
-Run by the <code>npm stop</code> command.</li><li>prestart, start, poststart:
-Run by the <code>npm start</code> command.</li><li>prerestart, restart, postrestart:
+install</code> without any arguments.)</li>
+<li>publish, postpublish:
+Run AFTER the package is published.</li>
+<li>preinstall:
+Run BEFORE the package is installed</li>
+<li>install, postinstall:
+Run AFTER the package is installed.</li>
+<li>preuninstall, uninstall:
+Run BEFORE the package is uninstalled.</li>
+<li>postuninstall:
+Run AFTER the package is uninstalled.</li>
+<li>preupdate:
+Run BEFORE the package is updated with the update command.</li>
+<li>update, postupdate:
+Run AFTER the package is updated with the update command.</li>
+<li>pretest, test, posttest:
+Run by the <code>npm test</code> command.</li>
+<li>prestop, stop, poststop:
+Run by the <code>npm stop</code> command.</li>
+<li>prestart, start, poststart:
+Run by the <code>npm start</code> command.</li>
+<li>prerestart, restart, postrestart:
Run by the <code>npm restart</code> command. Note: <code>npm restart</code> will run the
-stop and start scripts if no <code>restart</code> script is provided.</li></ul>
-
+stop and start scripts if no <code>restart</code> script is provided.</li>
+</ul>
<p>Additionally, arbitrary scripts can be run by doing
<code>npm run-script <stage> <pkg></code>.</p>
-
-<h2 id="NOTE-INSTALL-SCRIPTS-ARE-AN-ANTIPATTERN">NOTE: INSTALL SCRIPTS ARE AN ANTIPATTERN</h2>
-
+<h2 id="note-install-scripts-are-an-antipattern">NOTE: INSTALL SCRIPTS ARE AN ANTIPATTERN</h2>
<p><strong>tl;dr</strong> Don't use <code>install</code>. Use a <code>.gyp</code> file for compilation, and
<code>prepublish</code> for anything else.</p>
-
<p>You should almost never have to explicitly set a <code>preinstall</code> or
<code>install</code> script. If you are doing this, please consider if there is
another option.</p>
-
<p>The only valid use of <code>install</code> or <code>preinstall</code> scripts is for
compilation which must be done on the target architecture. In early
versions of node, this was often done using the <code>node-waf</code> scripts, or
a standalone <code>Makefile</code>, and early versions of npm required that it be
explicitly set in package.json. This was not portable, and harder to
do properly.</p>
-
<p>In the current version of node, the standard way to do this is using a
<code>.gyp</code> file. If you have a file with a <code>.gyp</code> extension in the root
of your package, then npm will run the appropriate <code>node-gyp</code> commands
automatically at install time. This is the only officially supported
method for compiling binary addons, and does not require that you add
anything to your package.json file.</p>
-
<p>If you have to do other things before your package is used, in a way
that is not dependent on the operating system or architecture of the
target system, then use a <code>prepublish</code> script instead. This includes
tasks such as:</p>
-
-<ul><li>Compile CoffeeScript source code into JavaScript.</li><li>Create minified versions of JavaScript source code.</li><li>Fetching remote resources that your package will use.</li></ul>
-
+<ul>
+<li>Compile CoffeeScript source code into JavaScript.</li>
+<li>Create minified versions of JavaScript source code.</li>
+<li>Fetching remote resources that your package will use.</li>
+</ul>
<p>The advantage of doing these things at <code>prepublish</code> time instead of
<code>preinstall</code> or <code>install</code> time is that they can be done once, in a
single place, and thus greatly reduce complexity and variability.
Additionally, this means that:</p>
-
-<ul><li>You can depend on <code>coffee-script</code> as a <code>devDependency</code>, and thus
-your users don't need to have it installed.</li><li>You don't need to include the minifiers in your package, reducing
-the size for your users.</li><li>You don't need to rely on your users having <code>curl</code> or <code>wget</code> or
-other system tools on the target machines.</li></ul>
-
-<h2 id="DEFAULT-VALUES">DEFAULT VALUES</h2>
-
+<ul>
+<li>You can depend on <code>coffee-script</code> as a <code>devDependency</code>, and thus
+your users don't need to have it installed.</li>
+<li>You don't need to include the minifiers in your package, reducing
+the size for your users.</li>
+<li>You don't need to rely on your users having <code>curl</code> or <code>wget</code> or
+other system tools on the target machines.</li>
+</ul>
+<h2 id="default-values">DEFAULT VALUES</h2>
<p>npm will default some script values based on package contents.</p>
-
-<ul><li><p><code>"start": "node server.js"</code>:</p><p>If there is a <code>server.js</code> file in the root of your package, then npm
-will default the <code>start</code> command to <code>node server.js</code>.</p></li><li><p><code>"preinstall": "node-waf clean || true; node-waf configure build"</code>:</p><p>If there is a <code>wscript</code> file in the root of your package, npm will
-default the <code>preinstall</code> command to compile using node-waf.</p></li></ul>
-
-<h2 id="USER">USER</h2>
-
+<ul>
+<li><p><code>"start": "node server.js"</code>:</p>
+<p>If there is a <code>server.js</code> file in the root of your package, then npm
+will default the <code>start</code> command to <code>node server.js</code>.</p>
+</li>
+<li><p><code>"preinstall": "node-waf clean || true; node-waf configure build"</code>:</p>
+<p>If there is a <code>wscript</code> file in the root of your package, npm will
+default the <code>preinstall</code> command to compile using node-waf.</p>
+</li>
+</ul>
+<h2 id="user">USER</h2>
<p>If npm was invoked with root privileges, then it will change the uid
to the user account or uid specified by the <code>user</code> config, which
defaults to <code>nobody</code>. Set the <code>unsafe-perm</code> flag to run scripts with
root privileges.</p>
-
-<h2 id="ENVIRONMENT">ENVIRONMENT</h2>
-
+<h2 id="environment">ENVIRONMENT</h2>
<p>Package scripts run in an environment where many pieces of information
are made available regarding the setup of npm and the current state of
the process.</p>
-
<h3 id="path">path</h3>
-
<p>If you depend on modules that define executable scripts, like test
suites, then those executables will be added to the <code>PATH</code> for
executing the scripts. So, if your package.json has this:</p>
-
<pre><code>{ "name" : "foo"
, "dependencies" : { "bar" : "0.1.x" }
-, "scripts": { "start" : "bar ./test" } }</code></pre>
-
-<p>then you could run <code>npm start</code> to execute the <code>bar</code> script, which is
+, "scripts": { "start" : "bar ./test" } }
+</code></pre><p>then you could run <code>npm start</code> to execute the <code>bar</code> script, which is
exported into the <code>node_modules/.bin</code> directory on <code>npm install</code>.</p>
-
<h3 id="package-json-vars">package.json vars</h3>
-
<p>The package.json fields are tacked onto the <code>npm_package_</code> prefix. So,
for instance, if you had <code>{"name":"foo", "version":"1.2.5"}</code> in your
package.json file, then your package scripts would have the
<code>npm_package_name</code> environment variable set to "foo", and the
<code>npm_package_version</code> set to "1.2.5"</p>
-
<h3 id="configuration">configuration</h3>
-
<p>Configuration parameters are put in the environment with the
<code>npm_config_</code> prefix. For instance, you can view the effective <code>root</code>
config by checking the <code>npm_config_root</code> environment variable.</p>
-
-<h3 id="Special-package-json-config-hash">Special: package.json "config" hash</h3>
-
+<h3 id="special-package-json-config-hash">Special: package.json "config" hash</h3>
<p>The package.json "config" keys are overwritten in the environment if
there is a config param of <code><name>[@<version>]:<key></code>. For example,
if the package.json has this:</p>
-
<pre><code>{ "name" : "foo"
, "config" : { "port" : "8080" }
-, "scripts" : { "start" : "node server.js" } }</code></pre>
-
-<p>and the server.js is this:</p>
-
-<pre><code>http.createServer(...).listen(process.env.npm_package_config_port)</code></pre>
-
-<p>then the user could change the behavior by doing:</p>
-
-<pre><code>npm config set foo:port 80</code></pre>
-
-<h3 id="current-lifecycle-event">current lifecycle event</h3>
-
+, "scripts" : { "start" : "node server.js" } }
+</code></pre><p>and the server.js is this:</p>
+<pre><code>http.createServer(...).listen(process.env.npm_package_config_port)
+</code></pre><p>then the user could change the behavior by doing:</p>
+<pre><code>npm config set foo:port 80
+</code></pre><h3 id="current-lifecycle-event">current lifecycle event</h3>
<p>Lastly, the <code>npm_lifecycle_event</code> environment variable is set to
whichever stage of the cycle is being executed. So, you could have a
single script used for different parts of the process which switches
based on what's currently happening.</p>
-
<p>Objects are flattened following this format, so if you had
<code>{"scripts":{"install":"foo.js"}}</code> in your package.json, then you'd
see this in the script:</p>
-
-<pre><code>process.env.npm_package_scripts_install === "foo.js"</code></pre>
-
-<h2 id="EXAMPLES">EXAMPLES</h2>
-
+<pre><code>process.env.npm_package_scripts_install === "foo.js"
+</code></pre><h2 id="examples">EXAMPLES</h2>
<p>For example, if your package.json contains this:</p>
-
<pre><code>{ "scripts" :
{ "install" : "scripts/install.js"
, "postinstall" : "scripts/install.js"
, "uninstall" : "scripts/uninstall.js"
}
-}</code></pre>
-
-<p>then the <code>scripts/install.js</code> will be called for the install,
+}
+</code></pre><p>then the <code>scripts/install.js</code> will be called for the install,
post-install, stages of the lifecycle, and the <code>scripts/uninstall.js</code>
would be called when the package is uninstalled. Since
<code>scripts/install.js</code> is running for three different phases, it would
be wise in this case to look at the <code>npm_lifecycle_event</code> environment
variable.</p>
-
<p>If you want to run a make command, you can do so. This works just
fine:</p>
-
<pre><code>{ "scripts" :
{ "preinstall" : "./configure"
, "install" : "make && make install"
, "test" : "make test"
}
-}</code></pre>
-
-<h2 id="EXITING">EXITING</h2>
-
+}
+</code></pre><h2 id="exiting">EXITING</h2>
<p>Scripts are run by passing the line as a script argument to <code>sh</code>.</p>
-
<p>If the script exits with a code other than 0, then this will abort the
process.</p>
-
<p>Note that these script files don't have to be nodejs or even
javascript programs. They just have to be some kind of executable
file.</p>
-
-<h2 id="HOOK-SCRIPTS">HOOK SCRIPTS</h2>
-
+<h2 id="hook-scripts">HOOK SCRIPTS</h2>
<p>If you want to run a specific script at a specific lifecycle event for
ALL packages, then you can use a hook script.</p>
-
<p>Place an executable file at <code>node_modules/.hooks/{eventname}</code>, and
it'll get run for all packages when they are going through that point
in the package lifecycle for any packages installed in that root.</p>
-
<p>Hook scripts are run exactly the same way as package.json scripts.
That is, they are in a separate child process, with the env described
above.</p>
-
-<h2 id="BEST-PRACTICES">BEST PRACTICES</h2>
-
-<ul><li>Don't exit with a non-zero error code unless you <em>really</em> mean it.
+<h2 id="best-practices">BEST PRACTICES</h2>
+<ul>
+<li>Don't exit with a non-zero error code unless you <em>really</em> mean it.
Except for uninstall scripts, this will cause the npm action to
fail, and potentially be rolled back. If the failure is minor or
only will prevent some optional features, then it's better to just
-print a warning and exit successfully.</li><li>Try not to use scripts to do what npm can do for you. Read through
+print a warning and exit successfully.</li>
+<li>Try not to use scripts to do what npm can do for you. Read through
<code><a href="../files/package.json.html">package.json(5)</a></code> to see all the things that you can specify and enable
by simply describing your package appropriately. In general, this
-will lead to a more robust and consistent state.</li><li>Inspect the env to determine where to put things. For instance, if
+will lead to a more robust and consistent state.</li>
+<li>Inspect the env to determine where to put things. For instance, if
the <code>npm_config_binroot</code> environ is set to <code>/home/user/bin</code>, then
don't try to install executables into <code>/usr/local/bin</code>. The user
-probably set it up that way for a reason.</li><li>Don't prefix your script commands with "sudo". If root permissions
+probably set it up that way for a reason.</li>
+<li>Don't prefix your script commands with "sudo". If root permissions
are required for some reason, then it'll fail with that error, and
-the user will sudo the npm command in question.</li></ul>
-
-<h2 id="SEE-ALSO">SEE ALSO</h2>
+the user will sudo the npm command in question.</li>
+</ul>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../cli/npm-run-script.html">npm-run-script(1)</a></li>
+<li><a href="../files/package.json.html">package.json(5)</a></li>
+<li><a href="../misc/npm-developers.html">npm-developers(7)</a></li>
+<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
+</ul>
-<ul><li><a href="../cli/npm-run-script.html">npm-run-script(1)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../misc/npm-developers.html">npm-developers(7)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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-scripts — npm@1.4.9</p>
+<p id="footer">npm-scripts — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../cli/npm-removal.html">npm-removal</a></h1> <p>Cleaning the Slate</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
+<h2 id="synopsis">SYNOPSIS</h2>
<p>So sad to see you go.</p>
-
-<pre><code>sudo npm uninstall npm -g</code></pre>
-
-<p>Or, if that fails, get the npm source code, and do:</p>
-
-<pre><code>sudo make uninstall</code></pre>
-
-<h2 id="More-Severe-Uninstalling">More Severe Uninstalling</h2>
-
+<pre><code>sudo npm uninstall npm -g
+</code></pre><p>Or, if that fails, get the npm source code, and do:</p>
+<pre><code>sudo make uninstall
+</code></pre><h2 id="more-severe-uninstalling">More Severe Uninstalling</h2>
<p>Usually, the above instructions are sufficient. That will remove
npm, but leave behind anything you've installed.</p>
-
<p>If that doesn't work, or if you require more drastic measures,
continue reading.</p>
-
<p>Note that this is only necessary for globally-installed packages. Local
installs are completely contained within a project's <code>node_modules</code>
folder. Delete that folder, and everything is gone (unless a package's
install script is particularly ill-behaved).</p>
-
<p>This assumes that you installed node and npm in the default place. If
you configured node with a different <code>--prefix</code>, or installed npm with a
different prefix setting, then adjust the paths accordingly, replacing
<code>/usr/local</code> with your install prefix.</p>
-
<p>To remove everything npm-related manually:</p>
-
-<pre><code>rm -rf /usr/local/{lib/node{,/.npm,_modules},bin,share/man}/npm*</code></pre>
-
-<p>If you installed things <em>with</em> npm, then your best bet is to uninstall
+<pre><code>rm -rf /usr/local/{lib/node{,/.npm,_modules},bin,share/man}/npm*
+</code></pre><p>If you installed things <em>with</em> npm, then your best bet is to uninstall
them with npm first, and then install them again once you have a
proper install. This can help find any symlinks that are lying
around:</p>
-
-<pre><code>ls -laF /usr/local/{lib/node{,/.npm},bin,share/man} | grep npm</code></pre>
-
-<p>Prior to version 0.3, npm used shim files for executables and node
+<pre><code>ls -laF /usr/local/{lib/node{,/.npm},bin,share/man} | grep npm
+</code></pre><p>Prior to version 0.3, npm used shim files for executables and node
modules. To track those down, you can do the following:</p>
+<pre><code>find /usr/local/{lib/node,bin} -exec grep -l npm \{\} \; ;
+</code></pre><p>(This is also in the <a href="../../doc/README.html">README</a> file.)</p>
+<h2 id="see-also">SEE ALSO</h2>
+<ul>
+<li><a href="../../doc/README.html">README</a></li>
+<li><a href="../cli/npm-rm.html">npm-rm(1)</a></li>
+<li><a href="../cli/npm-prune.html">npm-prune(1)</a></li>
+</ul>
-<pre><code>find /usr/local/{lib/node,bin} -exec grep -l npm \{\} \; ;</code></pre>
-
-<p>(This is also in the <a href="../../doc/README.html">README</a> file.)</p>
-
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<ul><li><a href="../../doc/README.html">README</a></li><li><a href="../cli/npm-rm.html">npm-rm(1)</a></li><li><a href="../cli/npm-prune.html">npm-prune(1)</a></li></ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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">removing-npm — npm@1.4.9</p>
+<p id="footer">removing-npm — npm@1.4.10</p>
<div id="wrapper">
<h1><a href="../misc/semver.html">semver</a></h1> <p>The semantic versioner for npm</p>
-
-<h2 id="Usage">Usage</h2>
-
+<h2 id="usage">Usage</h2>
<pre><code>$ npm install semver
semver.valid('1.2.3') // '1.2.3'
semver.clean(' =v1.2.3 ') // '1.2.3'
semver.satisfies('1.2.3', '1.x || >=2.5.0 || 5.0.0 - 7.2.3') // true
semver.gt('1.2.3', '9.8.7') // false
-semver.lt('1.2.3', '9.8.7') // true</code></pre>
-
-<p>As a command-line utility:</p>
-
+semver.lt('1.2.3', '9.8.7') // true
+</code></pre><p>As a command-line utility:</p>
<pre><code>$ semver -h
Usage: semver <version> [<version> [...]] [-r <range> | -i <inc> | -d <dec>]
then exits failure.
Versions are printed in ascending order, so supplying
-multiple versions to the utility will just sort them.</code></pre>
-
-<h2 id="Versions">Versions</h2>
-
+multiple versions to the utility will just sort them.
+</code></pre><h2 id="versions">Versions</h2>
<p>A "version" is described by the v2.0.0 specification found at
<a href="http://semver.org/">http://semver.org/</a>.</p>
-
<p>A leading <code>"="</code> or <code>"v"</code> character is stripped off and ignored.</p>
-
-<h2 id="Ranges">Ranges</h2>
-
+<h2 id="ranges">Ranges</h2>
<p>The following range styles are supported:</p>
-
-<ul><li><code>1.2.3</code> A specific version. When nothing else will do. Note that
+<ul>
+<li><code>1.2.3</code> A specific version. When nothing else will do. Note that
build metadata is still ignored, so <code>1.2.3+build2012</code> will satisfy
-this range.</li><li><code>>1.2.3</code> Greater than a specific version.</li><li><code><1.2.3</code> Less than a specific version. If there is no prerelease
+this range.</li>
+<li><code>>1.2.3</code> Greater than a specific version.</li>
+<li><code><1.2.3</code> Less than a specific version. If there is no prerelease
tag on the version range, then no prerelease version will be allowed
-either, even though these are technically "less than".</li><li><code>>=1.2.3</code> Greater than or equal to. Note that prerelease versions
+either, even though these are technically "less than".</li>
+<li><code>>=1.2.3</code> Greater than or equal to. Note that prerelease versions
are NOT equal to their "normal" equivalents, so <code>1.2.3-beta</code> will
-not satisfy this range, but <code>2.3.0-beta</code> will.</li><li><code><=1.2.3</code> Less than or equal to. In this case, prerelease versions
-ARE allowed, so <code>1.2.3-beta</code> would satisfy.</li><li><code>1.2.3 - 2.3.4</code> := <code>>=1.2.3 <=2.3.4</code></li><li><code>~1.2.3</code> := <code>>=1.2.3-0 <1.3.0-0</code> "Reasonably close to 1.2.3". When
+not satisfy this range, but <code>2.3.0-beta</code> will.</li>
+<li><code><=1.2.3</code> Less than or equal to. In this case, prerelease versions
+ARE allowed, so <code>1.2.3-beta</code> would satisfy.</li>
+<li><code>1.2.3 - 2.3.4</code> := <code>>=1.2.3 <=2.3.4</code></li>
+<li><code>~1.2.3</code> := <code>>=1.2.3-0 <1.3.0-0</code> "Reasonably close to 1.2.3". When
using tilde operators, prerelease versions are supported as well,
but a prerelease of the next significant digit will NOT be
-satisfactory, so <code>1.3.0-beta</code> will not satisfy <code>~1.2.3</code>.</li><li><code>^1.2.3</code> := <code>>=1.2.3-0 <2.0.0-0</code> "Compatible with 1.2.3". When
+satisfactory, so <code>1.3.0-beta</code> will not satisfy <code>~1.2.3</code>.</li>
+<li><code>^1.2.3</code> := <code>>=1.2.3-0 <2.0.0-0</code> "Compatible with 1.2.3". When
using caret operators, anything from the specified version (including
prerelease) will be supported up to, but not including, the next
major version (or its prereleases). <code>1.5.1</code> will satisfy <code>^1.2.3</code>,
-while <code>1.2.2</code> and <code>2.0.0-beta</code> will not.</li><li><code>^0.1.3</code> := <code>>=0.1.3-0 <0.2.0-0</code> "Compatible with 0.1.3". 0.x.x versions are
+while <code>1.2.2</code> and <code>2.0.0-beta</code> will not.</li>
+<li><code>^0.1.3</code> := <code>>=0.1.3-0 <0.2.0-0</code> "Compatible with 0.1.3". 0.x.x versions are
special: the first non-zero component indicates potentially breaking changes,
meaning the caret operator matches any version with the same first non-zero
-component starting at the specified version.</li><li><code>^0.0.2</code> := <code>=0.0.2</code> "Only the version 0.0.2 is considered compatible"</li><li><code>~1.2</code> := <code>>=1.2.0-0 <1.3.0-0</code> "Any version starting with 1.2"</li><li><code>^1.2</code> := <code>>=1.2.0-0 <2.0.0-0</code> "Any version compatible with 1.2"</li><li><code>1.2.x</code> := <code>>=1.2.0-0 <1.3.0-0</code> "Any version starting with 1.2"</li><li><code>~1</code> := <code>>=1.0.0-0 <2.0.0-0</code> "Any version starting with 1"</li><li><code>^1</code> := <code>>=1.0.0-0 <2.0.0-0</code> "Any version compatible with 1"</li><li><code>1.x</code> := <code>>=1.0.0-0 <2.0.0-0</code> "Any version starting with 1"</li></ul>
-
+component starting at the specified version.</li>
+<li><code>^0.0.2</code> := <code>=0.0.2</code> "Only the version 0.0.2 is considered compatible"</li>
+<li><code>~1.2</code> := <code>>=1.2.0-0 <1.3.0-0</code> "Any version starting with 1.2"</li>
+<li><code>^1.2</code> := <code>>=1.2.0-0 <2.0.0-0</code> "Any version compatible with 1.2"</li>
+<li><code>1.2.x</code> := <code>>=1.2.0-0 <1.3.0-0</code> "Any version starting with 1.2"</li>
+<li><code>~1</code> := <code>>=1.0.0-0 <2.0.0-0</code> "Any version starting with 1"</li>
+<li><code>^1</code> := <code>>=1.0.0-0 <2.0.0-0</code> "Any version compatible with 1"</li>
+<li><code>1.x</code> := <code>>=1.0.0-0 <2.0.0-0</code> "Any version starting with 1"</li>
+</ul>
<p>Ranges can be joined with either a space (which implies "and") or a
<code>||</code> (which implies "or").</p>
-
-<h2 id="Functions">Functions</h2>
-
+<h2 id="functions">Functions</h2>
<p>All methods and classes take a final <code>loose</code> boolean argument that, if
true, will be more forgiving about not-quite-valid semver strings.
The resulting output will always be 100% strict, of course.</p>
-
<p>Strict-mode Comparators and Ranges will be strict about the SemVer
strings that they parse.</p>
-
-<ul><li>valid(v): Return the parsed version, or null if it's not valid.</li><li>inc(v, release): Return the version incremented by the release type
-(major, minor, patch, or prerelease), or null if it's not valid.</li></ul>
-
-<h3 id="Comparison">Comparison</h3>
-
-<ul><li>gt(v1, v2): <code>v1 > v2</code></li><li>gte(v1, v2): <code>v1 >= v2</code></li><li>lt(v1, v2): <code>v1 < v2</code></li><li>lte(v1, v2): <code>v1 <= v2</code></li><li>eq(v1, v2): <code>v1 == v2</code> This is true if they're logically equivalent,
+<ul>
+<li>valid(v): Return the parsed version, or null if it's not valid.</li>
+<li>inc(v, release): Return the version incremented by the release type
+(major, minor, patch, or prerelease), or null if it's not valid.</li>
+</ul>
+<h3 id="comparison">Comparison</h3>
+<ul>
+<li>gt(v1, v2): <code>v1 > v2</code></li>
+<li>gte(v1, v2): <code>v1 >= v2</code></li>
+<li>lt(v1, v2): <code>v1 < v2</code></li>
+<li>lte(v1, v2): <code>v1 <= v2</code></li>
+<li>eq(v1, v2): <code>v1 == v2</code> This is true if they're logically equivalent,
even if they're not the exact same string. You already know how to
-compare strings.</li><li>neq(v1, v2): <code>v1 != v2</code> The opposite of eq.</li><li>cmp(v1, comparator, v2): Pass in a comparison string, and it'll call
+compare strings.</li>
+<li>neq(v1, v2): <code>v1 != v2</code> The opposite of eq.</li>
+<li>cmp(v1, comparator, v2): Pass in a comparison string, and it'll call
the corresponding function above. <code>"==="</code> and <code>"!=="</code> do simple
string comparison, but are included for completeness. Throws if an
-invalid comparison string is provided.</li><li>compare(v1, v2): Return 0 if v1 == v2, or 1 if v1 is greater, or -1 if
-v2 is greater. Sorts in ascending order if passed to Array.sort().</li><li>rcompare(v1, v2): The reverse of compare. Sorts an array of versions
-in descending order when passed to Array.sort().</li></ul>
-
-<h3 id="Ranges">Ranges</h3>
-
-<ul><li>validRange(range): Return the valid range or null if it's not valid</li><li>satisfies(version, range): Return true if the version satisfies the
-range.</li><li>maxSatisfying(versions, range): Return the highest version in the list
-that satisfies the range, or null if none of them do.</li><li>gtr(version, range): Return true if version is greater than all the
-versions possible in the range.</li><li>ltr(version, range): Return true if version is less than all the
-versions possible in the range.</li><li>outside(version, range, hilo): Return true if the version is outside
+invalid comparison string is provided.</li>
+<li>compare(v1, v2): Return 0 if v1 == v2, or 1 if v1 is greater, or -1 if
+v2 is greater. Sorts in ascending order if passed to Array.sort().</li>
+<li>rcompare(v1, v2): The reverse of compare. Sorts an array of versions
+in descending order when passed to Array.sort().</li>
+</ul>
+<h3 id="ranges">Ranges</h3>
+<ul>
+<li>validRange(range): Return the valid range or null if it's not valid</li>
+<li>satisfies(version, range): Return true if the version satisfies the
+range.</li>
+<li>maxSatisfying(versions, range): Return the highest version in the list
+that satisfies the range, or null if none of them do.</li>
+<li>gtr(version, range): Return true if version is greater than all the
+versions possible in the range.</li>
+<li>ltr(version, range): Return true if version is less than all the
+versions possible in the range.</li>
+<li>outside(version, range, hilo): Return true if the version is outside
the bounds of the range in either the high or low direction. The
<code>hilo</code> argument must be either the string <code>'>'</code> or <code>'<'</code>. (This is
-the function called by <code>gtr</code> and <code>ltr</code>.)</li></ul>
-
+the function called by <code>gtr</code> and <code>ltr</code>.)</li>
+</ul>
<p>Note that, since ranges may be non-contiguous, a version might not be
greater than a range, less than a range, <em>or</em> satisfy a range! For
example, the range <code>1.2 <1.2.9 || >2.0.0</code> would have a hole from <code>1.2.9</code>
range (because 2.0.1 satisfies, which is higher), nor less than the
range (since 1.2.8 satisfies, which is lower), and it also does not
satisfy the range.</p>
-
<p>If you want to know if a version satisfies or does not satisfy a
range, use the <code>satisfies(version, range)</code> function.</p>
+
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<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">semver — npm@1.4.9</p>
+<p id="footer">semver — npm@1.4.10</p>
}
if (args.length === 1) args.unshift([])
- npm.registry.refer = [a].concat(args[0]).map(function (arg) {
- // exclude anything that might be a URL, path, or private module
- // Those things will always have a slash in them somewhere
- if (arg && arg.match && arg.match(/\/|\\/)) {
- return "[REDACTED]"
- } else {
- return arg
- }
- }).filter(function (arg) {
- return arg && arg.match
- }).join(" ")
+ if (!npm.registry.refer) {
+ npm.registry.refer = [a].concat(args[0]).map(function (arg) {
+ // exclude anything that might be a URL, path, or private module
+ // Those things will always have a slash in them somewhere
+ if (arg && arg.match && arg.match(/\/|\\/)) {
+ return "[REDACTED]"
+ } else {
+ return arg
+ }
+ }).filter(function (arg) {
+ return arg && arg.match
+ }).join(" ")
+ }
cmd.apply(npm, args)
}
}
function runScript (args, cb) {
- if (!args.length) return cb(runScript.usage)
+ if (!args.length) return list(cb)
var pkgdir = args.length === 1 ? process.cwd()
: path.resolve(npm.dir, args[0])
, cmd = args.pop()
})
}
+function list(cb) {
+ var json = path.join(npm.prefix, 'package.json')
+ return readJson(json, function(er, d) {
+ if (er && er.code !== 'ENOENT' && er.code !== 'ENOTDIR') return cb(er)
+ if (er) d = {}
+ var scripts = Object.keys(d.scripts || {})
+
+ if (log.level === "silent") {
+ return cb(null, scripts)
+ }
+
+ if (npm.config.get("json")) {
+ console.log(JSON.stringify(d.scripts || {}, null, 2))
+ return cb(null, scripts)
+ }
+
+ var s = ":"
+ var prefix = ""
+ if (!npm.config.get("parseable")) {
+ s = "\n "
+ prefix = " "
+ console.log("Available scripts in the %s package:", d.name)
+ }
+ scripts.forEach(function(script) {
+ console.log(prefix + script + s + d.scripts[script])
+ })
+ return cb(null, scripts)
+ })
+}
+
function run (pkg, wd, cmd, cb) {
var cmds = []
if (!pkg.scripts) pkg.scripts = {}
, chownr = require("chownr")
, regHost
, once = require("once")
+ , crypto = require("crypto")
module.exports = fetch
proxy = npm.config.get("proxy")
}
+ var sessionToken = npm.registry.sessionToken
+ if (!sessionToken) {
+ sessionToken = crypto.randomBytes(8).toString("hex")
+ npm.registry.sessionToken = sessionToken
+ }
+
+ var ca = remote.host === regHost ? npm.config.get("ca") : undefined
var opts = { url: remote
, proxy: proxy
, strictSSL: npm.config.get("strict-ssl")
, rejectUnauthorized: npm.config.get("strict-ssl")
- , ca: remote.host === regHost ? npm.config.get("ca") : undefined
- , headers: { "user-agent": npm.config.get("user-agent") }}
+ , ca: ca
+ , headers:
+ { "user-agent": npm.config.get("user-agent")
+ , "npm-session": sessionToken
+ , referer: npm.registry.refer
+ }
+ }
var req = request(opts)
req.on("error", function (er) {
fstr.emit("error", er)
.IP "" 4
.
.nf
-npm@1.4.9 /path/to/npm
+npm@1.4.10 /path/to/npm
└─┬ init\-package\-json@0\.0\.4
└── promzard@0\.1\.5
.
.SH "SYNOPSIS"
.
.nf
-npm run\-script [<pkg>] <command>
+npm run\-script [<pkg>] [command]
.
.fi
.
.SH "DESCRIPTION"
This runs an arbitrary command from a package\'s \fB"scripts"\fR object\.
If no package name is provided, it will search for a \fBpackage\.json\fR
-in the current folder and use its \fB"scripts"\fR object\.
+in the current folder and use its \fB"scripts"\fR object\. If no \fB"command"\fR
+is provided, it will list the available top level scripts\.
.
.P
It is used by the test, start, restart, and stop commands, but can be
.fi
.
.SH "VERSION"
-1.4.9
+1.4.10
.
.SH "DESCRIPTION"
npm is the package manager for the Node JavaScript platform\. It puts
.fi
.
.SH "VERSION"
-1.4.9
+1.4.10
.
.SH "DESCRIPTION"
This is the API documentation for npm\.
{
- "version": "1.4.9",
+ "version": "1.4.10",
"name": "npm",
"publishConfig": {
"proprietary-attribs": false
"which"
],
"devDependencies": {
+ "marked": "~0.3.2",
"npm-registry-mock": "~0.6.3",
"ronn": "~0.3.6",
"tap": "~0.4.9"
*.html)
url=${dest/html\//}
(cat html/dochead.html && \
- ./node_modules/.bin/ronn -f $src &&
+ cat $src | ./node_modules/.bin/marked &&
cat html/docfoot.html)\
| sed "s|@NAME@|$name|g" \
| sed "s|@DATE@|$date|g" \
| sed "s|@URL@|$url|g" \
| sed "s|@VERSION@|$version|g" \
- | perl -pi -e 's/<h1>([^\(]*\([0-9]\)) -- (.*?)<\/h1>/<h1>\1<\/h1> <p>\2<\/p>/g' \
+ | perl -pi -e 's/<h1([^>]*)>([^\(]*\([0-9]\)) -- (.*?)<\/h1>/<h1>\2<\/h1> <p>\3<\/p>/g' \
| perl -pi -e 's/npm-npm/npm/g' \
| perl -pi -e 's/([^"-])(npm-)?README(?!\.html)(\(1\))?/\1<a href="..\/..\/doc\/README.html">README<\/a>/g' \
| perl -pi -e 's/<title><a href="[^"]+README.html">README<\/a><\/title>/<title>README<\/title>/g' \
var pkgJson = JSON.parse(fs.readFileSync(pkg + '/package.json', 'utf8'))
t.deepEqual(pkgJson.dependencies, {
'underscore': '^1.5.1'
- }, 'Underscore dependency should specify ^1.3.1')
+ }, 'Underscore dependency should specify ^1.5.1')
npm.config.set('save', undefined)
s.close()
t.end()
--- /dev/null
+var common = require("../common-tap.js")
+var test = require("tap").test
+var path = require("path")
+var cwd = path.resolve(__dirname, "..", "..")
+var testscript = require("../../package.json").scripts.test
+var tsregexp = testscript.replace(/([\[\.\*\]])/g, "\\$1")
+
+test("default", function (t) {
+ common.npm(["run"], { cwd: cwd }, function (er, code, so, se) {
+ if (er) throw er
+ t.notOk(code)
+ t.similar(so, new RegExp("\\n test\\n " + tsregexp + "\\n"))
+ t.end()
+ })
+})
+
+test("parseable", function (t) {
+ common.npm(["run", "-p"], { cwd: cwd }, function (er, code, so, se) {
+ if (er) throw er
+ t.notOk(code)
+ t.similar(so, new RegExp("\\ntest:" + tsregexp + "\\n"))
+ t.end()
+ })
+})
+
+test("parseable", function (t) {
+ common.npm(["run", "--json"], { cwd: cwd }, function (er, code, so, se) {
+ if (er) throw er
+ t.notOk(code)
+ t.equal(JSON.parse(so).test, testscript)
+ t.end()
+ })
+})
projects / platform / upstream / nodejs.git / commitdiff