• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>npm-view</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-view">npm-view</h1>
140<span class="description">View registry info</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="#json"><code>json</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="#output">Output</a></li><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 view [&lt;package-spec&gt;] [&lt;field&gt;[.subfield]...]
150
151aliases: info, show, v
152</code></pre>
153<h3 id="description">Description</h3>
154<p>This command shows data about a package and prints it to stdout.</p>
155<p>As an example, to view information about the <code>connect</code> package from the registry, you would run:</p>
156<pre><code class="language-bash">npm view connect
157</code></pre>
158<p>The default version is <code>"latest"</code> if unspecified.</p>
159<p>Field names can be specified after the package descriptor.
160For example, to show the dependencies of the <code>ronn</code> package at version
161<code>0.3.5</code>, you could do the following:</p>
162<pre><code class="language-bash">npm view ronn@0.3.5 dependencies
163</code></pre>
164<p>By default, <code>npm view</code> shows data about the current project context (by looking for a <code>package.json</code>).
165To show field data for the current project use a file path (i.e. <code>.</code>):</p>
166<pre><code class="language-bash">npm view . dependencies
167</code></pre>
168<p>You can view child fields by separating them with a period.
169To view the git repository URL for the latest version of <code>npm</code>, you would run the following command:</p>
170<pre><code class="language-bash">npm view npm repository.url
171</code></pre>
172<p>This makes it easy to view information about a dependency with a bit of
173shell scripting. For example, to view all the data about the version of
174<code>opts</code> that <code>ronn</code> depends on, you could write the following:</p>
175<pre><code class="language-bash">npm view opts@$(npm view ronn dependencies.opts)
176</code></pre>
177<p>For fields that are arrays, requesting a non-numeric field will return
178all of the values from the objects in the list. For example, to get all
179the contributor email addresses for the <code>express</code> package, you would run:</p>
180<pre><code class="language-bash">npm view express contributors.email
181</code></pre>
182<p>You may also use numeric indices in square braces to specifically select
183an item in an array field. To just get the email address of the first
184contributor in the list, you can run:</p>
185<pre><code class="language-bash">npm view express contributors[0].email
186</code></pre>
187<p>If the field value you are querying for is a property of an object, you should run:</p>
188<pre><code class="language-bash">npm view express time'[4.8.0]'
189</code></pre>
190<p>Multiple fields may be specified, and will be printed one after another.
191For example, to get all the contributor names and email addresses, you
192can do this:</p>
193<pre><code class="language-bash">npm view express contributors.name contributors.email
194</code></pre>
195<p>"Person" fields are shown as a string if they would be shown as an
196object.  So, for example, this will show the list of <code>npm</code> contributors in
197the shortened string format.  (See <a href="../configuring-npm/package-json.html"><code>package.json</code></a> for more on this.)</p>
198<pre><code class="language-bash">npm view npm contributors
199</code></pre>
200<p>If a version range is provided, then data will be printed for every
201matching version of the package.  This will show which version of <code>jsdom</code>
202was required by each matching version of <code>yui3</code>:</p>
203<pre><code class="language-bash">npm view yui3@'&gt;0.5.4' dependencies.jsdom
204</code></pre>
205<p>To show the <code>connect</code> package version history, you can do
206this:</p>
207<pre><code class="language-bash">npm view connect versions
208</code></pre>
209<h3 id="configuration">Configuration</h3>
210<h4 id="json"><code>json</code></h4>
211<ul>
212<li>Default: false</li>
213<li>Type: Boolean</li>
214</ul>
215<p>Whether or not to output JSON data, rather than the normal output.</p>
216<ul>
217<li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before
218saving them to your <code>package.json</code>.</li>
219</ul>
220<p>Not supported by all npm commands.</p>
221<h4 id="workspace"><code>workspace</code></h4>
222<ul>
223<li>Default:</li>
224<li>Type: String (can be set multiple times)</li>
225</ul>
226<p>Enable running a command in the context of the configured workspaces of the
227current project while filtering by running only the workspaces defined by
228this configuration option.</p>
229<p>Valid values for the <code>workspace</code> config are either:</p>
230<ul>
231<li>Workspace names</li>
232<li>Path to a workspace directory</li>
233<li>Path to a parent workspace directory (will result in selecting all
234workspaces within that folder)</li>
235</ul>
236<p>When set for the <code>npm init</code> command, this may be set to the folder of a
237workspace which does not yet exist, to create the folder and set it up as a
238brand new workspace within the project.</p>
239<p>This value is not exported to the environment for child processes.</p>
240<h4 id="workspaces"><code>workspaces</code></h4>
241<ul>
242<li>Default: null</li>
243<li>Type: null or Boolean</li>
244</ul>
245<p>Set to true to run the command in the context of <strong>all</strong> configured
246workspaces.</p>
247<p>Explicitly setting this to false will cause commands like <code>install</code> to
248ignore workspaces altogether. When not set explicitly:</p>
249<ul>
250<li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
251will link workspaces into the <code>node_modules</code> folder. - Commands that do
252other things (test, exec, publish, etc.) will operate on the root project,
253<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
254</ul>
255<p>This value is not exported to the environment for child processes.</p>
256<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
257<ul>
258<li>Default: false</li>
259<li>Type: Boolean</li>
260</ul>
261<p>Include the workspace root when workspaces are enabled for a command.</p>
262<p>When false, specifying individual workspaces via the <code>workspace</code> config, or
263all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
264the specified workspaces, and not on the root project.</p>
265<p>This value is not exported to the environment for child processes.</p>
266<h3 id="output">Output</h3>
267<p>If only a single string field for a single version is output, then it
268will not be colorized or quoted, to enable piping the output to
269another command. If the field is an object, it will be output as a JavaScript object literal.</p>
270<p>If the <code>--json</code> flag is given, the outputted fields will be JSON.</p>
271<p>If the version range matches multiple versions then each printed value
272will be prefixed with the version it applies to.</p>
273<p>If multiple fields are requested, then each of them is prefixed with
274the field name.</p>
275<h3 id="see-also">See Also</h3>
276<ul>
277<li><a href="../using-npm/package-spec.html">package spec</a></li>
278<li><a href="../commands/npm-search.html">npm search</a></li>
279<li><a href="../using-npm/registry.html">npm registry</a></li>
280<li><a href="../commands/npm-config.html">npm config</a></li>
281<li><a href="../configuring-npm/npmrc.html">npmrc</a></li>
282<li><a href="../commands/npm-docs.html">npm docs</a></li>
283</ul></div>
284
285<footer id="edit">
286<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-view.md">
287<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
288<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>
289</svg>
290Edit this page on GitHub
291</a>
292</footer>
293</section>
294
295
296
297</body></html>