11cb0ef41Sopenharmony_ci<!DOCTYPE html><html><head>
21cb0ef41Sopenharmony_ci<meta charset="utf-8">
31cb0ef41Sopenharmony_ci<title>npm</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">npm</h1>
1401cb0ef41Sopenharmony_ci<span class="description">javascript package manager</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="#version">Version</a></li><li><a href="#description">Description</a></li><li><a href="#important">Important</a></li><li><a href="#introduction">Introduction</a></li><li><a href="#dependencies">Dependencies</a></li><li><a href="#directories">Directories</a></li><li><a href="#developer-usage">Developer Usage</a></li><ul><li><a href="#configuration">Configuration</a></li></ul><li><a href="#contributions">Contributions</a></li><li><a href="#bugs">Bugs</a></li><li><a href="#feature-requests">Feature Requests</a></li><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
1501cb0ef41Sopenharmony_ci</code></pre>
1511cb0ef41Sopenharmony_ci<p>Note: This command is unaware of workspaces.</p>
1521cb0ef41Sopenharmony_ci<h3 id="version">Version</h3>
1531cb0ef41Sopenharmony_ci<p>10.5.0</p>
1541cb0ef41Sopenharmony_ci<h3 id="description">Description</h3>
1551cb0ef41Sopenharmony_ci<p>npm is the package manager for the Node JavaScript platform.  It puts
1561cb0ef41Sopenharmony_cimodules in place so that node can find them, and manages dependency
1571cb0ef41Sopenharmony_ciconflicts intelligently.</p>
1581cb0ef41Sopenharmony_ci<p>It is extremely configurable to support a variety of use cases.  Most
1591cb0ef41Sopenharmony_cicommonly, you use it to publish, discover, install, and develop node
1601cb0ef41Sopenharmony_ciprograms.</p>
1611cb0ef41Sopenharmony_ci<p>Run <code>npm help</code> to get a list of available commands.</p>
1621cb0ef41Sopenharmony_ci<h3 id="important">Important</h3>
1631cb0ef41Sopenharmony_ci<p>npm comes preconfigured to use npm's public registry at
1641cb0ef41Sopenharmony_ci<a href="https://registry.npmjs.org">https://registry.npmjs.org</a> by default. Use of the npm public registry is
1651cb0ef41Sopenharmony_cisubject to terms of use available at
1661cb0ef41Sopenharmony_ci<a href="https://docs.npmjs.com/policies/terms">https://docs.npmjs.com/policies/terms</a>.</p>
1671cb0ef41Sopenharmony_ci<p>You can configure npm to use any compatible registry you like, and even
1681cb0ef41Sopenharmony_cirun your own registry. Use of someone else's registry is governed by
1691cb0ef41Sopenharmony_citheir terms of use.</p>
1701cb0ef41Sopenharmony_ci<h3 id="introduction">Introduction</h3>
1711cb0ef41Sopenharmony_ci<p>You probably got npm because you want to install stuff.</p>
1721cb0ef41Sopenharmony_ci<p>The very first thing you will most likely want to run in any node
1731cb0ef41Sopenharmony_ciprogram is <code>npm install</code> to install its dependencies.</p>
1741cb0ef41Sopenharmony_ci<p>You can also run <code>npm install blerg</code> to install the latest version of
1751cb0ef41Sopenharmony_ci"blerg".  Check out <a href="../commands/npm-install.html"><code>npm install</code></a> for more
1761cb0ef41Sopenharmony_ciinfo.  It can do a lot of stuff.</p>
1771cb0ef41Sopenharmony_ci<p>Use the <code>npm search</code> command to show everything that's available in the
1781cb0ef41Sopenharmony_cipublic registry.  Use <code>npm ls</code> to show everything you've installed.</p>
1791cb0ef41Sopenharmony_ci<h3 id="dependencies">Dependencies</h3>
1801cb0ef41Sopenharmony_ci<p>If a package lists a dependency using a git URL, npm will install that
1811cb0ef41Sopenharmony_cidependency using the <a href="https://github.com/git-guides/install-git"><code>git</code></a>
1821cb0ef41Sopenharmony_cicommand and will generate an error if it is not installed.</p>
1831cb0ef41Sopenharmony_ci<p>If one of the packages npm tries to install is a native node module and
1841cb0ef41Sopenharmony_cirequires compiling of C++ Code, npm will use
1851cb0ef41Sopenharmony_ci<a href="https://github.com/nodejs/node-gyp">node-gyp</a> for that task.
1861cb0ef41Sopenharmony_ciFor a Unix system, <a href="https://github.com/nodejs/node-gyp">node-gyp</a>
1871cb0ef41Sopenharmony_cineeds Python, make and a buildchain like GCC. On Windows,
1881cb0ef41Sopenharmony_ciPython and Microsoft Visual Studio C++ are needed. For more information
1891cb0ef41Sopenharmony_civisit <a href="https://github.com/nodejs/node-gyp">the node-gyp repository</a> and
1901cb0ef41Sopenharmony_cithe <a href="https://github.com/nodejs/node-gyp/wiki">node-gyp Wiki</a>.</p>
1911cb0ef41Sopenharmony_ci<h3 id="directories">Directories</h3>
1921cb0ef41Sopenharmony_ci<p>See <a href="../configuring-npm/folders.html"><code>folders</code></a> to learn about where npm puts
1931cb0ef41Sopenharmony_cistuff.</p>
1941cb0ef41Sopenharmony_ci<p>In particular, npm has two modes of operation:</p>
1951cb0ef41Sopenharmony_ci<ul>
1961cb0ef41Sopenharmony_ci<li>local mode:
1971cb0ef41Sopenharmony_cinpm installs packages into the current project directory, which
1981cb0ef41Sopenharmony_cidefaults to the current working directory.  Packages install to
1991cb0ef41Sopenharmony_ci<code>./node_modules</code>, and bins to <code>./node_modules/.bin</code>.</li>
2001cb0ef41Sopenharmony_ci<li>global mode:
2011cb0ef41Sopenharmony_cinpm installs packages into the install prefix at
2021cb0ef41Sopenharmony_ci<code>$npm_config_prefix/lib/node_modules</code> and bins to
2031cb0ef41Sopenharmony_ci<code>$npm_config_prefix/bin</code>.</li>
2041cb0ef41Sopenharmony_ci</ul>
2051cb0ef41Sopenharmony_ci<p>Local mode is the default.  Use <code>-g</code> or <code>--global</code> on any command to
2061cb0ef41Sopenharmony_cirun in global mode instead.</p>
2071cb0ef41Sopenharmony_ci<h3 id="developer-usage">Developer Usage</h3>
2081cb0ef41Sopenharmony_ci<p>If you're using npm to develop and publish your code, check out the
2091cb0ef41Sopenharmony_cifollowing help topics:</p>
2101cb0ef41Sopenharmony_ci<ul>
2111cb0ef41Sopenharmony_ci<li>json:
2121cb0ef41Sopenharmony_ciMake a package.json file.  See
2131cb0ef41Sopenharmony_ci<a href="../configuring-npm/package-json.html"><code>package.json</code></a>.</li>
2141cb0ef41Sopenharmony_ci<li>link:
2151cb0ef41Sopenharmony_ciLinks your current working code into Node's path, so that you don't
2161cb0ef41Sopenharmony_cihave to reinstall every time you make a change.  Use <a href="../commands/npm-link.html"><code>npm link</code></a> to do this.</li>
2171cb0ef41Sopenharmony_ci<li>install:
2181cb0ef41Sopenharmony_ciIt's a good idea to install things if you don't need the symbolic
2191cb0ef41Sopenharmony_cilink.  Especially, installing other peoples code from the registry is
2201cb0ef41Sopenharmony_cidone via <a href="../commands/npm-install.html"><code>npm install</code></a></li>
2211cb0ef41Sopenharmony_ci<li>adduser:
2221cb0ef41Sopenharmony_ciCreate an account or log in.  When you do this, npm will store
2231cb0ef41Sopenharmony_cicredentials in the user config file.</li>
2241cb0ef41Sopenharmony_ci<li>publish:
2251cb0ef41Sopenharmony_ciUse the <a href="../commands/npm-publish.html"><code>npm publish</code></a> command to upload your
2261cb0ef41Sopenharmony_cicode to the registry.</li>
2271cb0ef41Sopenharmony_ci</ul>
2281cb0ef41Sopenharmony_ci<h4 id="configuration">Configuration</h4>
2291cb0ef41Sopenharmony_ci<p>npm is extremely configurable.  It reads its configuration options from
2301cb0ef41Sopenharmony_ci5 places.</p>
2311cb0ef41Sopenharmony_ci<ul>
2321cb0ef41Sopenharmony_ci<li>Command line switches:
2331cb0ef41Sopenharmony_ciSet a config with <code>--key val</code>.  All keys take a value, even if they
2341cb0ef41Sopenharmony_ciare booleans (the config parser doesn't know what the options are at
2351cb0ef41Sopenharmony_cithe time of parsing).  If you do not provide a value (<code>--key</code>) then
2361cb0ef41Sopenharmony_cithe option is set to boolean <code>true</code>.</li>
2371cb0ef41Sopenharmony_ci<li>Environment Variables:
2381cb0ef41Sopenharmony_ciSet any config by prefixing the name in an environment variable with
2391cb0ef41Sopenharmony_ci<code>npm_config_</code>.  For example, <code>export npm_config_key=val</code>.</li>
2401cb0ef41Sopenharmony_ci<li>User Configs:
2411cb0ef41Sopenharmony_ciThe file at <code>$HOME/.npmrc</code> is an ini-formatted list of configs.  If
2421cb0ef41Sopenharmony_cipresent, it is parsed.  If the <code>userconfig</code> option is set in the cli
2431cb0ef41Sopenharmony_cior env, that file will be used instead.</li>
2441cb0ef41Sopenharmony_ci<li>Global Configs:
2451cb0ef41Sopenharmony_ciThe file found at <code>./etc/npmrc</code> (relative to the global prefix will be
2461cb0ef41Sopenharmony_ciparsed if it is found.  See <a href="../commands/npm-prefix.html"><code>npm prefix</code></a> for
2471cb0ef41Sopenharmony_cimore info on the global prefix.  If the <code>globalconfig</code> option is set
2481cb0ef41Sopenharmony_ciin the cli, env, or user config, then that file is parsed instead.</li>
2491cb0ef41Sopenharmony_ci<li>Defaults:
2501cb0ef41Sopenharmony_cinpm's default configuration options are defined in
2511cb0ef41Sopenharmony_ci<code>lib/utils/config/definitions.js</code>.  These must not be changed.</li>
2521cb0ef41Sopenharmony_ci</ul>
2531cb0ef41Sopenharmony_ci<p>See <a href="../using-npm/config.html"><code>config</code></a> for much much more information.</p>
2541cb0ef41Sopenharmony_ci<h3 id="contributions">Contributions</h3>
2551cb0ef41Sopenharmony_ci<p>Patches welcome!</p>
2561cb0ef41Sopenharmony_ci<p>If you would like to help, but don't know what to work on, read the
2571cb0ef41Sopenharmony_ci<a href="https://github.com/npm/cli/blob/latest/CONTRIBUTING.md">contributing
2581cb0ef41Sopenharmony_ciguidelines</a> and
2591cb0ef41Sopenharmony_cicheck the issues list.</p>
2601cb0ef41Sopenharmony_ci<h3 id="bugs">Bugs</h3>
2611cb0ef41Sopenharmony_ci<p>When you find issues, please report them:
2621cb0ef41Sopenharmony_ci<a href="https://github.com/npm/cli/issues">https://github.com/npm/cli/issues</a></p>
2631cb0ef41Sopenharmony_ci<p>Please be sure to follow the template and bug reporting guidelines.</p>
2641cb0ef41Sopenharmony_ci<h3 id="feature-requests">Feature Requests</h3>
2651cb0ef41Sopenharmony_ci<p>Discuss new feature ideas on our discussion forum:</p>
2661cb0ef41Sopenharmony_ci<ul>
2671cb0ef41Sopenharmony_ci<li><a href="https://github.com/npm/feedback">https://github.com/npm/feedback</a></li>
2681cb0ef41Sopenharmony_ci</ul>
2691cb0ef41Sopenharmony_ci<p>Or suggest formal RFC proposals:</p>
2701cb0ef41Sopenharmony_ci<ul>
2711cb0ef41Sopenharmony_ci<li><a href="https://github.com/npm/rfcs">https://github.com/npm/rfcs</a></li>
2721cb0ef41Sopenharmony_ci</ul>
2731cb0ef41Sopenharmony_ci<h3 id="see-also">See Also</h3>
2741cb0ef41Sopenharmony_ci<ul>
2751cb0ef41Sopenharmony_ci<li><a href="../commands/npm-help.html">npm help</a></li>
2761cb0ef41Sopenharmony_ci<li><a href="../configuring-npm/package-json.html">package.json</a></li>
2771cb0ef41Sopenharmony_ci<li><a href="../configuring-npm/npmrc.html">npmrc</a></li>
2781cb0ef41Sopenharmony_ci<li><a href="../commands/npm-config.html">npm config</a></li>
2791cb0ef41Sopenharmony_ci<li><a href="../commands/npm-install.html">npm install</a></li>
2801cb0ef41Sopenharmony_ci<li><a href="../commands/npm-prefix.html">npm prefix</a></li>
2811cb0ef41Sopenharmony_ci<li><a href="../commands/npm-publish.html">npm publish</a></li>
2821cb0ef41Sopenharmony_ci</ul></div>
2831cb0ef41Sopenharmony_ci
2841cb0ef41Sopenharmony_ci<footer id="edit">
2851cb0ef41Sopenharmony_ci<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm.md">
2861cb0ef41Sopenharmony_ci<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
2871cb0ef41Sopenharmony_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>
2881cb0ef41Sopenharmony_ci</svg>
2891cb0ef41Sopenharmony_ciEdit this page on GitHub
2901cb0ef41Sopenharmony_ci</a>
2911cb0ef41Sopenharmony_ci</footer>
2921cb0ef41Sopenharmony_ci</section>
2931cb0ef41Sopenharmony_ci
2941cb0ef41Sopenharmony_ci
2951cb0ef41Sopenharmony_ci
2961cb0ef41Sopenharmony_ci</body></html>