codekingpro/portable-devtools
114k
1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>npm-ls</title>
4<style>
5body {
6 background-color: #ffffff;
7 color: #24292e;
8
9 margin: 0;
10
11 line-height: 1.5;
12
13 font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
14}
15#rainbar {
16 height: 10px;
17 background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
18}
19
20a {
21 text-decoration: none;
22 color: #0366d6;
23}
24a:hover {
25 text-decoration: underline;
26}
27
28pre {
29 margin: 1em 0px;
30 padding: 1em;
31 border: solid 1px #e1e4e8;
32 border-radius: 6px;
33
34 display: block;
35 overflow: auto;
36
37 white-space: pre;
38
39 background-color: #f6f8fa;
40 color: #393a34;
41}
42code {
43 font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
44 font-size: 85%;
45 padding: 0.2em 0.4em;
46 background-color: #f6f8fa;
47 color: #393a34;
48}
49pre > code {
50 padding: 0;
51 background-color: inherit;
52 color: inherit;
53}
54h1, h2, h3 {
55 font-weight: 600;
56}
57
58#logobar {
59 background-color: #333333;
60 margin: 0 auto;
61 padding: 1em 4em;
62}
63#logobar .logo {
64 float: left;
65}
66#logobar .title {
67 font-weight: 600;
68 color: #dddddd;
69 float: left;
70 margin: 5px 0 0 1em;
71}
72#logobar:after {
73 content: "";
74 display: block;
75 clear: both;
76}
77
78#content {
79 margin: 0 auto;
80 padding: 0 4em;
81}
82
83#table_of_contents > h2 {
84 font-size: 1.17em;
85}
86#table_of_contents ul:first-child {
87 border: solid 1px #e1e4e8;
88 border-radius: 6px;
89 padding: 1em;
90 background-color: #f6f8fa;
91 color: #393a34;
92}
93#table_of_contents ul {
94 list-style-type: none;
95 padding-left: 1.5em;
96}
97#table_of_contents li {
98 font-size: 0.9em;
99}
100#table_of_contents li a {
101 color: #000000;
102}
103
104header.title {
105 border-bottom: solid 1px #e1e4e8;
106}
107header.title > h1 {
108 margin-bottom: 0.25em;
109}
110header.title > .description {
111 display: block;
112 margin-bottom: 0.5em;
113 line-height: 1;
114}
115
116header.title .version {
117 font-size: 0.8em;
118 color: #666666;
119}
120
121footer#edit {
122 border-top: solid 1px #e1e4e8;
123 margin: 3em 0 4em 0;
124 padding-top: 2em;
125}
126
127table {
128 width: 100%;
129 margin: 1em 0;
130 border-radius: 6px;
131 border: 1px solid #e1e4e8;
132 overflow: hidden;
133 border-collapse: separate;
134 border-spacing: 0;
135}
136
137table thead {
138 background-color: #f6f8fa;
139}
140
141table tbody {
142 background-color: #ffffff;
143}
144
145table th,
146table td {
147 padding: 0.75em;
148 text-align: left;
149 border-right: 1px solid #e1e4e8;
150 border-bottom: 1px solid #e1e4e8;
151}
152
153table th:last-child,
154table td:last-child {
155 border-right: none;
156}
157
158table tbody tr:last-child td {
159 border-bottom: none;
160}
161
162table th {
163 font-weight: 600;
164 background-color: #f6f8fa;
165}
166
167table code {
168 white-space: nowrap;
169}
170
171</style>
172</head>
173<body>
174<div id="banner">
175<div id="rainbar"></div>
176<div id="logobar">
177<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
178<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
179<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
180</svg>
181<div class="title">
182npm command-line interface
183</div>
184</div>
185</div>
186
187<section id="content">
188<header class="title">
189<h1 id="----npm-ls----11121">
190 <span>npm-ls</span>
191 <span class="version">@11.12.1</span>
192</h1>
193<span class="description">List installed packages</span>
194</header>
195
196<section id="table_of_contents">
197<h2 id="table-of-contents">Table of contents</h2>
198<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#all"><code>all</code></a></li><li><a href="#json"><code>json</code></a></li><li><a href="#long"><code>long</code></a></li><li><a href="#parseable"><code>parseable</code></a></li><li><a href="#global"><code>global</code></a></li><li><a href="#depth"><code>depth</code></a></li><li><a href="#omit"><code>omit</code></a></li><li><a href="#include"><code>include</code></a></li><li><a href="#link"><code>link</code></a></li><li><a href="#package-lock-only"><code>package-lock-only</code></a></li><li><a href="#unicode"><code>unicode</code></a></li><li><a href="#workspace"><code>workspace</code></a></li><li><a href="#workspaces"><code>workspaces</code></a></li><li><a href="#include-workspace-root"><code>include-workspace-root</code></a></li><li><a href="#install-links"><code>install-links</code></a></li></ul><li><a href="#see-also">See Also</a></li></ul></div>
199</section>
200
201<div id="_content"><h3 id="synopsis">Synopsis</h3>
202<pre><code class="language-bash">npm ls <package-spec>
203
204alias: list
205</code></pre>
206<h3 id="description">Description</h3>
207<p>This command will print to stdout all the versions of packages that are installed, as well as their dependencies when <code>--all</code> is specified, in a tree structure.</p>
208<p>Note: to get a "bottoms up" view of why a given package is included in the tree at all, use <a href="../commands/npm-explain.html"><code>npm explain</code></a>.</p>
209<p>Positional arguments are <code>name@version-range</code> identifiers, which will limit the results to only the paths to the packages named.
210Note that nested packages will <em>also</em> show the paths to the specified packages.
211For example, running <code>npm ls promzard</code> in npm's source tree will show:</p>
212<pre><code class="language-bash">npm@11.12.1 /path/to/npm
213└─┬ init-package-json@0.0.4
214 └── promzard@0.1.5
215</code></pre>
216<p>It will print out extraneous, missing, and invalid packages.</p>
217<p>If a project specifies git urls for dependencies these are shown in parentheses after the <code>name@version</code> to make it easier for users to recognize potential forks of a project.</p>
218<p>The tree shown is the logical dependency tree, based on package dependencies, not the physical layout of your <code>node_modules</code> folder.</p>
219<p>When run as <code>ll</code> or <code>la</code>, it shows extended information by default.</p>
220<h3 id="configuration">Configuration</h3>
221<h4 id="all"><code>all</code></h4>
222<ul>
223<li>Default: false</li>
224<li>Type: Boolean</li>
225</ul>
226<p>When running <code>npm outdated</code> and <code>npm ls</code>, setting <code>--all</code> will show all
227outdated or installed packages, rather than only those directly depended
228upon by the current project.</p>
229<h4 id="json"><code>json</code></h4>
230<ul>
231<li>Default: false</li>
232<li>Type: Boolean</li>
233</ul>
234<p>Whether or not to output JSON data, rather than the normal output.</p>
235<ul>
236<li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before
237saving them to your <code>package.json</code>.</li>
238</ul>
239<p>Not supported by all npm commands.</p>
240<h4 id="long"><code>long</code></h4>
241<ul>
242<li>Default: false</li>
243<li>Type: Boolean</li>
244</ul>
245<p>Show extended information in <code>ls</code>, <code>search</code>, and <code>help-search</code>.</p>
246<h4 id="parseable"><code>parseable</code></h4>
247<ul>
248<li>Default: false</li>
249<li>Type: Boolean</li>
250</ul>
251<p>Output parseable results from commands that write to standard output. For
252<code>npm search</code>, this will be tab-separated table format.</p>
253<h4 id="global"><code>global</code></h4>
254<ul>
255<li>Default: false</li>
256<li>Type: Boolean</li>
257</ul>
258<p>Operates in "global" mode, so that packages are installed into the <code>prefix</code>
259folder instead of the current working directory. See
260<a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p>
261<ul>
262<li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead
263of the current working directory.</li>
264<li>bin files are linked to <code>{prefix}/bin</code></li>
265<li>man pages are linked to <code>{prefix}/share/man</code></li>
266</ul>
267<h4 id="depth"><code>depth</code></h4>
268<ul>
269<li>Default: <code>Infinity</code> if <code>--all</code> is set; otherwise, <code>0</code></li>
270<li>Type: null or Number</li>
271</ul>
272<p>The depth to go when recursing packages for <code>npm ls</code>.</p>
273<p>If not set, <code>npm ls</code> will show only the immediate dependencies of the root
274project. If <code>--all</code> is set, then npm will show all dependencies by default.</p>
275<h4 id="omit"><code>omit</code></h4>
276<ul>
277<li>Default: 'dev' if the <code>NODE_ENV</code> environment variable is set to
278'production'; otherwise, empty.</li>
279<li>Type: "dev", "optional", or "peer" (can be set multiple times)</li>
280</ul>
281<p>Dependency types to omit from the installation tree on disk.</p>
282<p>Note that these dependencies <em>are</em> still resolved and added to the
283<code>package-lock.json</code> or <code>npm-shrinkwrap.json</code> file. They are just not
284physically installed on disk.</p>
285<p>If a package type appears in both the <code>--include</code> and <code>--omit</code> lists, then
286it will be included.</p>
287<p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment
288variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
289<h4 id="include"><code>include</code></h4>
290<ul>
291<li>Default:</li>
292<li>Type: "prod", "dev", "optional", or "peer" (can be set multiple times)</li>
293</ul>
294<p>Option that allows for defining which types of dependencies to install.</p>
295<p>This is the inverse of <code>--omit=<type></code>.</p>
296<p>Dependency types specified in <code>--include</code> will not be omitted, regardless of
297the order in which omit/include are specified on the command-line.</p>
298<h4 id="link"><code>link</code></h4>
299<ul>
300<li>Default: false</li>
301<li>Type: Boolean</li>
302</ul>
303<p>Used with <code>npm ls</code>, limiting output to only those packages that are linked.</p>
304<h4 id="package-lock-only"><code>package-lock-only</code></h4>
305<ul>
306<li>Default: false</li>
307<li>Type: Boolean</li>
308</ul>
309<p>If set to true, the current operation will only use the <code>package-lock.json</code>,
310ignoring <code>node_modules</code>.</p>
311<p>For <code>update</code> this means only the <code>package-lock.json</code> will be updated,
312instead of checking <code>node_modules</code> and downloading dependencies.</p>
313<p>For <code>list</code> this means the output will be based on the tree described by the
314<code>package-lock.json</code>, rather than the contents of <code>node_modules</code>.</p>
315<h4 id="unicode"><code>unicode</code></h4>
316<ul>
317<li>Default: false on windows, true on mac/unix systems with a unicode locale,
318as defined by the <code>LC_ALL</code>, <code>LC_CTYPE</code>, or <code>LANG</code> environment variables.</li>
319<li>Type: Boolean</li>
320</ul>
321<p>When set to true, npm uses unicode characters in the tree output. When
322false, it uses ascii characters instead of unicode glyphs.</p>
323<h4 id="workspace"><code>workspace</code></h4>
324<ul>
325<li>Default:</li>
326<li>Type: String (can be set multiple times)</li>
327</ul>
328<p>Enable running a command in the context of the configured workspaces of the
329current project while filtering by running only the workspaces defined by
330this configuration option.</p>
331<p>Valid values for the <code>workspace</code> config are either:</p>
332<ul>
333<li>Workspace names</li>
334<li>Path to a workspace directory</li>
335<li>Path to a parent workspace directory (will result in selecting all
336workspaces within that folder)</li>
337</ul>
338<p>When set for the <code>npm init</code> command, this may be set to the folder of a
339workspace which does not yet exist, to create the folder and set it up as a
340brand new workspace within the project.</p>
341<p>This value is not exported to the environment for child processes.</p>
342<h4 id="workspaces"><code>workspaces</code></h4>
343<ul>
344<li>Default: null</li>
345<li>Type: null or Boolean</li>
346</ul>
347<p>Set to true to run the command in the context of <strong>all</strong> configured
348workspaces.</p>
349<p>Explicitly setting this to false will cause commands like <code>install</code> to
350ignore workspaces altogether. When not set explicitly:</p>
351<ul>
352<li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
353will link workspaces into the <code>node_modules</code> folder. - Commands that do
354other things (test, exec, publish, etc.) will operate on the root project,
355<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
356</ul>
357<p>This value is not exported to the environment for child processes.</p>
358<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
359<ul>
360<li>Default: false</li>
361<li>Type: Boolean</li>
362</ul>
363<p>Include the workspace root when workspaces are enabled for a command.</p>
364<p>When false, specifying individual workspaces via the <code>workspace</code> config, or
365all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
366the specified workspaces, and not on the root project.</p>
367<p>This value is not exported to the environment for child processes.</p>
368<h4 id="install-links"><code>install-links</code></h4>
369<ul>
370<li>Default: false</li>
371<li>Type: Boolean</li>
372</ul>
373<p>When set file: protocol dependencies will be packed and installed as regular
374dependencies instead of creating a symlink. This option has no effect on
375workspaces.</p>
376<h3 id="see-also">See Also</h3>
377<ul>
378<li><a href="../using-npm/package-spec.html">package spec</a></li>
379<li><a href="../commands/npm-explain.html">npm explain</a></li>
380<li><a href="../commands/npm-config.html">npm config</a></li>
381<li><a href="../configuring-npm/npmrc.html">npmrc</a></li>
382<li><a href="../configuring-npm/folders.html">npm folders</a></li>
383<li><a href="../commands/npm-explain.html">npm explain</a></li>
384<li><a href="../commands/npm-install.html">npm install</a></li>
385<li><a href="../commands/npm-link.html">npm link</a></li>
386<li><a href="../commands/npm-prune.html">npm prune</a></li>
387<li><a href="../commands/npm-outdated.html">npm outdated</a></li>
388<li><a href="../commands/npm-update.html">npm update</a></li>
389</ul></div>
390
391<footer id="edit">
392<a href="https://github.com/npm/cli/edit/latest/docs/lib/content/commands/npm-ls.md">
393<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
394<path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path>
395</svg>
396Edit this page on GitHub
397</a>
398</footer>
399</section>
400
401
402
403</body></html>