/
npm-view.1
143 lines (141 loc) · 3.26 KB
/
npm-view.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
.TH "NPM\-VIEW" "1" "February 2021" "" ""
.SH "NAME"
\fBnpm-view\fR \- View registry info
.SS Synopsis
.P
.RS 2
.nf
npm view [<@scope>/]<name>[@<version>] [<field>[\.<subfield>]\.\.\.]
aliases: info, show, v
.fi
.RE
.SS Description
.P
This command shows data about a package and prints it to the stream
referenced by the \fBoutfd\fP config, which defaults to stdout\.
.P
To show the package registry entry for the \fBconnect\fP package, you can do
this:
.P
.RS 2
.nf
npm view connect
.fi
.RE
.P
The default version is "latest" if unspecified\.
.P
Field names can be specified after the package descriptor\.
For example, to show the dependencies of the \fBronn\fP package at version
0\.3\.5, you could do the following:
.P
.RS 2
.nf
npm view ronn@0\.3\.5 dependencies
.fi
.RE
.P
You can view child fields by separating them with a period\.
To view the git repository URL for the latest version of npm, you could
do this:
.P
.RS 2
.nf
npm view npm repository\.url
.fi
.RE
.P
This makes it easy to view information about a dependency with a bit of
shell scripting\. For example, to view all the data about the version of
opts that ronn depends on, you can do this:
.P
.RS 2
.nf
npm view opts@$(npm view ronn dependencies\.opts)
.fi
.RE
.P
For fields that are arrays, requesting a non\-numeric field will return
all of the values from the objects in the list\. For example, to get all
the contributor names for the "express" project, you can do this:
.P
.RS 2
.nf
npm view express contributors\.email
.fi
.RE
.P
You may also use numeric indices in square braces to specifically select
an item in an array field\. To just get the email address of the first
contributor in the list, you can do this:
.P
.RS 2
.nf
npm view express contributors[0]\.email
.fi
.RE
.P
Multiple fields may be specified, and will be printed one after another\.
For example, to get all the contributor names and email addresses, you
can do this:
.P
.RS 2
.nf
npm view express contributors\.name contributors\.email
.fi
.RE
.P
"Person" fields are shown as a string if they would be shown as an
object\. So, for example, this will show the list of npm contributors in
the shortened string format\. (See npm help \fBpackage\.json\fP for more on this\.)
.P
.RS 2
.nf
npm view npm contributors
.fi
.RE
.P
If a version range is provided, then data will be printed for every
matching version of the package\. This will show which version of jsdom
was required by each matching version of yui3:
.P
.RS 2
.nf
npm view yui3@'>0\.5\.4' dependencies\.jsdom
.fi
.RE
.P
To show the \fBconnect\fP package version history, you can do
this:
.P
.RS 2
.nf
npm view connect versions
.fi
.RE
.SS Output
.P
If only a single string field for a single version is output, then it
will not be colorized or quoted, so as to enable piping the output to
another command\. If the field is an object, it will be output as a JavaScript object literal\.
.P
If the \-\-json flag is given, the outputted fields will be JSON\.
.P
If the version range matches multiple versions, than each printed value
will be prefixed with the version it applies to\.
.P
If multiple fields are requested, than each of them are prefixed with
the field name\.
.SS See Also
.RS 0
.IP \(bu 2
npm help search
.IP \(bu 2
npm help registry
.IP \(bu 2
npm help config
.IP \(bu 2
npm help npmrc
.IP \(bu 2
npm help docs
.RE