codekingpro/portable-devtools

1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>Package spec</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="----package-spec----11121">
190    <span>Package spec</span>
191    <span class="version">@11.12.1</span>
192</h1>
193<span class="description">Package name specifier</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="#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>
199</section>
200
201<div id="_content"><h3 id="description">Description</h3>
202<p>Commands like <code>npm install</code> and the dependency sections in the <code>package.json</code> use a package name specifier.
203This can be many different things that all refer to a "package".  Examples include a package name, git url, tarball, or local directory.
204These will generally be referred to as <code>&lt;package-spec&gt;</code> in the help output for the npm commands that use this package name specifier.</p>
205<h3 id="package-name">Package name</h3>
206<ul>
207<li><code>[&lt;@scope&gt;/]&lt;pkg&gt;</code></li>
208<li><code>[&lt;@scope&gt;/]&lt;pkg&gt;@&lt;tag&gt;</code></li>
209<li><code>[&lt;@scope&gt;/]&lt;pkg&gt;@&lt;version&gt;</code></li>
210<li><code>[&lt;@scope&gt;/]&lt;pkg&gt;@&lt;version range&gt;</code></li>
211</ul>
212<p>Refers to a package by name, with or without a scope, and optionally tag, version, or version range.
213This is typically used in combination with the <a href="../using-npm/config#registry.html">registry</a> config to refer to a package in a registry.</p>
214<p>Examples:</p>
215<ul>
216<li><code>npm</code></li>
217<li><code>@npmcli/arborist</code></li>
218<li><code>@npmcli/arborist@latest</code></li>
219<li><code>npm@6.13.1</code></li>
220<li><code>npm@^4.0.0</code></li>
221</ul>
222<h3 id="aliases">Aliases</h3>
223<ul>
224<li><code>&lt;alias&gt;@npm:&lt;name&gt;</code></li>
225</ul>
226<p>Primarily used by commands like <code>npm install</code> and in the dependency sections in the <code>package.json</code>, this refers to a package by an alias.
227The <code>&lt;alias&gt;</code> is the name of the package as it is reified in the <code>node_modules</code> folder, and the <code>&lt;name&gt;</code> refers to a package name as found in the configured registry.</p>
228<p>See <code>Package name</code> above for more info on referring to a package by name, and <a href="../using-npm/config#registry.html">registry</a> for configuring which registry is used when referring to a package by name.</p>
229<p>Examples:</p>
230<ul>
231<li><code>semver@npm:@npmcli/semver-with-patch</code></li>
232<li><code>semver@npm:semver@7.2.2</code></li>
233<li><code>semver@npm:semver@legacy</code></li>
234</ul>
235<h3 id="folders">Folders</h3>
236<ul>
237<li><code>&lt;folder&gt;</code></li>
238</ul>
239<p>This refers to a package on the local filesystem.
240Specifically this is a folder with a <code>package.json</code> file in it.
241This <em>should</em> always be prefixed with a <code>/</code> or <code>./</code> (or your OS equivalent) to reduce confusion.
242npm currently will parse a string with more than one <code>/</code> in it as a folder, but this is legacy behavior that may be removed in a future version.</p>
243<p>Examples:</p>
244<ul>
245<li><code>./my-package</code></li>
246<li><code>/opt/npm/my-package</code></li>
247</ul>
248<h3 id="tarballs">Tarballs</h3>
249<ul>
250<li><code>&lt;tarball file&gt;</code></li>
251<li><code>&lt;tarball url&gt;</code></li>
252</ul>
253<p>Examples:</p>
254<ul>
255<li><code>./my-package.tgz</code></li>
256<li><code>https://registry.npmjs.org/semver/-/semver-1.0.0.tgz</code></li>
257</ul>
258<p>Refers to a package in a tarball format, either on the local filesystem or remotely via url.
259This is the format that packages exist in when uploaded to a registry.</p>
260<h3 id="git-urls">git urls</h3>
261<ul>
262<li><code>&lt;git:// url&gt;</code></li>
263<li><code>&lt;github username&gt;/&lt;github project&gt;</code></li>
264</ul>
265<p>Refers to a package in a git repo.
266This can be a full git url, git shorthand, or a username/package on GitHub.
267You can specify a git tag, branch, or other git ref by appending <code>#ref</code>.</p>
268<p>Examples:</p>
269<ul>
270<li><code>https://github.com/npm/cli.git</code></li>
271<li><code>git@github.com:npm/cli.git</code></li>
272<li><code>git+ssh://git@github.com/npm/cli#v6.0.0</code></li>
273<li><code>github:npm/cli#HEAD</code></li>
274<li><code>npm/cli#c12ea07</code></li>
275</ul>
276<h3 id="see-also">See also</h3>
277<ul>
278<li><a href="https://npm.im/npm-package-arg">npm-package-arg</a></li>
279<li><a href="../using-npm/scope.html">scope</a></li>
280<li><a href="../using-npm/config.html">config</a></li>
281</ul></div>
282
283<footer id="edit">
284<a href="https://github.com/npm/cli/edit/latest/docs/lib/content/using-npm/package-spec.md">
285<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
286<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>
287</svg>
288Edit this page on GitHub
289</a>
290</footer>
291</section>
292
293
294
295</body></html>