FM / commands

/snap/node/11691/lib/node_modules/npm/docs/content/commands/

/snap/node/11691/lib/node_modules/npm/docs/content/commands

Name	Size	Mode	Actions
npm-access.md	3664	0644	edit dl rm
npm-adduser.md	1847	0644	edit dl rm
npm-audit.md	15656	0644	edit dl rm
npm-bugs.md	2996	0644	edit dl rm
npm-cache.md	2962	0644	edit dl rm
npm-ci.md	9125	0644	edit dl rm
npm-completion.md	909	0644	edit dl rm
npm-config.md	4093	0644	edit dl rm
npm-dedupe.md	8895	0644	edit dl rm
npm-deprecate.md	1741	0644	edit dl rm
npm-diff.md	9109	0644	edit dl rm
npm-dist-tag.md	5181	0644	edit dl rm
npm-docs.md	2974	0644	edit dl rm
npm-doctor.md	5057	0644	edit dl rm
npm-edit.md	1091	0644	edit dl rm
npm-exec.md	11401	0644	edit dl rm
npm-explain.md	2795	0644	edit dl rm
npm-explore.md	1006	0644	edit dl rm
npm-find-dupes.md	6797	0644	edit dl rm
npm-fund.md	3673	0644	edit dl rm
npm-help-search.md	756	0644	edit dl rm
npm-help.md	1004	0644	edit dl rm
npm-hook.md	2394	0644	edit dl rm
npm-init.md	9855	0644	edit dl rm
npm-install-ci-test.md	7434	0644	edit dl rm
npm-install-test.md	9814	0644	edit dl rm
npm-install.md	24984	0644	edit dl rm
npm-link.md	11742	0644	edit dl rm
npm-login.md	2171	0644	edit dl rm
npm-logout.md	1749	0644	edit dl rm
npm-ls.md	8547	0644	edit dl rm
npm-org.md	1975	0644	edit dl rm
npm-outdated.md	5779	0644	edit dl rm
npm-owner.md	3093	0644	edit dl rm
npm-pack.md	3448	0644	edit dl rm
npm-ping.md	769	0644	edit dl rm
npm-pkg.md	8129	0644	edit dl rm
npm-prefix.md	1211	0644	edit dl rm
npm-profile.md	3102	0644	edit dl rm
npm-prune.md	5745	0644	edit dl rm
npm-publish.md	7622	0644	edit dl rm
npm-query.md	6958	0644	edit dl rm
npm-rebuild.md	5001	0644	edit dl rm
npm-repo.md	2754	0644	edit dl rm
npm-restart.md	1473	0644	edit dl rm
npm-root.md	1097	0644	edit dl rm
npm-run-script.md	7561	0644	edit dl rm
npm-sbom.md	8337	0644	edit dl rm
npm-search.md	3464	0644	edit dl rm
npm-shrinkwrap.md	923	0644	edit dl rm
npm-star.md	1713	0644	edit dl rm
npm-stars.md	743	0644	edit dl rm
npm-start.md	1667	0644	edit dl rm
npm-stop.md	1341	0644	edit dl rm
npm-team.md	4090	0644	edit dl rm
npm-test.md	1234	0644	edit dl rm
npm-token.md	2893	0644	edit dl rm
npm-uninstall.md	4447	0644	edit dl rm
npm-unpublish.md	4491	0644	edit dl rm
npm-unstar.md	1574	0644	edit dl rm
npm-update.md	11871	0644	edit dl rm
npm-version.md	6902	0644	edit dl rm
npm-view.md	5612	0644	edit dl rm
npm-whoami.md	800	0644	edit dl rm
npm.md	5670	0644	edit dl rm
npx.md	5895	0644	edit dl rm

Edit: /snap/node/11691/lib/node_modules/npm/docs/content/commands/npm-search.md (3464B)

---
title: npm-search
section: 1
description: Search for packages
---

### Synopsis

```bash
npm search <search term> [<search term> ...]

aliases: find, s, se
```

Note: This command is unaware of workspaces.

### 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 your terminal has color
support, it will further highlight the matches in the results.  This can
be disabled with the config item `color`

Additionally, using the `--searchopts` and `--searchexclude` options
paired with more search terms will 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 you can
use them more fine-grained filtering. Additionally, you can add both of
these to your config to change 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. In this case search will
ignore a trailing `/` .  (Note you must escape or quote many regular
expression characters in most shells.)

### Configuration

#### `json`

* Default: false
* Type: Boolean

Whether or not to output JSON data, rather than the normal output.

* In `npm pkg set` it enables parsing set values with JSON.parse() before
  saving them to your `package.json`.

Not supported by all npm commands.

#### `color`

* Default: true unless the NO_COLOR environ is set to something other than '0'
* Type: "always" or Boolean

If false, never shows colors. If `"always"` then always shows colors. If
true, then only prints color codes for tty file descriptors.

#### `parseable`

* Default: false
* Type: Boolean

Output parseable results from commands that write to standard output. For
`npm search`, this will be tab-separated table format.

#### `description`

* Default: true
* Type: Boolean

Show the description in `npm search`

#### `searchlimit`

* Default: 20
* Type: Number

Number of items to limit search results to. Will not apply at all to legacy
searches.

#### `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.

#### `registry`

* Default: "https://registry.npmjs.org/"
* Type: URL

The base URL of the npm registry.

#### `prefer-online`

* Default: false
* Type: Boolean

If true, staleness checks for cached data will be forced, making the CLI
look for updates immediately even for fresh package data.

#### `prefer-offline`

* Default: false
* Type: Boolean

If true, staleness checks for cached data will be bypassed, but missing data
will be requested from the server. To force full offline mode, use
`--offline`.

#### `offline`

* Default: false
* Type: Boolean

Force offline mode: no network requests will be done during install. To
allow the CLI to fill in missing cache data, see `--prefer-offline`.

### See Also

* [npm registry](/using-npm/registry)
* [npm config](/commands/npm-config)
* [npmrc](/configuring-npm/npmrc)
* [npm view](/commands/npm-view)
* [npm cache](/commands/npm-cache)
* https://npm.im/npm-registry-fetch

cmd: