11cb0ef41Sopenharmony_ci<!DOCTYPE html><html><head> 21cb0ef41Sopenharmony_ci<meta charset="utf-8"> 31cb0ef41Sopenharmony_ci<title>npm-docs</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-docs">npm-docs</h1> 1401cb0ef41Sopenharmony_ci<span class="description">Open documentation for a package in a web browser</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="#configuration">Configuration</a></li><ul><li><a href="#browser"><code>browser</code></a></li><li><a href="#registry"><code>registry</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></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 docs [<pkgname> [<pkgname> ...]] 1501cb0ef41Sopenharmony_ci 1511cb0ef41Sopenharmony_cialias: home 1521cb0ef41Sopenharmony_ci</code></pre> 1531cb0ef41Sopenharmony_ci<h3 id="description">Description</h3> 1541cb0ef41Sopenharmony_ci<p>This command tries to guess at the likely location of a package's 1551cb0ef41Sopenharmony_cidocumentation URL, and then tries to open it using the 1561cb0ef41Sopenharmony_ci<a href="../using-npm/config#browser.html"><code>--browser</code> config</a> param. You can pass multiple 1571cb0ef41Sopenharmony_cipackage names at once. If no package name is provided, it will search for a 1581cb0ef41Sopenharmony_ci<code>package.json</code> in the current folder and use the <code>name</code> property.</p> 1591cb0ef41Sopenharmony_ci<h3 id="configuration">Configuration</h3> 1601cb0ef41Sopenharmony_ci<h4 id="browser"><code>browser</code></h4> 1611cb0ef41Sopenharmony_ci<ul> 1621cb0ef41Sopenharmony_ci<li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li> 1631cb0ef41Sopenharmony_ci<li>Type: null, Boolean, or String</li> 1641cb0ef41Sopenharmony_ci</ul> 1651cb0ef41Sopenharmony_ci<p>The browser that is called by npm commands to open websites.</p> 1661cb0ef41Sopenharmony_ci<p>Set to <code>false</code> to suppress browser behavior and instead print urls to 1671cb0ef41Sopenharmony_citerminal.</p> 1681cb0ef41Sopenharmony_ci<p>Set to <code>true</code> to use default system URL opener.</p> 1691cb0ef41Sopenharmony_ci<h4 id="registry"><code>registry</code></h4> 1701cb0ef41Sopenharmony_ci<ul> 1711cb0ef41Sopenharmony_ci<li>Default: "<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>"</li> 1721cb0ef41Sopenharmony_ci<li>Type: URL</li> 1731cb0ef41Sopenharmony_ci</ul> 1741cb0ef41Sopenharmony_ci<p>The base URL of the npm registry.</p> 1751cb0ef41Sopenharmony_ci<h4 id="workspace"><code>workspace</code></h4> 1761cb0ef41Sopenharmony_ci<ul> 1771cb0ef41Sopenharmony_ci<li>Default:</li> 1781cb0ef41Sopenharmony_ci<li>Type: String (can be set multiple times)</li> 1791cb0ef41Sopenharmony_ci</ul> 1801cb0ef41Sopenharmony_ci<p>Enable running a command in the context of the configured workspaces of the 1811cb0ef41Sopenharmony_cicurrent project while filtering by running only the workspaces defined by 1821cb0ef41Sopenharmony_cithis configuration option.</p> 1831cb0ef41Sopenharmony_ci<p>Valid values for the <code>workspace</code> config are either:</p> 1841cb0ef41Sopenharmony_ci<ul> 1851cb0ef41Sopenharmony_ci<li>Workspace names</li> 1861cb0ef41Sopenharmony_ci<li>Path to a workspace directory</li> 1871cb0ef41Sopenharmony_ci<li>Path to a parent workspace directory (will result in selecting all 1881cb0ef41Sopenharmony_ciworkspaces within that folder)</li> 1891cb0ef41Sopenharmony_ci</ul> 1901cb0ef41Sopenharmony_ci<p>When set for the <code>npm init</code> command, this may be set to the folder of a 1911cb0ef41Sopenharmony_ciworkspace which does not yet exist, to create the folder and set it up as a 1921cb0ef41Sopenharmony_cibrand new workspace within the project.</p> 1931cb0ef41Sopenharmony_ci<p>This value is not exported to the environment for child processes.</p> 1941cb0ef41Sopenharmony_ci<h4 id="workspaces"><code>workspaces</code></h4> 1951cb0ef41Sopenharmony_ci<ul> 1961cb0ef41Sopenharmony_ci<li>Default: null</li> 1971cb0ef41Sopenharmony_ci<li>Type: null or Boolean</li> 1981cb0ef41Sopenharmony_ci</ul> 1991cb0ef41Sopenharmony_ci<p>Set to true to run the command in the context of <strong>all</strong> configured 2001cb0ef41Sopenharmony_ciworkspaces.</p> 2011cb0ef41Sopenharmony_ci<p>Explicitly setting this to false will cause commands like <code>install</code> to 2021cb0ef41Sopenharmony_ciignore workspaces altogether. When not set explicitly:</p> 2031cb0ef41Sopenharmony_ci<ul> 2041cb0ef41Sopenharmony_ci<li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.) 2051cb0ef41Sopenharmony_ciwill link workspaces into the <code>node_modules</code> folder. - Commands that do 2061cb0ef41Sopenharmony_ciother things (test, exec, publish, etc.) will operate on the root project, 2071cb0ef41Sopenharmony_ci<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li> 2081cb0ef41Sopenharmony_ci</ul> 2091cb0ef41Sopenharmony_ci<p>This value is not exported to the environment for child processes.</p> 2101cb0ef41Sopenharmony_ci<h4 id="include-workspace-root"><code>include-workspace-root</code></h4> 2111cb0ef41Sopenharmony_ci<ul> 2121cb0ef41Sopenharmony_ci<li>Default: false</li> 2131cb0ef41Sopenharmony_ci<li>Type: Boolean</li> 2141cb0ef41Sopenharmony_ci</ul> 2151cb0ef41Sopenharmony_ci<p>Include the workspace root when workspaces are enabled for a command.</p> 2161cb0ef41Sopenharmony_ci<p>When false, specifying individual workspaces via the <code>workspace</code> config, or 2171cb0ef41Sopenharmony_ciall workspaces via the <code>workspaces</code> flag, will cause npm to operate only on 2181cb0ef41Sopenharmony_cithe specified workspaces, and not on the root project.</p> 2191cb0ef41Sopenharmony_ci<p>This value is not exported to the environment for child processes.</p> 2201cb0ef41Sopenharmony_ci<h3 id="see-also">See Also</h3> 2211cb0ef41Sopenharmony_ci<ul> 2221cb0ef41Sopenharmony_ci<li><a href="../commands/npm-view.html">npm view</a></li> 2231cb0ef41Sopenharmony_ci<li><a href="../commands/npm-publish.html">npm publish</a></li> 2241cb0ef41Sopenharmony_ci<li><a href="../using-npm/registry.html">npm registry</a></li> 2251cb0ef41Sopenharmony_ci<li><a href="../commands/npm-config.html">npm config</a></li> 2261cb0ef41Sopenharmony_ci<li><a href="../configuring-npm/npmrc.html">npmrc</a></li> 2271cb0ef41Sopenharmony_ci<li><a href="../configuring-npm/package-json.html">package.json</a></li> 2281cb0ef41Sopenharmony_ci</ul></div> 2291cb0ef41Sopenharmony_ci 2301cb0ef41Sopenharmony_ci<footer id="edit"> 2311cb0ef41Sopenharmony_ci<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-docs.md"> 2321cb0ef41Sopenharmony_ci<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;"> 2331cb0ef41Sopenharmony_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> 2341cb0ef41Sopenharmony_ci</svg> 2351cb0ef41Sopenharmony_ciEdit this page on GitHub 2361cb0ef41Sopenharmony_ci</a> 2371cb0ef41Sopenharmony_ci</footer> 2381cb0ef41Sopenharmony_ci</section> 2391cb0ef41Sopenharmony_ci 2401cb0ef41Sopenharmony_ci 2411cb0ef41Sopenharmony_ci 2421cb0ef41Sopenharmony_ci</body></html>