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 116footer#edit { 117 border-top: solid 1px #e1e4e8; 118 margin: 3em 0 4em 0; 119 padding-top: 2em; 120} 121</style> 122</head> 123<body> 124<div id="banner"> 125<div id="rainbar"></div> 126<div id="logobar"> 127<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700"> 128<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon> 129<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon> 130</svg> 131<div class="title"> 132npm command-line interface 133</div> 134</div> 135</div> 136 137<section id="content"> 138<header class="title"> 139<h1 id="npm-search">npm-search</h1> 140<span class="description">Search for packages</span> 141</header> 142 143<section id="table_of_contents"> 144<h2 id="table-of-contents">Table of contents</h2> 145<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="#long"><code>long</code></a></li><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="#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> 146</section> 147 148<div id="_content"><h3 id="synopsis">Synopsis</h3> 149<pre><code class="language-bash">npm search [search terms ...] 150 151aliases: find, s, se 152</code></pre> 153<p>Note: This command is unaware of workspaces.</p> 154<h3 id="description">Description</h3> 155<p>Search the registry for packages matching the search terms. <code>npm search</code> 156performs a linear, incremental, lexically-ordered search through package 157metadata for all files in the registry. If your terminal has color 158support, it will further highlight the matches in the results. This can 159be disabled with the config item <code>color</code></p> 160<p>Additionally, using the <code>--searchopts</code> and <code>--searchexclude</code> options 161paired with more search terms will include and exclude further patterns. 162The main difference between <code>--searchopts</code> and the standard search terms 163is that the former does not highlight results in the output and you can 164use them more fine-grained filtering. Additionally, you can add both of 165these to your config to change default search filtering behavior.</p> 166<p>Search also allows targeting of maintainers in search results, by prefixing 167their npm username with <code>=</code>.</p> 168<p>If a term starts with <code>/</code>, then it's interpreted as a regular expression 169and supports standard JavaScript RegExp syntax. In this case search will 170ignore a trailing <code>/</code> . (Note you must escape or quote many regular 171expression characters in most shells.)</p> 172<h3 id="configuration">Configuration</h3> 173<h4 id="long"><code>long</code></h4> 174<ul> 175<li>Default: false</li> 176<li>Type: Boolean</li> 177</ul> 178<p>Show extended information in <code>ls</code>, <code>search</code>, and <code>help-search</code>.</p> 179<h4 id="json"><code>json</code></h4> 180<ul> 181<li>Default: false</li> 182<li>Type: Boolean</li> 183</ul> 184<p>Whether or not to output JSON data, rather than the normal output.</p> 185<ul> 186<li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before 187saving them to your <code>package.json</code>.</li> 188</ul> 189<p>Not supported by all npm commands.</p> 190<h4 id="color"><code>color</code></h4> 191<ul> 192<li>Default: true unless the NO_COLOR environ is set to something other than '0'</li> 193<li>Type: "always" or Boolean</li> 194</ul> 195<p>If false, never shows colors. If <code>"always"</code> then always shows colors. If 196true, then only prints color codes for tty file descriptors.</p> 197<h4 id="parseable"><code>parseable</code></h4> 198<ul> 199<li>Default: false</li> 200<li>Type: Boolean</li> 201</ul> 202<p>Output parseable results from commands that write to standard output. For 203<code>npm search</code>, this will be tab-separated table format.</p> 204<h4 id="description2"><code>description</code></h4> 205<ul> 206<li>Default: true</li> 207<li>Type: Boolean</li> 208</ul> 209<p>Show the description in <code>npm search</code></p> 210<h4 id="searchopts"><code>searchopts</code></h4> 211<ul> 212<li>Default: ""</li> 213<li>Type: String</li> 214</ul> 215<p>Space-separated options that are always passed to search.</p> 216<h4 id="searchexclude"><code>searchexclude</code></h4> 217<ul> 218<li>Default: ""</li> 219<li>Type: String</li> 220</ul> 221<p>Space-separated options that limit the results from search.</p> 222<h4 id="registry"><code>registry</code></h4> 223<ul> 224<li>Default: "<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>"</li> 225<li>Type: URL</li> 226</ul> 227<p>The base URL of the npm registry.</p> 228<h4 id="prefer-online"><code>prefer-online</code></h4> 229<ul> 230<li>Default: false</li> 231<li>Type: Boolean</li> 232</ul> 233<p>If true, staleness checks for cached data will be forced, making the CLI 234look for updates immediately even for fresh package data.</p> 235<h4 id="prefer-offline"><code>prefer-offline</code></h4> 236<ul> 237<li>Default: false</li> 238<li>Type: Boolean</li> 239</ul> 240<p>If true, staleness checks for cached data will be bypassed, but missing data 241will be requested from the server. To force full offline mode, use 242<code>--offline</code>.</p> 243<h4 id="offline"><code>offline</code></h4> 244<ul> 245<li>Default: false</li> 246<li>Type: Boolean</li> 247</ul> 248<p>Force offline mode: no network requests will be done during install. To 249allow the CLI to fill in missing cache data, see <code>--prefer-offline</code>.</p> 250<h3 id="see-also">See Also</h3> 251<ul> 252<li><a href="../using-npm/registry.html">npm registry</a></li> 253<li><a href="../commands/npm-config.html">npm config</a></li> 254<li><a href="../configuring-npm/npmrc.html">npmrc</a></li> 255<li><a href="../commands/npm-view.html">npm view</a></li> 256<li><a href="../commands/npm-cache.html">npm cache</a></li> 257<li><a href="https://npm.im/npm-registry-fetch">https://npm.im/npm-registry-fetch</a></li> 258</ul></div> 259 260<footer id="edit"> 261<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-search.md"> 262<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;"> 263<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> 264</svg> 265Edit this page on GitHub 266</a> 267</footer> 268</section> 269 270 271 272</body></html>