• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>registry</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
116footer#edit {
117    border-top: solid 1px #e1e4e8;
118    margin: 3em 0 4em 0;
119    padding-top: 2em;
120}
121</style>
122</head>
123<body>
124<div id="banner">
125<div id="rainbar"></div>
126<div id="logobar">
127<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
128<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
129<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
130</svg>
131<div class="title">
132npm command-line interface
133</div>
134</div>
135</div>
136
137<section id="content">
138<header class="title">
139<h1 id="registry">registry</h1>
140<span class="description">The JavaScript Package Registry</span>
141</header>
142
143<section id="table_of_contents">
144<h2 id="table-of-contents">Table of contents</h2>
145<div id="_table_of_contents"><ul><li><a href="#description">Description</a></li><li><a href="#does-npm-send-any-information-about-me-back-to-the-registry">Does npm send any information about me back to the registry?</a></li><li><a href="#how-can-i-prevent-my-package-from-being-published-in-the-official-registry">How can I prevent my package from being published in the official registry?</a></li><li><a href="#where-can-i-find-my-and-others-published-packages">Where can I find my (and others') published packages?</a></li><li><a href="#see-also">See also</a></li></ul></div>
146</section>
147
148<div id="_content"><h3 id="description">Description</h3>
149<p>To resolve packages by name and version, npm talks to a registry website
150that implements the CommonJS Package Registry specification for reading
151package info.</p>
152<p>npm is configured to use the <strong>npm public registry</strong> at
153<a href="https://registry.npmjs.org">https://registry.npmjs.org</a> by default. Use of the npm public registry is
154subject to terms of use available at <a href="https://docs.npmjs.com/policies/terms">https://docs.npmjs.com/policies/terms</a>.</p>
155<p>You can configure npm to use any compatible registry you like, and even run
156your own registry. Use of someone else's registry may be governed by their
157terms of use.</p>
158<p>npm's package registry implementation supports several
159write APIs as well, to allow for publishing packages and managing user
160account information.</p>
161<p>The npm public registry is powered by a CouchDB database,
162of which there is a public mirror at <a href="https://skimdb.npmjs.com/registry">https://skimdb.npmjs.com/registry</a>.</p>
163<p>The registry URL used is determined by the scope of the package (see
164<a href="../using-npm/scope.html"><code>scope</code></a>. If no scope is specified, the default registry is
165used, which is supplied by the <a href="../using-npm/config#registry.html"><code>registry</code> config</a>
166parameter.  See <a href="../commands/npm-config.html"><code>npm config</code></a>,
167<a href="../configuring-npm/npmrc.html"><code>npmrc</code></a>, and <a href="../using-npm/config.html"><code>config</code></a> for more on
168managing npm's configuration.
169Authentication configuration such as auth tokens and certificates are configured
170specifically scoped to an individual registry. See
171<a href="../configuring-npm/npmrc#auth-related-configuration.html">Auth Related Configuration</a></p>
172<p>When the default registry is used in a package-lock or shrinkwrap it has the
173special meaning of "the currently configured registry". If you create a lock
174file while using the default registry you can switch to another registry and
175npm will install packages from the new registry, but if you create a lock
176file while using a custom registry packages will be installed from that
177registry even after you change to another registry.</p>
178<h3 id="does-npm-send-any-information-about-me-back-to-the-registry">Does npm send any information about me back to the registry?</h3>
179<p>Yes.</p>
180<p>When making requests of the registry npm adds two headers with information
181about your environment:</p>
182<ul>
183<li><code>Npm-Scope</code> – If your project is scoped, this header will contain its
184scope. In the future npm hopes to build registry features that use this
185information to allow you to customize your experience for your
186organization.</li>
187<li><code>Npm-In-CI</code> – Set to "true" if npm believes this install is running in a
188continuous integration environment, "false" otherwise. This is detected by
189looking for the following environment variables: <code>CI</code>, <code>TDDIUM</code>,
190<code>JENKINS_URL</code>, <code>bamboo.buildKey</code>. If you'd like to learn more you may find
191the <a href="https://github.com/npm/npm-registry-client/pull/129">original PR</a>
192interesting.
193This is used to gather better metrics on how npm is used by humans, versus
194build farms.</li>
195</ul>
196<p>The npm registry does not try to correlate the information in these headers
197with any authenticated accounts that may be used in the same requests.</p>
198<h3 id="how-can-i-prevent-my-package-from-being-published-in-the-official-registry">How can I prevent my package from being published in the official registry?</h3>
199<p>Set <code>"private": true</code> in your <code>package.json</code> to prevent it from being
200published at all, or
201<code>"publishConfig":{"registry":"http://my-internal-registry.local"}</code>
202to force it to be published only to your internal/private registry.</p>
203<p>See <a href="../configuring-npm/package-json.html"><code>package.json</code></a> for more info on what goes in the package.json file.</p>
204<h3 id="where-can-i-find-my-and-others-published-packages">Where can I find my (and others') published packages?</h3>
205<p><a href="https://www.npmjs.com/">https://www.npmjs.com/</a></p>
206<h3 id="see-also">See also</h3>
207<ul>
208<li><a href="../commands/npm-config.html">npm config</a></li>
209<li><a href="../using-npm/config.html">config</a></li>
210<li><a href="../configuring-npm/npmrc.html">npmrc</a></li>
211<li><a href="../using-npm/developers.html">npm developers</a></li>
212</ul></div>
213
214<footer id="edit">
215<a href="https://github.com/npm/cli/edit/latest/docs/content/using-npm/registry.md">
216<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
217<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>
218</svg>
219Edit this page on GitHub
220</a>
221</footer>
222</section>
223
224
225
226</body></html>