LinuxCommandLibrary
GitHubF-DroidGoogle Play Store

npm-fund

Retrieve funding information for project dependencies

TLDR

List all dependencies looking for funding
$ npm fund
copy
Show funding info for a specific package
$ npm fund [package-name]
copy
Output funding information as JSON
$ npm fund --json
copy
Open a specific funding URL when multiple sources exist
$ npm fund [package-name] --which [1]
copy
List funding info for a specific workspace
$ npm fund --workspace [workspace-name]
copy

SYNOPSIS

npm fund [package-spec]

DESCRIPTION

npm fund retrieves information on how to fund the dependencies of a given project. If no package name is provided, it lists all dependencies that are looking for funding in a tree structure showing the type of funding and URL to visit.If a package name is provided, it tries to open its funding URL using the configured browser. If there are multiple funding sources for the package, the user will be instructed to pass the --which option to disambiguate.

PARAMETERS

package-spec

Package to retrieve funding information for.
--json
Output JSON data rather than the normal output.
--which NUM
When there are multiple funding sources, specifies which 1-indexed source URL to open.
--browser BROWSER
Browser to use for opening funding URLs. Set to false to print URLs to terminal instead.
--unicode
Use unicode characters in tree output. When false, uses ASCII characters instead.
--workspace WORKSPACE
Filter results to the specified workspace(s).

CAVEATS

Requires funding metadata in package.json. Opens browser for URLs by default. Funding is voluntary support for open source maintainers.

HISTORY

npm fund was introduced in npm 8 to help open source maintainers receive financial support from their users.

SEE ALSO

Copied to clipboard
Kai