1NPM-SEARCH(1)                                                    NPM-SEARCH(1)
2
3
4

NAME

6       npm-search - Search for packages
7
8   Synopsis
9         npm search [-l|--long] [--json] [--parseable] [--no-description] [search terms ...]
10
11         aliases: s, se, find
12
13   Description
14       Search  the registry for packages matching the search terms. npm search
15       performs a linear, incremental, lexically-ordered search through  pack‐
16       age  metadata  for  all  files in the registry. If color is enabled, it
17       will further highlight the matches in the results.
18
19       Additionally, using the --searchopts and --searchexclude options paired
20       with  more  search  terms will respectively include and exclude further
21       patterns. The main difference between  --searchopts  and  the  standard
22       search  terms is that the former does not highlight results in the out‐
23       put and can be used for more fine-grained filtering. Additionally, both
24       of these can be added to .npmrc for default search filtering behavior.
25
26       Search  also allows targeting of maintainers in search results, by pre‐
27       fixing their npm username with =.
28
29       If a term starts with /, then it's interpreted as a regular  expression
30       and  supports  standard  JavaScript RegExp syntax. A trailing / will be
31       ignored in this case. (Note that  many  regular  expression  characters
32       must be escaped or quoted in most shells.)
33
34   A Note on caching
35   Configuration
36   description
37       · Default: true
38
39       · Type: Boolean
40
41
42       Used  as --no-description, disables search matching in package descrip‐
43       tions and suppresses display of that field in results.
44
45   json
46       · Default: false
47
48       · Type: Boolean
49
50
51       Output search results as a JSON array.
52
53   parseable
54       · Default: false
55
56       · Type: Boolean
57
58
59       Output search results as lines with tab-separated columns.
60
61   long
62       · Default: false
63
64       · Type: Boolean
65
66
67       Display full package descriptions and other long text  across  multiple
68       lines.  When  disabled  (default)  search  results are truncated to fit
69       neatly on a single line. Modules with extremely long names will fall on
70       multiple lines.
71
72   searchopts
73       · Default: ""
74
75       · Type: String
76
77
78       Space-separated options that are always passed to search.
79
80   searchexclude
81       · Default: ""
82
83       · Type: String
84
85
86       Space-separated options that limit the results from search.
87
88   searchstaleness
89       · Default: 900 (15 minutes)
90
91       · Type: Number
92
93
94       The  age  of  the cache, in seconds, before another registry request is
95       made.
96
97   registry
98       · Default: https://registry.npmjs.org/
99
100       · Type: url
101
102
103       Search the specified registry for modules. If you have  configured  npm
104       to point to a different default registry, such as your internal private
105       module repository, npm  search  will  default  to  that  registry  when
106       searching.  Pass  a different registry url such as the default above in
107       order to override this setting.
108
109   See Also
110       · npm help registry
111
112       · npm help config
113
114       · npm help npmrc
115
116       · npm help view
117
118
119
120
121                                 February 2021                   NPM-SEARCH(1)
Impressum