1NPM-FUND(1) NPM-FUND(1)
2
3
4
6 npm-fund - Retrieve funding information
7
8 Synopsis
9 npm fund [<pkg>]
10
11 Description
12 This command retrieves information on how to fund the dependencies of a
13 given project. If no package name is provided, it will list all depen‐
14 dencies that are looking for funding in a tree-structure in which are
15 listed the type of funding and the url to visit. If a package name is
16 provided then it tries to open its funding url using the --browser con‐
17 fig param; if there are multiple funding sources for the package, the
18 user will be instructed to pass the --which command to disambiguate.
19
20 The list will avoid duplicated entries and will stack all packages that
21 share the same type/url as a single entry. Given this nature the list
22 is not going to have the same shape of the output from npm ls.
23
24 Configuration
25 browser
26 • Default: OS X: "open", Windows: "start", Others: "xdg-open"
27
28 • Type: String
29
30
31 The browser that is called by the npm fund command to open websites.
32
33 json
34 • Type: Boolean
35
36 • Default: false
37
38
39 Show information in JSON format.
40
41 unicode
42 • Type: Boolean
43
44 • Default: true
45
46
47 Whether to represent the tree structure using unicode characters. Set
48 it to false in order to use all-ansi output.
49
50 which
51 • Type: Number
52
53 • Default: undefined
54
55
56 If there are multiple funding sources, which 1-indexed source URL to
57 open.
58
60 • npm help docs
61
62 • npm help config
63
64 • npm help install
65
66 • npm help ls
67
68
69
70
71 April 2021 NPM-FUND(1)