• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
"NPM-FUND" "1" "April 2022" "" ""
"NAME"
npm-fund - Retrieve funding information
Synopsis

 npm fund [<pkg>]
Description

This command retrieves information on how to fund the dependencies of a given project\. If no package name is provided, it will list all dependencies that are looking for funding in a tree-structure in which are listed the type of funding and the url to visit\. If a package name is provided then it tries to open its funding url using the --browser config param; if there are multiple funding sources for the package, the user will be instructed to pass the --which command to disambiguate\.

The list will avoid duplicated entries and will stack all packages that share the same type/url as a single entry\. Given this nature the list is not going to have the same shape of the output from npm ls\|\.

Configuration
browser

\(bu 2
Default: OS X: "open", Windows: "start", Others: "xdg-open"
\(bu 2
Type: String

The browser that is called by the npm fund command to open websites\.

json

\(bu 2
Type: Boolean
\(bu 2
Default: false

Show information in JSON format\.

unicode

\(bu 2
Type: Boolean
\(bu 2
Default: true

Whether to represent the tree structure using unicode characters\. Set it to false in order to use all-ansi output\.

which

\(bu 2
Type: Number
\(bu 2
Default: undefined

If there are multiple funding sources, which 1-indexed source URL to open\.

See Also

\(bu 2
npm help docs
\(bu 2
npm help config
\(bu 2
npm help install
\(bu 2
npm help ls