.TH "NPM\-SEARCH" "1" "August 2020" "" "" .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 color is enabled, it will further highlight the matches in the results\. .P Additionally, using the \fB\-\-searchopts\fP and \fB\-\-searchexclude\fP options paired with more search terms will respectively 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 can be used for more fine\-grained filtering\. Additionally, both of these can be added to \fB\|\.npmrc\fP for 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\. A trailing \fB/\fP will be ignored in this case\. (Note that many regular expression characters must be escaped or quoted in most shells\.) .SS A Note on caching .SS Configuration .SS description .RS 0 .IP \(bu 2 Default: true .IP \(bu 2 Type: Boolean .RE .P Used as \fB\-\-no\-description\fP, disables search matching in package descriptions and suppresses display of that field in 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 (default) search results are truncated 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 searchstaleness .RS 0 .IP \(bu 2 Default: 900 (15 minutes) .IP \(bu 2 Type: Number .RE .P The age of the cache, in seconds, before another registry request is made\. .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 default to that registry when searching\. Pass a different registry url such as the default above in order to override this setting\. .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 .RE
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
npm-README.1 | File | 4.77 KB | 0644 |
|
npm-access.1 | File | 2.99 KB | 0644 |
|
npm-adduser.1 | File | 3.12 KB | 0644 |
|
npm-audit.1 | File | 4.39 KB | 0644 |
|
npm-bin.1 | File | 379 B | 0644 |
|
npm-bugs.1 | File | 1.05 KB | 0644 |
|
npm-build.1 | File | 639 B | 0644 |
|
npm-bundle.1 | File | 410 B | 0644 |
|
npm-cache.1 | File | 2.76 KB | 0644 |
|
npm-ci.1 | File | 2 KB | 0644 |
|
npm-completion.1 | File | 960 B | 0644 |
|
npm-config.1 | File | 1.62 KB | 0644 |
|
npm-dedupe.1 | File | 1.46 KB | 0644 |
|
npm-deprecate.1 | File | 952 B | 0644 |
|
npm-dist-tag.1 | File | 3.18 KB | 0644 |
|
npm-docs.1 | File | 1.14 KB | 0644 |
|
npm-doctor.1 | File | 4.84 KB | 0644 |
|
npm-edit.1 | File | 1.07 KB | 0644 |
|
npm-explore.1 | File | 1.11 KB | 0644 |
|
npm-fund.1 | File | 1.68 KB | 0644 |
|
npm-help-search.1 | File | 926 B | 0644 |
|
npm-help.1 | File | 965 B | 0644 |
|
npm-hook.1 | File | 2.05 KB | 0644 |
|
npm-init.1 | File | 2.37 KB | 0644 |
|
npm-install-ci-test.1 | File | 297 B | 0644 |
|
npm-install-test.1 | File | 755 B | 0644 |
|
npm-install.1 | File | 19.63 KB | 0644 |
|
npm-link.1 | File | 2.8 KB | 0644 |
|
npm-logout.1 | File | 1.25 KB | 0644 |
|
npm-ls.1 | File | 2.79 KB | 0644 |
|
npm-org.1 | File | 1.09 KB | 0644 |
|
npm-outdated.1 | File | 4.28 KB | 0644 |
|
npm-owner.1 | File | 1.21 KB | 0644 |
|
npm-pack.1 | File | 986 B | 0644 |
|
npm-ping.1 | File | 509 B | 0644 |
|
npm-prefix.1 | File | 618 B | 0644 |
|
npm-profile.1 | File | 3.49 KB | 0644 |
|
npm-prune.1 | File | 1.43 KB | 0644 |
|
npm-publish.1 | File | 3.14 KB | 0644 |
|
npm-rebuild.1 | File | 465 B | 0644 |
|
npm-repo.1 | File | 773 B | 0644 |
|
npm-restart.1 | File | 957 B | 0644 |
|
npm-root.1 | File | 374 B | 0644 |
|
npm-run-script.1 | File | 3.69 KB | 0644 |
|
npm-search.1 | File | 3.11 KB | 0644 |
|
npm-shrinkwrap.1 | File | 848 B | 0644 |
|
npm-star.1 | File | 544 B | 0644 |
|
npm-stars.1 | File | 539 B | 0644 |
|
npm-start.1 | File | 748 B | 0644 |
|
npm-stop.1 | File | 382 B | 0644 |
|
npm-team.1 | File | 2.26 KB | 0644 |
|
npm-test.1 | File | 399 B | 0644 |
|
npm-token.1 | File | 3.68 KB | 0644 |
|
npm-uninstall.1 | File | 1.63 KB | 0644 |
|
npm-unpublish.1 | File | 1.38 KB | 0644 |
|
npm-update.1 | File | 3.73 KB | 0644 |
|
npm-version.1 | File | 4.84 KB | 0644 |
|
npm-view.1 | File | 3.26 KB | 0644 |
|
npm-whoami.1 | File | 342 B | 0644 |
|
npm.1 | File | 5.53 KB | 0644 |
|
npx.1 | File | 6.7 KB | 0644 |
|