mirror of https://github.com/nodejs/node.git
44 lines
1.9 KiB
HTML
44 lines
1.9 KiB
HTML
<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>
|
|
<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>
|
|
<h3 id="long">long</h3>
|
|
<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>
|
|
<p>Show parseable output instead of tree view.</p>
|
|
<h3 id="global">global</h3>
|
|
<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 has the same dependency as a parent module, then the
|
|
dependency will only be output once.</p>
|
|
|