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
   7   <body>
   8     <div id="wrapper">
   9 <h1><a href="../cli/npm-view.html">npm-view</a></h1> <p>View registry info</p>
  10
  11 <h2 id="SYNOPSIS">SYNOPSIS</h2>
  12
  13 <pre><code>npm view &lt;name&gt;[@&lt;version&gt;] [&lt;field&gt;[.&lt;subfield&gt;]...]
  14 npm v &lt;name&gt;[@&lt;version&gt;] [&lt;field&gt;[.&lt;subfield&gt;]...]</code></pre>
  15
  16 <h2 id="DESCRIPTION">DESCRIPTION</h2>
  17
  18 <p>This command shows data about a package and prints it to the stream
  19 referenced by the <code>outfd</code> config, which defaults to stdout.</p>
  20
  21 <p>To show the package registry entry for the <code>connect</code> package, you can do
  22 this:</p>
  23
  24 <pre><code>npm view connect</code></pre>
  25
  26 <p>The default version is &quot;latest&quot; if unspecified.</p>
  27
  28 <p>Field names can be specified after the package descriptor.
  29 For example, to show the dependencies of the <code>ronn</code> package at version
  30 0.3.5, you could do the following:</p>
  31
  32 <pre><code>npm view ronn@0.3.5 dependencies</code></pre>
  33
  34 <p>You can view child field by separating them with a period.
  35 To view the git repository URL for the latest version of npm, you could
  36 do this:</p>
  37
  38 <pre><code>npm view npm repository.url</code></pre>
  39
  40 <p>This makes it easy to view information about a dependency with a bit of
  41 shell scripting.  For example, to view all the data about the version of
  42 opts that ronn depends on, you can do this:</p>
  43
  44 <pre><code>npm view opts@$(npm view ronn dependencies.opts)</code></pre>
  45
  46 <p>For fields that are arrays, requesting a non-numeric field will return
  47 all of the values from the objects in the list.  For example, to get all
  48 the contributor names for the &quot;express&quot; project, you can do this:</p>
  49
  50 <pre><code>npm view express contributors.email</code></pre>
  51
  52 <p>You may also use numeric indices in square braces to specifically select
  53 an item in an array field.  To just get the email address of the first
  54 contributor in the list, you can do this:</p>
  55
  56 <pre><code>npm view express contributors[0].email</code></pre>
  57
  58 <p>Multiple fields may be specified, and will be printed one after another.
  59 For exampls, to get all the contributor names and email addresses, you
  60 can do this:</p>
  61
  62 <pre><code>npm view express contributors.name contributors.email</code></pre>
  63
  64 <p>&quot;Person&quot; fields are shown as a string if they would be shown as an
  65 object.  So, for example, this will show the list of npm contributors in
  66 the shortened string format.  (See <code><a href="../files/package.json.html">package.json(5)</a></code> for more on this.)</p>
  67
  68 <pre><code>npm view npm contributors</code></pre>
  69
  70 <p>If a version range is provided, then data will be printed for every
  71 matching version of the package.  This will show which version of jsdom
  72 was required by each matching version of yui3:</p>
  73
  74 <pre><code>npm view yui3@&#39;&gt;0.5.4&#39; dependencies.jsdom</code></pre>
  75
  76 <h2 id="OUTPUT">OUTPUT</h2>
  77
  78 <p>If only a single string field for a single version is output, then it
  79 will not be colorized or quoted, so as to enable piping the output to
  80 another command. If the field is an object, it will be output as a JavaScript object literal.</p>
  81
  82 <p>If the --json flag is given, the outputted fields will be JSON.</p>
  83
  84 <p>If the version range matches multiple versions, than each printed value
  85 will be prefixed with the version it applies to.</p>
  86
  87 <p>If multiple fields are requested, than each of them are prefixed with
  88 the field name.</p>
  89
  90 <h2 id="SEE-ALSO">SEE ALSO</h2>
  91
  92 <ul><li><a href="../cli/npm-search.html">npm-search(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../cli/npm-docs.html">npm-docs(1)</a></li></ul>
  93 </div>
  94 <p id="footer">npm-view &mdash; npm@1.3.21</p>
  95 <script>
  96 ;(function () {
  97 var wrapper = document.getElementById("wrapper")
  98 var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0)
  99   .filter(function (el) {
 100     return el.parentNode === wrapper
 101         && el.tagName.match(/H[1-6]/)
 102         && el.id
 103   })
 104 var l = 2
 105   , toc = document.createElement("ul")
 106 toc.innerHTML = els.map(function (el) {
 107   var i = el.tagName.charAt(1)
 108     , out = ""
 109   while (i > l) {
 110     out += "<ul>"
 111     l ++
 112   }
 113   while (i < l) {
 114     out += "</ul>"
 115     l --
 116   }
 117   out += "<li><a href='#" + el.id + "'>" +
 118     ( el.innerText || el.text || el.innerHTML)
 119     + "</a>"
 120   return out
 121 }).join("\n")
 122 toc.id = "toc"
 123 document.body.appendChild(toc)
 124 })()
 125 </script>