codekingpro/portable-devtools

1.TH "NPM-FUND" "1" "April 2026" "NPM@11.13.0" ""
2.SH "NAME"
3\fBnpm-fund\fR - Retrieve funding information
4.SS "Synopsis"
5.P
6.RS 2
7.nf
8npm fund \[lB]<package-spec>\[rB]
9.fi
10.RE
11.SS "Description"
12.P
13This 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, listing 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 \fB\[rs]fB--browser\[rs]fR config\fR \fI\(la/using-npm/config#browser\(ra\fR param; if there are multiple funding sources for the package, the user will be instructed to pass the \fB--which\fR option to disambiguate.
14.P
15The list will avoid duplicated entries and will stack all packages that share the same url as a single entry. Thus, the list does not have the same shape of the output from \fBnpm ls\fR.
16.SS "Example"
17.SS "Workspaces support"
18.P
19It's possible to filter the results to only include a single workspace and its dependencies using the \fB\[rs]fBworkspace\[rs]fR config\fR \fI\(la/using-npm/config#workspace\(ra\fR option.
20.SS "Example:"
21.P
22Here's an example running \fBnpm fund\fR in a project with a configured workspace \fBa\fR:
23.P
24.RS 2
25.nf
26$ npm fund
27test-workspaces-fund@1.0.0
28+-- https://example.com/a
29| | `-- a@1.0.0
30| `-- https://example.com/maintainer
31|     `-- foo@1.0.0
32+-- https://example.com/npmcli-funding
33|   `-- @npmcli/test-funding
34`-- https://example.com/org
35    `-- bar@2.0.0
36.fi
37.RE
38.P
39And here is an example of the expected result when filtering only by a specific workspace \fBa\fR in the same project:
40.P
41.RS 2
42.nf
43$ npm fund -w a
44test-workspaces-fund@1.0.0
45`-- https://example.com/a
46  | `-- a@1.0.0
47  `-- https://example.com/maintainer
48      `-- foo@2.0.0
49.fi
50.RE
51.SS "Configuration"
52.SS "\fBjson\fR"
53.RS 0
54.IP \(bu 4
55Default: false
56.IP \(bu 4
57Type: Boolean
58.RE 0
59
60.P
61Whether or not to output JSON data, rather than the normal output.
62.RS 0
63.IP \(bu 4
64In \fBnpm pkg set\fR it enables parsing set values with JSON.parse() before saving them to your \fBpackage.json\fR.
65.RE 0
66
67.P
68Not supported by all npm commands.
69.SS "\fBbrowser\fR"
70.RS 0
71.IP \(bu 4
72Default: macOS: \fB"open"\fR, Windows: \fB"start"\fR, Others: \fB"xdg-open"\fR
73.IP \(bu 4
74Type: null, Boolean, or String
75.RE 0
76
77.P
78The browser that is called by npm commands to open websites.
79.P
80Set to \fBfalse\fR to suppress browser behavior and instead print urls to terminal.
81.P
82Set to \fBtrue\fR to use default system URL opener.
83.SS "\fBunicode\fR"
84.RS 0
85.IP \(bu 4
86Default: false on windows, true on mac/unix systems with a unicode locale, as defined by the \fBLC_ALL\fR, \fBLC_CTYPE\fR, or \fBLANG\fR environment variables.
87.IP \(bu 4
88Type: Boolean
89.RE 0
90
91.P
92When set to true, npm uses unicode characters in the tree output. When false, it uses ascii characters instead of unicode glyphs.
93.SS "\fBworkspace\fR"
94.RS 0
95.IP \(bu 4
96Default:
97.IP \(bu 4
98Type: String (can be set multiple times)
99.RE 0
100
101.P
102Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option.
103.P
104Valid values for the \fBworkspace\fR config are either:
105.RS 0
106.IP \(bu 4
107Workspace names
108.IP \(bu 4
109Path to a workspace directory
110.IP \(bu 4
111Path to a parent workspace directory (will result in selecting all workspaces within that folder)
112.RE 0
113
114.P
115When set for the \fBnpm init\fR command, this may be set to the folder of a workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.
116.P
117This value is not exported to the environment for child processes.
118.SS "\fBwhich\fR"
119.RS 0
120.IP \(bu 4
121Default: null
122.IP \(bu 4
123Type: null or Number
124.RE 0
125
126.P
127If there are multiple funding sources, which 1-indexed source URL to open.
128.SH "SEE ALSO"
129.RS 0
130.IP \(bu 4
131npm help "package spec"
132.IP \(bu 4
133npm help install
134.IP \(bu 4
135npm help docs
136.IP \(bu 4
137npm help ls
138.IP \(bu 4
139npm help config
140.IP \(bu 4
141npm help workspaces
142.RE 0
143