Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

npm-search (1)

Name

npm-search - Search for packages

Synopsis

npm search [-l|--long] [--json] [--parseable] [--no-description] [search terms ...]

aliases: s, se, find

Description

NPM-SEARCH(1)                                                    NPM-SEARCH(1)



NAME
       npm-search - Search for packages

SYNOPSIS
         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  pack-
       age  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 out-
       put 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 pre-
       fixing 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
       o Default: true

       o Type: Boolean


       Used  as --no-description, disables search matching in package descrip-
       tions and suppresses display of that field in results.

   json
       o Default: false

       o Type: Boolean


       Output search results as a JSON array.

   parseable
       o Default: false

       o Type: Boolean


       Output search results as lines with tab-separated columns.

   long
       o Default: false

       o 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
       o Default: ""

       o Type: String


       Space-separated options that are always passed to search.

   searchexclude
       o Default: ""

       o Type: String


       Space-separated options that limit the results from search.

   searchstaleness
       o Default: 900 (15 minutes)

       o Type: Number


       The  age  of  the cache, in seconds, before another registry request is
       made.

   registry
       o Default: https://

       o 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.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-------------------------+
       |ATTRIBUTE TYPE |    ATTRIBUTE VALUE      |
       +---------------+-------------------------+
       |Availability   | runtime/nodejs/nodejs-8 |
       +---------------+-------------------------+
       |Stability      | Pass-thru volatile      |
       +---------------+-------------------------+
SEE ALSO
       o npm help 7 registry

       o npm help config

       o npm help 7 config

       o npm help 5 npmrc

       o npm help view





NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was   downloaded   from     https://github.com/nodejs/node/ar-
       chive/v8.15.1.zip

       Further information about this software can be found on the open source
       community website at https://github.com/nodejs/node.



                                  August 2018                    NPM-SEARCH(1)