--- section: cli-commands title: npm-search description: Search for packages --- # npm-search(1) ## Search for packages ### Synopsis ```bash npm search [-l|--long] [--json] [--parseable] [--no-description] [search terms ...] aliases: s, se, find ``` ### Description Search the registry for packages matching the search terms. `npm search` 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. Additionally, using the `--searchopts` and `--searchexclude` options paired with more search terms will respectively include and exclude further patterns. The main difference between `--searchopts` 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 `.npmrc` for default search filtering behavior. Search also allows targeting of maintainers in search results, by prefixing their npm username with `=`. If a term starts with `/`, then it's interpreted as a regular expression and supports standard JavaScript RegExp syntax. A trailing `/` will be ignored in this case. (Note that many regular expression characters must be escaped or quoted in most shells.) ### A Note on caching ### Configuration #### description * Default: true * Type: Boolean Used as `--no-description`, disables search matching in package descriptions and suppresses display of that field in results. #### json * Default: false * Type: Boolean Output search results as a JSON array. #### parseable * Default: false * Type: Boolean Output search results as lines with tab-separated columns. #### long * Default: false * Type: Boolean 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. #### searchopts * Default: "" * Type: String Space-separated options that are always passed to search. #### searchexclude * Default: "" * Type: String Space-separated options that limit the results from search. #### searchstaleness * Default: 900 (15 minutes) * Type: Number The age of the cache, in seconds, before another registry request is made. #### registry * Default: https://registry.npmjs.org/ * Type: url 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, `npm search` will default to that registry when searching. Pass a different registry url such as the default above in order to override this setting. ### See Also * [npm registry](/using-npm/registry) * [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) * [npm view](/cli-commands/npm-view)
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
npm-access.md | File | 2.87 KB | 0644 |
|
npm-adduser.md | File | 2.93 KB | 0644 |
|
npm-audit.md | File | 4.08 KB | 0644 |
|
npm-bin.md | File | 452 B | 0644 |
|
npm-bugs.md | File | 1.08 KB | 0644 |
|
npm-build.md | File | 645 B | 0644 |
|
npm-bundle.md | File | 416 B | 0644 |
|
npm-cache.md | File | 2.73 KB | 0644 |
|
npm-ci.md | File | 1.92 KB | 0644 |
|
npm-completion.md | File | 936 B | 0644 |
|
npm-config.md | File | 1.62 KB | 0644 |
|
npm-dedupe.md | File | 1.44 KB | 0644 |
|
npm-deprecate.md | File | 953 B | 0644 |
|
npm-dist-tag.md | File | 2.95 KB | 0644 |
|
npm-docs.md | File | 1.14 KB | 0644 |
|
npm-doctor.md | File | 4.65 KB | 0644 |
|
npm-edit.md | File | 1.07 KB | 0644 |
|
npm-explore.md | File | 1.04 KB | 0644 |
|
npm-fund.md | File | 1.59 KB | 0644 |
|
npm-help-search.md | File | 910 B | 0644 |
|
npm-help.md | File | 989 B | 0644 |
|
npm-hook.md | File | 1.88 KB | 0644 |
|
npm-init.md | File | 2.17 KB | 0644 |
|
npm-install-ci-test.md | File | 438 B | 0644 |
|
npm-install-test.md | File | 832 B | 0644 |
|
npm-install.md | File | 19.03 KB | 0644 |
|
npm-link.md | File | 2.75 KB | 0644 |
|
npm-logout.md | File | 1.28 KB | 0644 |
|
npm-ls.md | File | 2.57 KB | 0644 |
|
npm-org.md | File | 1.01 KB | 0644 |
|
npm-outdated.md | File | 3.86 KB | 0644 |
|
npm-owner.md | File | 1.22 KB | 0644 |
|
npm-pack.md | File | 1.01 KB | 0644 |
|
npm-ping.md | File | 519 B | 0644 |
|
npm-prefix.md | File | 678 B | 0644 |
|
npm-profile.md | File | 2.89 KB | 0644 |
|
npm-prune.md | File | 1.38 KB | 0644 |
|
npm-publish.md | File | 3.12 KB | 0644 |
|
npm-rebuild.md | File | 495 B | 0644 |
|
npm-repo.md | File | 774 B | 0644 |
|
npm-restart.md | File | 962 B | 0644 |
|
npm-root.md | File | 438 B | 0644 |
|
npm-run-script.md | File | 3.49 KB | 0644 |
|
npm-search.md | File | 2.85 KB | 0644 |
|
npm-shrinkwrap.md | File | 1004 B | 0644 |
|
npm-star.md | File | 591 B | 0644 |
|
npm-stars.md | File | 614 B | 0644 |
|
npm-start.md | File | 798 B | 0644 |
|
npm-stop.md | File | 452 B | 0644 |
|
npm-team.md | File | 2.2 KB | 0644 |
|
npm-test.md | File | 469 B | 0644 |
|
npm-token.md | File | 2.8 KB | 0644 |
|
npm-uninstall.md | File | 1.53 KB | 0644 |
|
npm-unpublish.md | File | 1.45 KB | 0644 |
|
npm-update.md | File | 3.39 KB | 0644 |
|
npm-version.md | File | 4.47 KB | 0644 |
|
npm-view.md | File | 3.19 KB | 0644 |
|
npm-whoami.md | File | 385 B | 0644 |
|
npm.md | File | 5.31 KB | 0644 |
|