11cb0ef41Sopenharmony_ci<!DOCTYPE html><html><head> 21cb0ef41Sopenharmony_ci<meta charset="utf-8"> 31cb0ef41Sopenharmony_ci<title>package-spec</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="package-spec">package-spec</h1> 1401cb0ef41Sopenharmony_ci<span class="description">Package name specifier</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="#description">Description</a></li><li><a href="#package-name">Package name</a></li><li><a href="#aliases">Aliases</a></li><li><a href="#folders">Folders</a></li><li><a href="#tarballs">Tarballs</a></li><li><a href="#git-urls">git urls</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="description">Description</h3> 1491cb0ef41Sopenharmony_ci<p>Commands like <code>npm install</code> and the dependency sections in the 1501cb0ef41Sopenharmony_ci<code>package.json</code> use a package name specifier. This can be many different 1511cb0ef41Sopenharmony_cithings that all refer to a "package". Examples include a package name, 1521cb0ef41Sopenharmony_cigit url, tarball, or local directory. These will generally be referred 1531cb0ef41Sopenharmony_cito as <code><package-spec></code> in the help output for the npm commands that use 1541cb0ef41Sopenharmony_cithis package name specifier.</p> 1551cb0ef41Sopenharmony_ci<h3 id="package-name">Package name</h3> 1561cb0ef41Sopenharmony_ci<ul> 1571cb0ef41Sopenharmony_ci<li><code>[<@scope>/]<pkg></code></li> 1581cb0ef41Sopenharmony_ci<li><code>[<@scope>/]<pkg>@<tag></code></li> 1591cb0ef41Sopenharmony_ci<li><code>[<@scope>/]<pkg>@<version></code></li> 1601cb0ef41Sopenharmony_ci<li><code>[<@scope>/]<pkg>@<version range></code></li> 1611cb0ef41Sopenharmony_ci</ul> 1621cb0ef41Sopenharmony_ci<p>Refers to a package by name, with or without a scope, and optionally 1631cb0ef41Sopenharmony_citag, version, or version range. This is typically used in combination 1641cb0ef41Sopenharmony_ciwith the <a href="../using-npm/config#registry.html">registry</a> config to refer to a 1651cb0ef41Sopenharmony_cipackage in a registry.</p> 1661cb0ef41Sopenharmony_ci<p>Examples:</p> 1671cb0ef41Sopenharmony_ci<ul> 1681cb0ef41Sopenharmony_ci<li><code>npm</code></li> 1691cb0ef41Sopenharmony_ci<li><code>@npmcli/arborist</code></li> 1701cb0ef41Sopenharmony_ci<li><code>@npmcli/arborist@latest</code></li> 1711cb0ef41Sopenharmony_ci<li><code>npm@6.13.1</code></li> 1721cb0ef41Sopenharmony_ci<li><code>npm@^4.0.0</code></li> 1731cb0ef41Sopenharmony_ci</ul> 1741cb0ef41Sopenharmony_ci<h3 id="aliases">Aliases</h3> 1751cb0ef41Sopenharmony_ci<ul> 1761cb0ef41Sopenharmony_ci<li><code><alias>@npm:<name></code></li> 1771cb0ef41Sopenharmony_ci</ul> 1781cb0ef41Sopenharmony_ci<p>Primarily used by commands like <code>npm install</code> and in the dependency 1791cb0ef41Sopenharmony_cisections in the <code>package.json</code>, this refers to a package by an alias. 1801cb0ef41Sopenharmony_ciThe <code><alias></code> is the name of the package as it is reified in the 1811cb0ef41Sopenharmony_ci<code>node_modules</code> folder, and the <code><name></code> refers to a package name as 1821cb0ef41Sopenharmony_cifound in the configured registry.</p> 1831cb0ef41Sopenharmony_ci<p>See <code>Package name</code> above for more info on referring to a package by 1841cb0ef41Sopenharmony_ciname, and <a href="../using-npm/config#registry.html">registry</a> for configuring which 1851cb0ef41Sopenharmony_ciregistry is used when referring to a package by name.</p> 1861cb0ef41Sopenharmony_ci<p>Examples:</p> 1871cb0ef41Sopenharmony_ci<ul> 1881cb0ef41Sopenharmony_ci<li><code>semver:@npm:@npmcli/semver-with-patch</code></li> 1891cb0ef41Sopenharmony_ci<li><code>semver:@npm:semver@7.2.2</code></li> 1901cb0ef41Sopenharmony_ci<li><code>semver:@npm:semver@legacy</code></li> 1911cb0ef41Sopenharmony_ci</ul> 1921cb0ef41Sopenharmony_ci<h3 id="folders">Folders</h3> 1931cb0ef41Sopenharmony_ci<ul> 1941cb0ef41Sopenharmony_ci<li><code><folder></code></li> 1951cb0ef41Sopenharmony_ci</ul> 1961cb0ef41Sopenharmony_ci<p>This refers to a package on the local filesystem. Specifically this is 1971cb0ef41Sopenharmony_cia folder with a <code>package.json</code> file in it. This <em>should</em> always be 1981cb0ef41Sopenharmony_ciprefixed with a <code>/</code> or <code>./</code> (or your OS equivalent) to reduce confusion. 1991cb0ef41Sopenharmony_cinpm currently will parse a string with more than one <code>/</code> in it as a 2001cb0ef41Sopenharmony_cifolder, but this is legacy behavior that may be removed in a future 2011cb0ef41Sopenharmony_civersion.</p> 2021cb0ef41Sopenharmony_ci<p>Examples:</p> 2031cb0ef41Sopenharmony_ci<ul> 2041cb0ef41Sopenharmony_ci<li><code>./my-package</code></li> 2051cb0ef41Sopenharmony_ci<li><code>/opt/npm/my-package</code></li> 2061cb0ef41Sopenharmony_ci</ul> 2071cb0ef41Sopenharmony_ci<h3 id="tarballs">Tarballs</h3> 2081cb0ef41Sopenharmony_ci<ul> 2091cb0ef41Sopenharmony_ci<li><code><tarball file></code></li> 2101cb0ef41Sopenharmony_ci<li><code><tarball url></code></li> 2111cb0ef41Sopenharmony_ci</ul> 2121cb0ef41Sopenharmony_ci<p>Examples:</p> 2131cb0ef41Sopenharmony_ci<ul> 2141cb0ef41Sopenharmony_ci<li><code>./my-package.tgz</code></li> 2151cb0ef41Sopenharmony_ci<li><code>https://registry.npmjs.org/semver/-/semver-1.0.0.tgz</code></li> 2161cb0ef41Sopenharmony_ci</ul> 2171cb0ef41Sopenharmony_ci<p>Refers to a package in a tarball format, either on the local filesystem 2181cb0ef41Sopenharmony_cior remotely via url. This is the format that packages exist in when 2191cb0ef41Sopenharmony_ciuploaded to a registry.</p> 2201cb0ef41Sopenharmony_ci<h3 id="git-urls">git urls</h3> 2211cb0ef41Sopenharmony_ci<ul> 2221cb0ef41Sopenharmony_ci<li><code><git:// url></code></li> 2231cb0ef41Sopenharmony_ci<li><code><github username>/<github project></code></li> 2241cb0ef41Sopenharmony_ci</ul> 2251cb0ef41Sopenharmony_ci<p>Refers to a package in a git repo. This can be a full git url, git 2261cb0ef41Sopenharmony_cishorthand, or a username/package on GitHub. You can specify a 2271cb0ef41Sopenharmony_cigit tag, branch, or other git ref by appending <code>#ref</code>.</p> 2281cb0ef41Sopenharmony_ci<p>Examples:</p> 2291cb0ef41Sopenharmony_ci<ul> 2301cb0ef41Sopenharmony_ci<li><code>https://github.com/npm/cli.git</code></li> 2311cb0ef41Sopenharmony_ci<li><code>git@github.com:npm/cli.git</code></li> 2321cb0ef41Sopenharmony_ci<li><code>git+ssh://git@github.com/npm/cli#v6.0.0</code></li> 2331cb0ef41Sopenharmony_ci<li><code>github:npm/cli#HEAD</code></li> 2341cb0ef41Sopenharmony_ci<li><code>npm/cli#c12ea07</code></li> 2351cb0ef41Sopenharmony_ci</ul> 2361cb0ef41Sopenharmony_ci<h3 id="see-also">See also</h3> 2371cb0ef41Sopenharmony_ci<ul> 2381cb0ef41Sopenharmony_ci<li><a href="https://npm.im/npm-package-arg">npm-package-arg</a></li> 2391cb0ef41Sopenharmony_ci<li><a href="../using-npm/scope.html">scope</a></li> 2401cb0ef41Sopenharmony_ci<li><a href="../using-npm/config.html">config</a></li> 2411cb0ef41Sopenharmony_ci</ul></div> 2421cb0ef41Sopenharmony_ci 2431cb0ef41Sopenharmony_ci<footer id="edit"> 2441cb0ef41Sopenharmony_ci<a href="https://github.com/npm/cli/edit/latest/docs/content/using-npm/package-spec.md"> 2451cb0ef41Sopenharmony_ci<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;"> 2461cb0ef41Sopenharmony_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> 2471cb0ef41Sopenharmony_ci</svg> 2481cb0ef41Sopenharmony_ciEdit this page on GitHub 2491cb0ef41Sopenharmony_ci</a> 2501cb0ef41Sopenharmony_ci</footer> 2511cb0ef41Sopenharmony_ci</section> 2521cb0ef41Sopenharmony_ci 2531cb0ef41Sopenharmony_ci 2541cb0ef41Sopenharmony_ci 2551cb0ef41Sopenharmony_ci</body></html>