NPM-FUND

Section: User Commands (1)
Updated: December 2022
Index Return to Main Contents
 

NAME

npm-fund  

Synopsis

<!-- AUTOGENERATED USAGE DESCRIPTIONS -->

 

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, 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
--browser config param; if there are multiple
funding sources for the package, the user will be instructed to pass the
--which option to disambiguate.

The 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 npm ls.  

Example

 

Workspaces support

It's possible to filter the results to only include a single workspace
and its dependencies using the
workspace config option.  

Example:

Here's an example running npm fund in a project with a configured
workspace a:

$ 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

And here is an example of the expected result when filtering only by a
specific workspace a in the same project:

$ 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
 

Configuration

<!-- AUTOGENERATED CONFIG DESCRIPTIONS -->

 

See Also

package spec
npm install
npm docs
npm ls
npm config
npm workspaces


 

Index

NAME
Synopsis
Description
Example
Workspaces support
Example:
Configuration
See Also

This document was created by man2html, using the manual pages.
Time: 17:31:14 GMT, April 27, 2024