11cb0ef41Sopenharmony_ci<!DOCTYPE html><html><head> 21cb0ef41Sopenharmony_ci<meta charset="utf-8"> 31cb0ef41Sopenharmony_ci<title>npm-ls</title> 41cb0ef41Sopenharmony_ci<style> 51cb0ef41Sopenharmony_cibody { 61cb0ef41Sopenharmony_ci background-color: #ffffff; 71cb0ef41Sopenharmony_ci color: #24292e; 81cb0ef41Sopenharmony_ci 91cb0ef41Sopenharmony_ci margin: 0; 101cb0ef41Sopenharmony_ci 111cb0ef41Sopenharmony_ci line-height: 1.5; 121cb0ef41Sopenharmony_ci 131cb0ef41Sopenharmony_ci font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; 141cb0ef41Sopenharmony_ci} 151cb0ef41Sopenharmony_ci#rainbar { 161cb0ef41Sopenharmony_ci height: 10px; 171cb0ef41Sopenharmony_ci background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff); 181cb0ef41Sopenharmony_ci} 191cb0ef41Sopenharmony_ci 201cb0ef41Sopenharmony_cia { 211cb0ef41Sopenharmony_ci text-decoration: none; 221cb0ef41Sopenharmony_ci color: #0366d6; 231cb0ef41Sopenharmony_ci} 241cb0ef41Sopenharmony_cia:hover { 251cb0ef41Sopenharmony_ci text-decoration: underline; 261cb0ef41Sopenharmony_ci} 271cb0ef41Sopenharmony_ci 281cb0ef41Sopenharmony_cipre { 291cb0ef41Sopenharmony_ci margin: 1em 0px; 301cb0ef41Sopenharmony_ci padding: 1em; 311cb0ef41Sopenharmony_ci border: solid 1px #e1e4e8; 321cb0ef41Sopenharmony_ci border-radius: 6px; 331cb0ef41Sopenharmony_ci 341cb0ef41Sopenharmony_ci display: block; 351cb0ef41Sopenharmony_ci overflow: auto; 361cb0ef41Sopenharmony_ci 371cb0ef41Sopenharmony_ci white-space: pre; 381cb0ef41Sopenharmony_ci 391cb0ef41Sopenharmony_ci background-color: #f6f8fa; 401cb0ef41Sopenharmony_ci color: #393a34; 411cb0ef41Sopenharmony_ci} 421cb0ef41Sopenharmony_cicode { 431cb0ef41Sopenharmony_ci font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace; 441cb0ef41Sopenharmony_ci font-size: 85%; 451cb0ef41Sopenharmony_ci padding: 0.2em 0.4em; 461cb0ef41Sopenharmony_ci background-color: #f6f8fa; 471cb0ef41Sopenharmony_ci color: #393a34; 481cb0ef41Sopenharmony_ci} 491cb0ef41Sopenharmony_cipre > code { 501cb0ef41Sopenharmony_ci padding: 0; 511cb0ef41Sopenharmony_ci background-color: inherit; 521cb0ef41Sopenharmony_ci color: inherit; 531cb0ef41Sopenharmony_ci} 541cb0ef41Sopenharmony_cih1, h2, h3 { 551cb0ef41Sopenharmony_ci font-weight: 600; 561cb0ef41Sopenharmony_ci} 571cb0ef41Sopenharmony_ci 581cb0ef41Sopenharmony_ci#logobar { 591cb0ef41Sopenharmony_ci background-color: #333333; 601cb0ef41Sopenharmony_ci margin: 0 auto; 611cb0ef41Sopenharmony_ci padding: 1em 4em; 621cb0ef41Sopenharmony_ci} 631cb0ef41Sopenharmony_ci#logobar .logo { 641cb0ef41Sopenharmony_ci float: left; 651cb0ef41Sopenharmony_ci} 661cb0ef41Sopenharmony_ci#logobar .title { 671cb0ef41Sopenharmony_ci font-weight: 600; 681cb0ef41Sopenharmony_ci color: #dddddd; 691cb0ef41Sopenharmony_ci float: left; 701cb0ef41Sopenharmony_ci margin: 5px 0 0 1em; 711cb0ef41Sopenharmony_ci} 721cb0ef41Sopenharmony_ci#logobar:after { 731cb0ef41Sopenharmony_ci content: ""; 741cb0ef41Sopenharmony_ci display: block; 751cb0ef41Sopenharmony_ci clear: both; 761cb0ef41Sopenharmony_ci} 771cb0ef41Sopenharmony_ci 781cb0ef41Sopenharmony_ci#content { 791cb0ef41Sopenharmony_ci margin: 0 auto; 801cb0ef41Sopenharmony_ci padding: 0 4em; 811cb0ef41Sopenharmony_ci} 821cb0ef41Sopenharmony_ci 831cb0ef41Sopenharmony_ci#table_of_contents > h2 { 841cb0ef41Sopenharmony_ci font-size: 1.17em; 851cb0ef41Sopenharmony_ci} 861cb0ef41Sopenharmony_ci#table_of_contents ul:first-child { 871cb0ef41Sopenharmony_ci border: solid 1px #e1e4e8; 881cb0ef41Sopenharmony_ci border-radius: 6px; 891cb0ef41Sopenharmony_ci padding: 1em; 901cb0ef41Sopenharmony_ci background-color: #f6f8fa; 911cb0ef41Sopenharmony_ci color: #393a34; 921cb0ef41Sopenharmony_ci} 931cb0ef41Sopenharmony_ci#table_of_contents ul { 941cb0ef41Sopenharmony_ci list-style-type: none; 951cb0ef41Sopenharmony_ci padding-left: 1.5em; 961cb0ef41Sopenharmony_ci} 971cb0ef41Sopenharmony_ci#table_of_contents li { 981cb0ef41Sopenharmony_ci font-size: 0.9em; 991cb0ef41Sopenharmony_ci} 1001cb0ef41Sopenharmony_ci#table_of_contents li a { 1011cb0ef41Sopenharmony_ci color: #000000; 1021cb0ef41Sopenharmony_ci} 1031cb0ef41Sopenharmony_ci 1041cb0ef41Sopenharmony_ciheader.title { 1051cb0ef41Sopenharmony_ci border-bottom: solid 1px #e1e4e8; 1061cb0ef41Sopenharmony_ci} 1071cb0ef41Sopenharmony_ciheader.title > h1 { 1081cb0ef41Sopenharmony_ci margin-bottom: 0.25em; 1091cb0ef41Sopenharmony_ci} 1101cb0ef41Sopenharmony_ciheader.title > .description { 1111cb0ef41Sopenharmony_ci display: block; 1121cb0ef41Sopenharmony_ci margin-bottom: 0.5em; 1131cb0ef41Sopenharmony_ci line-height: 1; 1141cb0ef41Sopenharmony_ci} 1151cb0ef41Sopenharmony_ci 1161cb0ef41Sopenharmony_cifooter#edit { 1171cb0ef41Sopenharmony_ci border-top: solid 1px #e1e4e8; 1181cb0ef41Sopenharmony_ci margin: 3em 0 4em 0; 1191cb0ef41Sopenharmony_ci padding-top: 2em; 1201cb0ef41Sopenharmony_ci} 1211cb0ef41Sopenharmony_ci</style> 1221cb0ef41Sopenharmony_ci</head> 1231cb0ef41Sopenharmony_ci<body> 1241cb0ef41Sopenharmony_ci<div id="banner"> 1251cb0ef41Sopenharmony_ci<div id="rainbar"></div> 1261cb0ef41Sopenharmony_ci<div id="logobar"> 1271cb0ef41Sopenharmony_ci<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700"> 1281cb0ef41Sopenharmony_ci<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon> 1291cb0ef41Sopenharmony_ci<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon> 1301cb0ef41Sopenharmony_ci</svg> 1311cb0ef41Sopenharmony_ci<div class="title"> 1321cb0ef41Sopenharmony_cinpm command-line interface 1331cb0ef41Sopenharmony_ci</div> 1341cb0ef41Sopenharmony_ci</div> 1351cb0ef41Sopenharmony_ci</div> 1361cb0ef41Sopenharmony_ci 1371cb0ef41Sopenharmony_ci<section id="content"> 1381cb0ef41Sopenharmony_ci<header class="title"> 1391cb0ef41Sopenharmony_ci<h1 id="npm-ls">npm-ls</h1> 1401cb0ef41Sopenharmony_ci<span class="description">List installed packages</span> 1411cb0ef41Sopenharmony_ci</header> 1421cb0ef41Sopenharmony_ci 1431cb0ef41Sopenharmony_ci<section id="table_of_contents"> 1441cb0ef41Sopenharmony_ci<h2 id="table-of-contents">Table of contents</h2> 1451cb0ef41Sopenharmony_ci<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#note-design-changes-pending">Note: Design Changes Pending</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> 1461cb0ef41Sopenharmony_ci</section> 1471cb0ef41Sopenharmony_ci 1481cb0ef41Sopenharmony_ci<div id="_content"><h3 id="synopsis">Synopsis</h3> 1491cb0ef41Sopenharmony_ci<pre><code class="language-bash">npm ls <package-spec> 1501cb0ef41Sopenharmony_ci 1511cb0ef41Sopenharmony_cialias: list 1521cb0ef41Sopenharmony_ci</code></pre> 1531cb0ef41Sopenharmony_ci<h3 id="description">Description</h3> 1541cb0ef41Sopenharmony_ci<p>This command will print to stdout all the versions of packages that are 1551cb0ef41Sopenharmony_ciinstalled, as well as their dependencies when <code>--all</code> is specified, in a 1561cb0ef41Sopenharmony_citree structure.</p> 1571cb0ef41Sopenharmony_ci<p>Note: to get a "bottoms up" view of why a given package is included in the 1581cb0ef41Sopenharmony_citree at all, use <a href="../commands/npm-explain.html"><code>npm explain</code></a>.</p> 1591cb0ef41Sopenharmony_ci<p>Positional arguments are <code>name@version-range</code> identifiers, which will limit 1601cb0ef41Sopenharmony_cithe results to only the paths to the packages named. Note that nested 1611cb0ef41Sopenharmony_cipackages will <em>also</em> show the paths to the specified packages. For 1621cb0ef41Sopenharmony_ciexample, running <code>npm ls promzard</code> in npm's source tree will show:</p> 1631cb0ef41Sopenharmony_ci<pre><code class="language-bash">npm@10.5.0 /path/to/npm 1641cb0ef41Sopenharmony_ci└─┬ init-package-json@0.0.4 1651cb0ef41Sopenharmony_ci └── promzard@0.1.5 1661cb0ef41Sopenharmony_ci</code></pre> 1671cb0ef41Sopenharmony_ci<p>It will print out extraneous, missing, and invalid packages.</p> 1681cb0ef41Sopenharmony_ci<p>If a project specifies git urls for dependencies these are shown 1691cb0ef41Sopenharmony_ciin parentheses after the <code>name@version</code> to make it easier for users to 1701cb0ef41Sopenharmony_cirecognize potential forks of a project.</p> 1711cb0ef41Sopenharmony_ci<p>The tree shown is the logical dependency tree, based on package 1721cb0ef41Sopenharmony_cidependencies, not the physical layout of your <code>node_modules</code> folder.</p> 1731cb0ef41Sopenharmony_ci<p>When run as <code>ll</code> or <code>la</code>, it shows extended information by default.</p> 1741cb0ef41Sopenharmony_ci<h3 id="note-design-changes-pending">Note: Design Changes Pending</h3> 1751cb0ef41Sopenharmony_ci<p>The <code>npm ls</code> command's output and behavior made a <em>ton</em> of sense when npm 1761cb0ef41Sopenharmony_cicreated a <code>node_modules</code> folder that naively nested every dependency. In 1771cb0ef41Sopenharmony_cisuch a case, the logical dependency graph and physical tree of packages on 1781cb0ef41Sopenharmony_cidisk would be roughly identical.</p> 1791cb0ef41Sopenharmony_ci<p>With the advent of automatic install-time deduplication of dependencies in 1801cb0ef41Sopenharmony_cinpm v3, the <code>ls</code> output was modified to display the logical dependency 1811cb0ef41Sopenharmony_cigraph as a tree structure, since this was more useful to most users. 1821cb0ef41Sopenharmony_ciHowever, without using <code>npm ls -l</code>, it became impossible to show <em>where</em> a 1831cb0ef41Sopenharmony_cipackage was actually installed much of the time!</p> 1841cb0ef41Sopenharmony_ci<p>With the advent of automatic installation of <code>peerDependencies</code> in npm v7, 1851cb0ef41Sopenharmony_cithis gets even more curious, as <code>peerDependencies</code> are logically 1861cb0ef41Sopenharmony_ci"underneath" their dependents in the dependency graph, but are always 1871cb0ef41Sopenharmony_ciphysically at or above their location on disk.</p> 1881cb0ef41Sopenharmony_ci<p>Also, in the years since npm got an <code>ls</code> command (in version 0.0.2!), 1891cb0ef41Sopenharmony_cidependency graphs have gotten much larger as a general rule. Therefore, in 1901cb0ef41Sopenharmony_ciorder to avoid dumping an excessive amount of content to the terminal, <code>npm ls</code> now only shows the <em>top</em> level dependencies, unless <code>--all</code> is 1911cb0ef41Sopenharmony_ciprovided.</p> 1921cb0ef41Sopenharmony_ci<p>A thorough re-examination of the use cases, intention, behavior, and output 1931cb0ef41Sopenharmony_ciof this command, is currently underway. Expect significant changes to at 1941cb0ef41Sopenharmony_cileast the default human-readable <code>npm ls</code> output in npm v8.</p> 1951cb0ef41Sopenharmony_ci<h3 id="configuration">Configuration</h3> 1961cb0ef41Sopenharmony_ci<h4 id="all"><code>all</code></h4> 1971cb0ef41Sopenharmony_ci<ul> 1981cb0ef41Sopenharmony_ci<li>Default: false</li> 1991cb0ef41Sopenharmony_ci<li>Type: Boolean</li> 2001cb0ef41Sopenharmony_ci</ul> 2011cb0ef41Sopenharmony_ci<p>When running <code>npm outdated</code> and <code>npm ls</code>, setting <code>--all</code> will show all 2021cb0ef41Sopenharmony_cioutdated or installed packages, rather than only those directly depended 2031cb0ef41Sopenharmony_ciupon by the current project.</p> 2041cb0ef41Sopenharmony_ci<h4 id="json"><code>json</code></h4> 2051cb0ef41Sopenharmony_ci<ul> 2061cb0ef41Sopenharmony_ci<li>Default: false</li> 2071cb0ef41Sopenharmony_ci<li>Type: Boolean</li> 2081cb0ef41Sopenharmony_ci</ul> 2091cb0ef41Sopenharmony_ci<p>Whether or not to output JSON data, rather than the normal output.</p> 2101cb0ef41Sopenharmony_ci<ul> 2111cb0ef41Sopenharmony_ci<li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before 2121cb0ef41Sopenharmony_cisaving them to your <code>package.json</code>.</li> 2131cb0ef41Sopenharmony_ci</ul> 2141cb0ef41Sopenharmony_ci<p>Not supported by all npm commands.</p> 2151cb0ef41Sopenharmony_ci<h4 id="long"><code>long</code></h4> 2161cb0ef41Sopenharmony_ci<ul> 2171cb0ef41Sopenharmony_ci<li>Default: false</li> 2181cb0ef41Sopenharmony_ci<li>Type: Boolean</li> 2191cb0ef41Sopenharmony_ci</ul> 2201cb0ef41Sopenharmony_ci<p>Show extended information in <code>ls</code>, <code>search</code>, and <code>help-search</code>.</p> 2211cb0ef41Sopenharmony_ci<h4 id="parseable"><code>parseable</code></h4> 2221cb0ef41Sopenharmony_ci<ul> 2231cb0ef41Sopenharmony_ci<li>Default: false</li> 2241cb0ef41Sopenharmony_ci<li>Type: Boolean</li> 2251cb0ef41Sopenharmony_ci</ul> 2261cb0ef41Sopenharmony_ci<p>Output parseable results from commands that write to standard output. For 2271cb0ef41Sopenharmony_ci<code>npm search</code>, this will be tab-separated table format.</p> 2281cb0ef41Sopenharmony_ci<h4 id="global"><code>global</code></h4> 2291cb0ef41Sopenharmony_ci<ul> 2301cb0ef41Sopenharmony_ci<li>Default: false</li> 2311cb0ef41Sopenharmony_ci<li>Type: Boolean</li> 2321cb0ef41Sopenharmony_ci</ul> 2331cb0ef41Sopenharmony_ci<p>Operates in "global" mode, so that packages are installed into the <code>prefix</code> 2341cb0ef41Sopenharmony_cifolder instead of the current working directory. See 2351cb0ef41Sopenharmony_ci<a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p> 2361cb0ef41Sopenharmony_ci<ul> 2371cb0ef41Sopenharmony_ci<li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead 2381cb0ef41Sopenharmony_ciof the current working directory.</li> 2391cb0ef41Sopenharmony_ci<li>bin files are linked to <code>{prefix}/bin</code></li> 2401cb0ef41Sopenharmony_ci<li>man pages are linked to <code>{prefix}/share/man</code></li> 2411cb0ef41Sopenharmony_ci</ul> 2421cb0ef41Sopenharmony_ci<h4 id="depth"><code>depth</code></h4> 2431cb0ef41Sopenharmony_ci<ul> 2441cb0ef41Sopenharmony_ci<li>Default: <code>Infinity</code> if <code>--all</code> is set, otherwise <code>1</code></li> 2451cb0ef41Sopenharmony_ci<li>Type: null or Number</li> 2461cb0ef41Sopenharmony_ci</ul> 2471cb0ef41Sopenharmony_ci<p>The depth to go when recursing packages for <code>npm ls</code>.</p> 2481cb0ef41Sopenharmony_ci<p>If not set, <code>npm ls</code> will show only the immediate dependencies of the root 2491cb0ef41Sopenharmony_ciproject. If <code>--all</code> is set, then npm will show all dependencies by default.</p> 2501cb0ef41Sopenharmony_ci<h4 id="omit"><code>omit</code></h4> 2511cb0ef41Sopenharmony_ci<ul> 2521cb0ef41Sopenharmony_ci<li>Default: 'dev' if the <code>NODE_ENV</code> environment variable is set to 2531cb0ef41Sopenharmony_ci'production', otherwise empty.</li> 2541cb0ef41Sopenharmony_ci<li>Type: "dev", "optional", or "peer" (can be set multiple times)</li> 2551cb0ef41Sopenharmony_ci</ul> 2561cb0ef41Sopenharmony_ci<p>Dependency types to omit from the installation tree on disk.</p> 2571cb0ef41Sopenharmony_ci<p>Note that these dependencies <em>are</em> still resolved and added to the 2581cb0ef41Sopenharmony_ci<code>package-lock.json</code> or <code>npm-shrinkwrap.json</code> file. They are just not 2591cb0ef41Sopenharmony_ciphysically installed on disk.</p> 2601cb0ef41Sopenharmony_ci<p>If a package type appears in both the <code>--include</code> and <code>--omit</code> lists, then 2611cb0ef41Sopenharmony_ciit will be included.</p> 2621cb0ef41Sopenharmony_ci<p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment 2631cb0ef41Sopenharmony_civariable will be set to <code>'production'</code> for all lifecycle scripts.</p> 2641cb0ef41Sopenharmony_ci<h4 id="include"><code>include</code></h4> 2651cb0ef41Sopenharmony_ci<ul> 2661cb0ef41Sopenharmony_ci<li>Default:</li> 2671cb0ef41Sopenharmony_ci<li>Type: "prod", "dev", "optional", or "peer" (can be set multiple times)</li> 2681cb0ef41Sopenharmony_ci</ul> 2691cb0ef41Sopenharmony_ci<p>Option that allows for defining which types of dependencies to install.</p> 2701cb0ef41Sopenharmony_ci<p>This is the inverse of <code>--omit=<type></code>.</p> 2711cb0ef41Sopenharmony_ci<p>Dependency types specified in <code>--include</code> will not be omitted, regardless of 2721cb0ef41Sopenharmony_cithe order in which omit/include are specified on the command-line.</p> 2731cb0ef41Sopenharmony_ci<h4 id="link"><code>link</code></h4> 2741cb0ef41Sopenharmony_ci<ul> 2751cb0ef41Sopenharmony_ci<li>Default: false</li> 2761cb0ef41Sopenharmony_ci<li>Type: Boolean</li> 2771cb0ef41Sopenharmony_ci</ul> 2781cb0ef41Sopenharmony_ci<p>Used with <code>npm ls</code>, limiting output to only those packages that are linked.</p> 2791cb0ef41Sopenharmony_ci<h4 id="package-lock-only"><code>package-lock-only</code></h4> 2801cb0ef41Sopenharmony_ci<ul> 2811cb0ef41Sopenharmony_ci<li>Default: false</li> 2821cb0ef41Sopenharmony_ci<li>Type: Boolean</li> 2831cb0ef41Sopenharmony_ci</ul> 2841cb0ef41Sopenharmony_ci<p>If set to true, the current operation will only use the <code>package-lock.json</code>, 2851cb0ef41Sopenharmony_ciignoring <code>node_modules</code>.</p> 2861cb0ef41Sopenharmony_ci<p>For <code>update</code> this means only the <code>package-lock.json</code> will be updated, 2871cb0ef41Sopenharmony_ciinstead of checking <code>node_modules</code> and downloading dependencies.</p> 2881cb0ef41Sopenharmony_ci<p>For <code>list</code> this means the output will be based on the tree described by the 2891cb0ef41Sopenharmony_ci<code>package-lock.json</code>, rather than the contents of <code>node_modules</code>.</p> 2901cb0ef41Sopenharmony_ci<h4 id="unicode"><code>unicode</code></h4> 2911cb0ef41Sopenharmony_ci<ul> 2921cb0ef41Sopenharmony_ci<li>Default: false on windows, true on mac/unix systems with a unicode locale, 2931cb0ef41Sopenharmony_cias defined by the <code>LC_ALL</code>, <code>LC_CTYPE</code>, or <code>LANG</code> environment variables.</li> 2941cb0ef41Sopenharmony_ci<li>Type: Boolean</li> 2951cb0ef41Sopenharmony_ci</ul> 2961cb0ef41Sopenharmony_ci<p>When set to true, npm uses unicode characters in the tree output. When 2971cb0ef41Sopenharmony_cifalse, it uses ascii characters instead of unicode glyphs.</p> 2981cb0ef41Sopenharmony_ci<h4 id="workspace"><code>workspace</code></h4> 2991cb0ef41Sopenharmony_ci<ul> 3001cb0ef41Sopenharmony_ci<li>Default:</li> 3011cb0ef41Sopenharmony_ci<li>Type: String (can be set multiple times)</li> 3021cb0ef41Sopenharmony_ci</ul> 3031cb0ef41Sopenharmony_ci<p>Enable running a command in the context of the configured workspaces of the 3041cb0ef41Sopenharmony_cicurrent project while filtering by running only the workspaces defined by 3051cb0ef41Sopenharmony_cithis configuration option.</p> 3061cb0ef41Sopenharmony_ci<p>Valid values for the <code>workspace</code> config are either:</p> 3071cb0ef41Sopenharmony_ci<ul> 3081cb0ef41Sopenharmony_ci<li>Workspace names</li> 3091cb0ef41Sopenharmony_ci<li>Path to a workspace directory</li> 3101cb0ef41Sopenharmony_ci<li>Path to a parent workspace directory (will result in selecting all 3111cb0ef41Sopenharmony_ciworkspaces within that folder)</li> 3121cb0ef41Sopenharmony_ci</ul> 3131cb0ef41Sopenharmony_ci<p>When set for the <code>npm init</code> command, this may be set to the folder of a 3141cb0ef41Sopenharmony_ciworkspace which does not yet exist, to create the folder and set it up as a 3151cb0ef41Sopenharmony_cibrand new workspace within the project.</p> 3161cb0ef41Sopenharmony_ci<p>This value is not exported to the environment for child processes.</p> 3171cb0ef41Sopenharmony_ci<h4 id="workspaces"><code>workspaces</code></h4> 3181cb0ef41Sopenharmony_ci<ul> 3191cb0ef41Sopenharmony_ci<li>Default: null</li> 3201cb0ef41Sopenharmony_ci<li>Type: null or Boolean</li> 3211cb0ef41Sopenharmony_ci</ul> 3221cb0ef41Sopenharmony_ci<p>Set to true to run the command in the context of <strong>all</strong> configured 3231cb0ef41Sopenharmony_ciworkspaces.</p> 3241cb0ef41Sopenharmony_ci<p>Explicitly setting this to false will cause commands like <code>install</code> to 3251cb0ef41Sopenharmony_ciignore workspaces altogether. When not set explicitly:</p> 3261cb0ef41Sopenharmony_ci<ul> 3271cb0ef41Sopenharmony_ci<li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.) 3281cb0ef41Sopenharmony_ciwill link workspaces into the <code>node_modules</code> folder. - Commands that do 3291cb0ef41Sopenharmony_ciother things (test, exec, publish, etc.) will operate on the root project, 3301cb0ef41Sopenharmony_ci<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li> 3311cb0ef41Sopenharmony_ci</ul> 3321cb0ef41Sopenharmony_ci<p>This value is not exported to the environment for child processes.</p> 3331cb0ef41Sopenharmony_ci<h4 id="include-workspace-root"><code>include-workspace-root</code></h4> 3341cb0ef41Sopenharmony_ci<ul> 3351cb0ef41Sopenharmony_ci<li>Default: false</li> 3361cb0ef41Sopenharmony_ci<li>Type: Boolean</li> 3371cb0ef41Sopenharmony_ci</ul> 3381cb0ef41Sopenharmony_ci<p>Include the workspace root when workspaces are enabled for a command.</p> 3391cb0ef41Sopenharmony_ci<p>When false, specifying individual workspaces via the <code>workspace</code> config, or 3401cb0ef41Sopenharmony_ciall workspaces via the <code>workspaces</code> flag, will cause npm to operate only on 3411cb0ef41Sopenharmony_cithe specified workspaces, and not on the root project.</p> 3421cb0ef41Sopenharmony_ci<p>This value is not exported to the environment for child processes.</p> 3431cb0ef41Sopenharmony_ci<h4 id="install-links"><code>install-links</code></h4> 3441cb0ef41Sopenharmony_ci<ul> 3451cb0ef41Sopenharmony_ci<li>Default: false</li> 3461cb0ef41Sopenharmony_ci<li>Type: Boolean</li> 3471cb0ef41Sopenharmony_ci</ul> 3481cb0ef41Sopenharmony_ci<p>When set file: protocol dependencies will be packed and installed as regular 3491cb0ef41Sopenharmony_cidependencies instead of creating a symlink. This option has no effect on 3501cb0ef41Sopenharmony_ciworkspaces.</p> 3511cb0ef41Sopenharmony_ci<h3 id="see-also">See Also</h3> 3521cb0ef41Sopenharmony_ci<ul> 3531cb0ef41Sopenharmony_ci<li><a href="../using-npm/package-spec.html">package spec</a></li> 3541cb0ef41Sopenharmony_ci<li><a href="../commands/npm-explain.html">npm explain</a></li> 3551cb0ef41Sopenharmony_ci<li><a href="../commands/npm-config.html">npm config</a></li> 3561cb0ef41Sopenharmony_ci<li><a href="../configuring-npm/npmrc.html">npmrc</a></li> 3571cb0ef41Sopenharmony_ci<li><a href="../configuring-npm/folders.html">npm folders</a></li> 3581cb0ef41Sopenharmony_ci<li><a href="../commands/npm-explain.html">npm explain</a></li> 3591cb0ef41Sopenharmony_ci<li><a href="../commands/npm-install.html">npm install</a></li> 3601cb0ef41Sopenharmony_ci<li><a href="../commands/npm-link.html">npm link</a></li> 3611cb0ef41Sopenharmony_ci<li><a href="../commands/npm-prune.html">npm prune</a></li> 3621cb0ef41Sopenharmony_ci<li><a href="../commands/npm-outdated.html">npm outdated</a></li> 3631cb0ef41Sopenharmony_ci<li><a href="../commands/npm-update.html">npm update</a></li> 3641cb0ef41Sopenharmony_ci</ul></div> 3651cb0ef41Sopenharmony_ci 3661cb0ef41Sopenharmony_ci<footer id="edit"> 3671cb0ef41Sopenharmony_ci<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-ls.md"> 3681cb0ef41Sopenharmony_ci<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;"> 3691cb0ef41Sopenharmony_ci<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> 3701cb0ef41Sopenharmony_ci</svg> 3711cb0ef41Sopenharmony_ciEdit this page on GitHub 3721cb0ef41Sopenharmony_ci</a> 3731cb0ef41Sopenharmony_ci</footer> 3741cb0ef41Sopenharmony_ci</section> 3751cb0ef41Sopenharmony_ci 3761cb0ef41Sopenharmony_ci 3771cb0ef41Sopenharmony_ci 3781cb0ef41Sopenharmony_ci</body></html>