1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>npm-repo</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="npm-repo">npm-repo</h1>
140<span class="description">Open package repository page in the browser</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="#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>
146</section>
147
148<div id="_content"><h3 id="synopsis">Synopsis</h3>
149<pre><code class="language-bash">npm repo [&lt;pkgname&gt; [&lt;pkgname&gt; ...]]
150</code></pre>
151<h3 id="description">Description</h3>
152<p>This command tries to guess at the likely location of a package's
153repository URL, and then tries to open it using the
154<a href="../using-npm/config#browser.html"><code>--browser</code> config</a> param. If no package name is
155provided, it will search for a <code>package.json</code> in the current folder and use the
156<code>repository</code> property.</p>
157<h3 id="configuration">Configuration</h3>
158<h4 id="browser"><code>browser</code></h4>
159<ul>
160<li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li>
161<li>Type: null, Boolean, or String</li>
162</ul>
163<p>The browser that is called by npm commands to open websites.</p>
164<p>Set to <code>false</code> to suppress browser behavior and instead print urls to
165terminal.</p>
166<p>Set to <code>true</code> to use default system URL opener.</p>
167<h4 id="registry"><code>registry</code></h4>
168<ul>
169<li>Default: "<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>"</li>
170<li>Type: URL</li>
171</ul>
172<p>The base URL of the npm registry.</p>
173<h4 id="workspace"><code>workspace</code></h4>
174<ul>
175<li>Default:</li>
176<li>Type: String (can be set multiple times)</li>
177</ul>
178<p>Enable running a command in the context of the configured workspaces of the
179current project while filtering by running only the workspaces defined by
180this configuration option.</p>
181<p>Valid values for the <code>workspace</code> config are either:</p>
182<ul>
183<li>Workspace names</li>
184<li>Path to a workspace directory</li>
185<li>Path to a parent workspace directory (will result in selecting all
186workspaces within that folder)</li>
187</ul>
188<p>When set for the <code>npm init</code> command, this may be set to the folder of a
189workspace which does not yet exist, to create the folder and set it up as a
190brand new workspace within the project.</p>
191<p>This value is not exported to the environment for child processes.</p>
192<h4 id="workspaces"><code>workspaces</code></h4>
193<ul>
194<li>Default: null</li>
195<li>Type: null or Boolean</li>
196</ul>
197<p>Set to true to run the command in the context of <strong>all</strong> configured
198workspaces.</p>
199<p>Explicitly setting this to false will cause commands like <code>install</code> to
200ignore workspaces altogether. When not set explicitly:</p>
201<ul>
202<li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
203will link workspaces into the <code>node_modules</code> folder. - Commands that do
204other things (test, exec, publish, etc.) will operate on the root project,
205<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
206</ul>
207<p>This value is not exported to the environment for child processes.</p>
208<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
209<ul>
210<li>Default: false</li>
211<li>Type: Boolean</li>
212</ul>
213<p>Include the workspace root when workspaces are enabled for a command.</p>
214<p>When false, specifying individual workspaces via the <code>workspace</code> config, or
215all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
216the specified workspaces, and not on the root project.</p>
217<p>This value is not exported to the environment for child processes.</p>
218<h3 id="see-also">See Also</h3>
219<ul>
220<li><a href="../commands/npm-docs.html">npm docs</a></li>
221<li><a href="../commands/npm-config.html">npm config</a></li>
222</ul></div>
223
224<footer id="edit">
225<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-repo.md">
226<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
227<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>
228</svg>
229Edit this page on GitHub
230</a>
231</footer>
232</section>
233
234
235
236</body></html>