deps/npm/html/doc/cli/npm-view.html

   1 <!doctype html>
   2 <html>
   3   <title>npm-view</title>
   4   <meta http-equiv="content-type" value="text/html;utf-8">
   5   <link rel="stylesheet" type="text/css" href="../../static/style.css">
   6   <link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-view.html">
   7   <script async=true src="../../static/toc.js"></script>
   8
   9   <body>
  10     <div id="wrapper">
  11
  12 <h1><a href="../cli/npm-view.html">npm-view</a></h1> <p>View registry info</p>
  13 <h2 id="synopsis">SYNOPSIS</h2>
  14 <pre><code>npm view [@&lt;scope&gt;/]&lt;name&gt;[@&lt;version&gt;] [&lt;field&gt;[.&lt;subfield&gt;]...]
  15 npm v [@&lt;scope&gt;/]&lt;name&gt;[@&lt;version&gt;] [&lt;field&gt;[.&lt;subfield&gt;]...]
  16 </code></pre><h2 id="description">DESCRIPTION</h2>
  17 <p>This command shows data about a package and prints it to the stream
  18 referenced by the <code>outfd</code> config, which defaults to stdout.</p>
  19 <p>To show the package registry entry for the <code>connect</code> package, you can do
  20 this:</p>
  21 <pre><code>npm view connect
  22 </code></pre><p>The default version is &quot;latest&quot; if unspecified.</p>
  23 <p>Field names can be specified after the package descriptor.
  24 For example, to show the dependencies of the <code>ronn</code> package at version
  25 0.3.5, you could do the following:</p>
  26 <pre><code>npm view ronn@0.3.5 dependencies
  27 </code></pre><p>You can view child fields by separating them with a period.
  28 To view the git repository URL for the latest version of npm, you could
  29 do this:</p>
  30 <pre><code>npm view npm repository.url
  31 </code></pre><p>This makes it easy to view information about a dependency with a bit of
  32 shell scripting.  For example, to view all the data about the version of
  33 opts that ronn depends on, you can do this:</p>
  34 <pre><code>npm view opts@$(npm view ronn dependencies.opts)
  35 </code></pre><p>For fields that are arrays, requesting a non-numeric field will return
  36 all of the values from the objects in the list.  For example, to get all
  37 the contributor names for the &quot;express&quot; project, you can do this:</p>
  38 <pre><code>npm view express contributors.email
  39 </code></pre><p>You may also use numeric indices in square braces to specifically select
  40 an item in an array field.  To just get the email address of the first
  41 contributor in the list, you can do this:</p>
  42 <pre><code>npm view express contributors[0].email
  43 </code></pre><p>Multiple fields may be specified, and will be printed one after another.
  44 For exampls, to get all the contributor names and email addresses, you
  45 can do this:</p>
  46 <pre><code>npm view express contributors.name contributors.email
  47 </code></pre><p>&quot;Person&quot; fields are shown as a string if they would be shown as an
  48 object.  So, for example, this will show the list of npm contributors in
  49 the shortened string format.  (See <code><a href="../files/package.json.html">package.json(5)</a></code> for more on this.)</p>
  50 <pre><code>npm view npm contributors
  51 </code></pre><p>If a version range is provided, then data will be printed for every
  52 matching version of the package.  This will show which version of jsdom
  53 was required by each matching version of yui3:</p>
  54 <pre><code>npm view yui3@&#39;&gt;0.5.4&#39; dependencies.jsdom
  55 </code></pre><h2 id="output">OUTPUT</h2>
  56 <p>If only a single string field for a single version is output, then it
  57 will not be colorized or quoted, so as to enable piping the output to
  58 another command. If the field is an object, it will be output as a JavaScript object literal.</p>
  59 <p>If the --json flag is given, the outputted fields will be JSON.</p>
  60 <p>If the version range matches multiple versions, than each printed value
  61 will be prefixed with the version it applies to.</p>
  62 <p>If multiple fields are requested, than each of them are prefixed with
  63 the field name.</p>
  64 <h2 id="see-also">SEE ALSO</h2>
  65 <ul>
  66 <li><a href="../cli/npm-search.html">npm-search(1)</a></li>
  67 <li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
  68 <li><a href="../cli/npm-config.html">npm-config(1)</a></li>
  69 <li><a href="../misc/npm-config.html">npm-config(7)</a></li>
  70 <li><a href="../files/npmrc.html">npmrc(5)</a></li>
  71 <li><a href="../cli/npm-docs.html">npm-docs(1)</a></li>
  72 </ul>
  73
  74 </div>
  75
  76 <table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
  77 <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18>&nbsp;</td></tr>
  78 <tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td colspan=6 style="width:60px;height:10px;background:#fff">&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td></tr>
  79 <tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2>&nbsp;</td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td></tr>
  80 <tr><td style="width:10px;height:10px;background:#fff" rowspan=2>&nbsp;</td></tr>
  81 <tr><td style="width:10px;height:10px;background:#fff">&nbsp;</td></tr>
  82 <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6>&nbsp;</td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td></tr>
  83 <tr><td colspan=5 style="width:50px;height:10px;background:#fff">&nbsp;</td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4>&nbsp;</td><td style="width:90px;height:10px;background:#fff" colspan=9>&nbsp;</td></tr>
  84 </table>
  85 <p id="footer">npm-view &mdash; npm@2.14.4</p>
  86