.TH "NPM\-FUND" "1" "November 2022" "9.1.1"
.SH "NAME"
\fBnpm-fund\fR
.SH Synopsis
<!\-\- AUTOGENERATED USAGE DESCRIPTIONS \-\->

.SH Description
.P
This command retrieves information on how to fund the dependencies of a
.br
given project\. If no package name is provided, it will list all
.br
dependencies that are looking for funding in a tree structure, listing
.br
the type of funding and the url to visit\. If a package name is provided
.br
then it tries to open its funding url using the
.br
\fB\-\-browser\fP config param; if there are multiple
.br
funding sources for the package, the user will be instructed to pass the
.br
\fB\-\-which\fP option to disambiguate\.
.P
The list will avoid duplicated entries and will stack all packages that
.br
share the same url as a single entry\. Thus, the list does not have the
.br
same shape of the output from \fBnpm ls\fP\|\.
.SS Example
.SH Workspaces support
.P
It's possible to filter the results to only include a single workspace
.br
and its dependencies using the
.br
\fBworkspace\fP config option\.
.SS Example:
.P
Here's an example running \fBnpm fund\fP in a project with a configured
.br
workspace \fBa\fP:
.RS 2
.nf
$ npm fund
test\-workspaces\-fund@1\.0\.0
+\-\- https://example\.com/a
| | `\-\- a@1\.0\.0
| `\-\- https://example\.com/maintainer
|     `\-\- foo@1\.0\.0
+\-\- https://example\.com/npmcli\-funding
|   `\-\- @npmcli/test\-funding
`\-\- https://example\.com/org
    `\-\- bar@2\.0\.0
.fi
.RE
.P
And here is an example of the expected result when filtering only by a
.br
specific workspace \fBa\fP in the same project:
.RS 2
.nf
$ npm fund \-w a
test\-workspaces\-fund@1\.0\.0
`\-\- https://example\.com/a
  | `\-\- a@1\.0\.0
  `\-\- https://example\.com/maintainer
      `\-\- foo@2\.0\.0
.fi
.RE
.SH Configuration
<!\-\- AUTOGENERATED CONFIG DESCRIPTIONS \-\->

.SH See Also

.RS 1
.IP \(bu 2
package spec
.IP \(bu 2
npm install
.IP \(bu 2
npm docs
.IP \(bu 2
npm ls
.IP \(bu 2
npm config
.IP \(bu 2
npm workspaces

.RE