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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
.TH "NPM\-SEARCH" "1" "March 2021" "" ""
.SH "NAME"
\fBnpm-search\fR \- Search for packages
.SS Synopsis
.P
.RS 2
.nf
npm search [\-l|\-\-long] [\-\-json] [\-\-parseable] [\-\-no\-description] [search terms \.\.\.]
aliases: s, se, find
.fi
.RE
.SS Description
.P
Search the registry for packages matching the search terms\. \fBnpm search\fP
performs a linear, incremental, lexically\-ordered search through package
metadata for all files in the registry\. If your terminal has color
support, it will further highlight the matches in the results\. This can
be disabled with the config item \fBcolor\fP
.P
Additionally, using the \fB\-\-searchopts\fP and \fB\-\-searchexclude\fP options
paired with more search terms will include and exclude further patterns\.
The main difference between \fB\-\-searchopts\fP and the standard search terms
is that the former does not highlight results in the output and you can
use them more fine\-grained filtering\. Additionally, you can add both of
these to your config to change default search filtering behavior\.
.P
Search also allows targeting of maintainers in search results, by prefixing
their npm username with \fB=\fP\|\.
.P
If a term starts with \fB/\fP, then it's interpreted as a regular expression
and supports standard JavaScript RegExp syntax\. In this case search will
ignore a trailing \fB/\fP \. (Note you must escape or quote many regular
expression characters in most shells\.)
.SS Configuration
.P
All of the following can be defined in a \fB\|\.npmrc\fP file, or passed as
parameters to the cli prefixed with \fB\-\-\fP (e\.g\. \fB\-\-json\fP)
.SS description
.RS 0
.IP \(bu 2
Default: true
.IP \(bu 2
Type: Boolean
.RE
.SS color
.RS 0
.IP \(bu 2
Default: true
.IP \(bu 2
Type: Boolean
.RE
.P
Used as \fB\-\-no\-color\fP, disables color highlighting of matches in the
results\.
.SS json
.RS 0
.IP \(bu 2
Default: false
.IP \(bu 2
Type: Boolean
.RE
.P
Output search results as a JSON array\.
.SS parseable
.RS 0
.IP \(bu 2
Default: false
.IP \(bu 2
Type: Boolean
.RE
.P
Output search results as lines with tab\-separated columns\.
.SS long
.RS 0
.IP \(bu 2
Default: false
.IP \(bu 2
Type: Boolean
.RE
.P
Display full package descriptions and other long text across multiple
lines\. When disabled (which is the default) the output will
truncate search results to fit neatly on a single line\. Modules with
extremely long names will fall on multiple lines\.
.SS searchopts
.RS 0
.IP \(bu 2
Default: ""
.IP \(bu 2
Type: String
.RE
.P
Space\-separated options that are always passed to search\.
.SS searchexclude
.RS 0
.IP \(bu 2
Default: ""
.IP \(bu 2
Type: String
.RE
.P
Space\-separated options that limit the results from search\.
.SS registry
.RS 0
.IP \(bu 2
Default: https://registry\.npmjs\.org/
.IP \(bu 2
Type: url
.RE
.P
Search the specified registry for modules\. If you have configured npm to
point to a different default registry (such as your internal private
module repository), \fBnpm search\fP will also default to that registry when
searching\.
.SS A note on caching
.P
The npm cli caches search results with the same terms and options
locally in its cache\. You can use the following to change how and when
the cli uses this cache\. See npm help \fBcache\fP for more
on how the cache works\.
.SS prefer\-online
.P
Forces staleness checks for cached searches, making the cli look for
updates immediately even for fresh search results\.
.SS prefer\-offline
.P
Bypasses staleness checks for cached searches\. Missing data will still
be requested from the server\. To force full offline mode, use \fBoffline\fP\|\.
.SS offline
.P
Forces full offline mode\. Any searches not locally cached will result in
an error\.
.SS See Also
.RS 0
.IP \(bu 2
npm help registry
.IP \(bu 2
npm help config
.IP \(bu 2
npm help npmrc
.IP \(bu 2
npm help view
.IP \(bu 2
npm help cache
.IP \(bu 2
https://npm\.im/npm\-registry\-fetch
.RE
|
