codekingpro/portable-devtools
114k
1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>npm-search</title>
4<style>
5body {
6 background-color: #ffffff;
7 color: #24292e;
8
9 margin: 0;
10
11 line-height: 1.5;
12
13 font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
14}
15#rainbar {
16 height: 10px;
17 background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
18}
19
20a {
21 text-decoration: none;
22 color: #0366d6;
23}
24a:hover {
25 text-decoration: underline;
26}
27
28pre {
29 margin: 1em 0px;
30 padding: 1em;
31 border: solid 1px #e1e4e8;
32 border-radius: 6px;
33
34 display: block;
35 overflow: auto;
36
37 white-space: pre;
38
39 background-color: #f6f8fa;
40 color: #393a34;
41}
42code {
43 font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
44 font-size: 85%;
45 padding: 0.2em 0.4em;
46 background-color: #f6f8fa;
47 color: #393a34;
48}
49pre > code {
50 padding: 0;
51 background-color: inherit;
52 color: inherit;
53}
54h1, h2, h3 {
55 font-weight: 600;
56}
57
58#logobar {
59 background-color: #333333;
60 margin: 0 auto;
61 padding: 1em 4em;
62}
63#logobar .logo {
64 float: left;
65}
66#logobar .title {
67 font-weight: 600;
68 color: #dddddd;
69 float: left;
70 margin: 5px 0 0 1em;
71}
72#logobar:after {
73 content: "";
74 display: block;
75 clear: both;
76}
77
78#content {
79 margin: 0 auto;
80 padding: 0 4em;
81}
82
83#table_of_contents > h2 {
84 font-size: 1.17em;
85}
86#table_of_contents ul:first-child {
87 border: solid 1px #e1e4e8;
88 border-radius: 6px;
89 padding: 1em;
90 background-color: #f6f8fa;
91 color: #393a34;
92}
93#table_of_contents ul {
94 list-style-type: none;
95 padding-left: 1.5em;
96}
97#table_of_contents li {
98 font-size: 0.9em;
99}
100#table_of_contents li a {
101 color: #000000;
102}
103
104header.title {
105 border-bottom: solid 1px #e1e4e8;
106}
107header.title > h1 {
108 margin-bottom: 0.25em;
109}
110header.title > .description {
111 display: block;
112 margin-bottom: 0.5em;
113 line-height: 1;
114}
115
116header.title .version {
117 font-size: 0.8em;
118 color: #666666;
119}
120
121footer#edit {
122 border-top: solid 1px #e1e4e8;
123 margin: 3em 0 4em 0;
124 padding-top: 2em;
125}
126
127table {
128 width: 100%;
129 margin: 1em 0;
130 border-radius: 6px;
131 border: 1px solid #e1e4e8;
132 overflow: hidden;
133 border-collapse: separate;
134 border-spacing: 0;
135}
136
137table thead {
138 background-color: #f6f8fa;
139}
140
141table tbody {
142 background-color: #ffffff;
143}
144
145table th,
146table td {
147 padding: 0.75em;
148 text-align: left;
149 border-right: 1px solid #e1e4e8;
150 border-bottom: 1px solid #e1e4e8;
151}
152
153table th:last-child,
154table td:last-child {
155 border-right: none;
156}
157
158table tbody tr:last-child td {
159 border-bottom: none;
160}
161
162table th {
163 font-weight: 600;
164 background-color: #f6f8fa;
165}
166
167table code {
168 white-space: nowrap;
169}
170
171</style>
172</head>
173<body>
174<div id="banner">
175<div id="rainbar"></div>
176<div id="logobar">
177<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
178<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
179<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
180</svg>
181<div class="title">
182npm command-line interface
183</div>
184</div>
185</div>
186
187<section id="content">
188<header class="title">
189<h1 id="----npm-search----11121">
190 <span>npm-search</span>
191 <span class="version">@11.12.1</span>
192</h1>
193<span class="description">Search for packages</span>
194</header>
195
196<section id="table_of_contents">
197<h2 id="table-of-contents">Table of contents</h2>
198<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#json"><code>json</code></a></li><li><a href="#color"><code>color</code></a></li><li><a href="#parseable"><code>parseable</code></a></li><li><a href="#description2"><code>description</code></a></li><li><a href="#searchlimit"><code>searchlimit</code></a></li><li><a href="#searchopts"><code>searchopts</code></a></li><li><a href="#searchexclude"><code>searchexclude</code></a></li><li><a href="#registry"><code>registry</code></a></li><li><a href="#prefer-online"><code>prefer-online</code></a></li><li><a href="#prefer-offline"><code>prefer-offline</code></a></li><li><a href="#offline"><code>offline</code></a></li></ul><li><a href="#see-also">See Also</a></li></ul></div>
199</section>
200
201<div id="_content"><h3 id="synopsis">Synopsis</h3>
202<pre><code class="language-bash">npm search <search term> [<search term> ...]
203
204aliases: find, s, se
205</code></pre>
206<p>Note: This command is unaware of workspaces.</p>
207<h3 id="description">Description</h3>
208<p>Search the registry for packages matching the search terms.
209<code>npm search</code>
210performs a linear, incremental, lexically-ordered search through package metadata for all files in the registry.
211If your terminal has color support, it will further highlight the matches in the results.
212This can be disabled with the config item <code>color</code></p>
213<p>Additionally, using the <code>--searchopts</code> and <code>--searchexclude</code> options paired with more search terms will include and exclude further patterns.
214The main difference between <code>--searchopts</code> 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.
215Additionally, you can add both of these to your config to change default search filtering behavior.</p>
216<p>Search also allows targeting of maintainers in search results, by prefixing their npm username with <code>=</code>.</p>
217<p>If a term starts with <code>/</code>, then it's interpreted as a regular expression and supports standard JavaScript RegExp syntax.
218In this case search will ignore a trailing <code>/</code> . (Note you must escape or quote many regular expression characters in most shells.)</p>
219<h3 id="configuration">Configuration</h3>
220<h4 id="json"><code>json</code></h4>
221<ul>
222<li>Default: false</li>
223<li>Type: Boolean</li>
224</ul>
225<p>Whether or not to output JSON data, rather than the normal output.</p>
226<ul>
227<li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before
228saving them to your <code>package.json</code>.</li>
229</ul>
230<p>Not supported by all npm commands.</p>
231<h4 id="color"><code>color</code></h4>
232<ul>
233<li>Default: true unless the NO_COLOR environ is set to something other than '0'</li>
234<li>Type: "always" or Boolean</li>
235</ul>
236<p>If false, never shows colors. If <code>"always"</code> then always shows colors. If
237true, then only prints color codes for tty file descriptors.</p>
238<h4 id="parseable"><code>parseable</code></h4>
239<ul>
240<li>Default: false</li>
241<li>Type: Boolean</li>
242</ul>
243<p>Output parseable results from commands that write to standard output. For
244<code>npm search</code>, this will be tab-separated table format.</p>
245<h4 id="description2"><code>description</code></h4>
246<ul>
247<li>Default: true</li>
248<li>Type: Boolean</li>
249</ul>
250<p>Show the description in <code>npm search</code></p>
251<h4 id="searchlimit"><code>searchlimit</code></h4>
252<ul>
253<li>Default: 20</li>
254<li>Type: Number</li>
255</ul>
256<p>Number of items to limit search results to. Will not apply at all to legacy
257searches.</p>
258<h4 id="searchopts"><code>searchopts</code></h4>
259<ul>
260<li>Default: ""</li>
261<li>Type: String</li>
262</ul>
263<p>Space-separated options that are always passed to search.</p>
264<h4 id="searchexclude"><code>searchexclude</code></h4>
265<ul>
266<li>Default: ""</li>
267<li>Type: String</li>
268</ul>
269<p>Space-separated options that limit the results from search.</p>
270<h4 id="registry"><code>registry</code></h4>
271<ul>
272<li>Default: "<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>"</li>
273<li>Type: URL</li>
274</ul>
275<p>The base URL of the npm registry.</p>
276<h4 id="prefer-online"><code>prefer-online</code></h4>
277<ul>
278<li>Default: false</li>
279<li>Type: Boolean</li>
280</ul>
281<p>If true, staleness checks for cached data will be forced, making the CLI
282look for updates immediately even for fresh package data.</p>
283<h4 id="prefer-offline"><code>prefer-offline</code></h4>
284<ul>
285<li>Default: false</li>
286<li>Type: Boolean</li>
287</ul>
288<p>If true, staleness checks for cached data will be bypassed, but missing data
289will be requested from the server. To force full offline mode, use
290<code>--offline</code>.</p>
291<h4 id="offline"><code>offline</code></h4>
292<ul>
293<li>Default: false</li>
294<li>Type: Boolean</li>
295</ul>
296<p>Force offline mode: no network requests will be done during install. To
297allow the CLI to fill in missing cache data, see <code>--prefer-offline</code>.</p>
298<h3 id="see-also">See Also</h3>
299<ul>
300<li><a href="../using-npm/registry.html">npm registry</a></li>
301<li><a href="../commands/npm-config.html">npm config</a></li>
302<li><a href="../configuring-npm/npmrc.html">npmrc</a></li>
303<li><a href="../commands/npm-view.html">npm view</a></li>
304<li><a href="../commands/npm-cache.html">npm cache</a></li>
305<li><a href="https://npm.im/npm-registry-fetch">https://npm.im/npm-registry-fetch</a></li>
306</ul></div>
307
308<footer id="edit">
309<a href="https://github.com/npm/cli/edit/latest/docs/lib/content/commands/npm-search.md">
310<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
311<path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path>
312</svg>
313Edit this page on GitHub
314</a>
315</footer>
316</section>
317
318
319
320</body></html>