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       Note: This command is unaware of workspaces.
14
15   Description
16       Search  the registry for packages matching the search terms. npm search
17       performs a linear, incremental, lexically-ordered search through  pack‐
18       age  metadata for all files in the registry. If your terminal has color
19       support, it will further highlight the matches in  the  results.   This
20       can be disabled with the config item color
21
22       Additionally, using the --searchopts and --searchexclude options paired
23       with more search terms will include and exclude further patterns.   The
24       main  difference  between --searchopts and the standard search terms is
25       that the former does not highlight results in the output  and  you  can
26       use them more fine-grained filtering. Additionally, you can add both of
27       these to your config to change default search filtering behavior.
28
29       Search also allows targeting of maintainers in search results, by  pre‐
30       fixing their npm username with =.
31
32       If  a term starts with /, then it's interpreted as a regular expression
33       and supports standard JavaScript RegExp syntax.  In  this  case  search
34       will ignore a trailing / .  (Note you must escape or quote many regular
35       expression characters in most shells.)
36
37   Configuration
38       <!-- AUTOGENERATED CONFIG DESCRIPTIONS  START  -->  <!--  automatically
39       generated,  do  not edit manually --> <!-- see lib/utils/config/defini‐
40       tions.js -->
41
42   long
43       • Default: false
44
45       • Type: Boolean
46
47
48       Show extended information in ls, search, and help-search.   <!--  auto‐
49       matically  generated,  do not edit manually --> <!-- see lib/utils/con‐
50       fig/definitions.js -->
51
52
53   json
54       • Default: false
55
56       • Type: Boolean
57
58
59       Whether or not to output JSON data, rather than the normal output.
60
61       • In npm pkg set it enables parsing set values with JSON.parse() before
62         saving them to your package.json.
63
64
65       Not  supported  by  all npm commands.  <!-- automatically generated, do
66       not edit manually --> <!-- see lib/utils/config/definitions.js -->
67
68
69   color
70       • Default: true unless the NO_COLOR environ is set to  something  other
71         than '0'
72
73       • Type: "always" or Boolean
74
75
76       If  false, never shows colors. If "always" then always shows colors. If
77       true, then only prints color codes for tty file descriptors.  <!--  au‐
78       tomatically generated, do not edit manually --> <!-- see lib/utils/con‐
79       fig/definitions.js -->
80
81
82   parseable
83       • Default: false
84
85       • Type: Boolean
86
87
88       Output parseable results from commands that write to  standard  output.
89       For npm search, this will be tab-separated table format.  <!-- automat‐
90       ically generated, do not edit  manually  -->  <!--  see  lib/utils/con‐
91       fig/definitions.js -->
92
93
94   description
95       • Default: true
96
97       • Type: Boolean
98
99
100       Show the description in npm search <!-- automatically generated, do not
101       edit manually --> <!-- see lib/utils/config/definitions.js -->
102
103
104   searchopts
105       • Default: ""
106
107       • Type: String
108
109
110       Space-separated options that are always passed to search.   <!--  auto‐
111       matically  generated,  do not edit manually --> <!-- see lib/utils/con‐
112       fig/definitions.js -->
113
114
115   searchexclude
116       • Default: ""
117
118       • Type: String
119
120
121       Space-separated options that limit the results from search.  <!-- auto‐
122       matically  generated,  do not edit manually --> <!-- see lib/utils/con‐
123       fig/definitions.js -->
124
125
126   registry
127       • Default: "https://registry.npmjs.org/"
128
129       • Type: URL
130
131
132       The base URL of the npm registry.  <!-- automatically generated, do not
133       edit manually --> <!-- see lib/utils/config/definitions.js -->
134
135
136   prefer-online
137       • Default: false
138
139       • Type: Boolean
140
141
142       If  true,  staleness  checks for cached data will be forced, making the
143       CLI look for updates immediately even for fresh package data.  <!-- au‐
144       tomatically generated, do not edit manually --> <!-- see lib/utils/con‐
145       fig/definitions.js -->
146
147
148   prefer-offline
149       • Default: false
150
151       • Type: Boolean
152
153
154       If true, staleness checks for cached data will be bypassed, but missing
155       data will be requested from the server. To force full offline mode, use
156       --offline.  <!-- automatically generated, do not edit manually --> <!--
157       see lib/utils/config/definitions.js -->
158
159
160   offline
161       • Default: false
162
163       • Type: Boolean
164
165
166       Force offline mode: no network requests will be done during install. To
167       allow the CLI to fill in  missing  cache  data,  see  --prefer-offline.
168       <!--  automatically  generated,  do  not  edit  manually  -->  <!-- see
169       lib/utils/config/definitions.js -->
170
171       <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
172
173
174   See Also
175       • npm help registry
176
177       • npm help config
178
179       • npm help npmrc
180
181       • npm help view
182
183       • npm help cache
184
185       • https://npm.im/npm-registry-fetch
186
187
188
189
190                                 October 2021                    NPM-SEARCH(1)