| .TH "NPM-FUND" "1" "April 2026" "NPM@11.13.0" ""
|
| .SH "NAME"
|
| \fBnpm-fund\fR - Retrieve funding information
|
| .SS "Synopsis"
|
| .P
|
| .RS 2
|
| .nf
|
| npm fund \[lB]<package-spec>\[rB]
|
| .fi
|
| .RE
|
| .SS "Description"
|
| .P
|
| 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 \fB\[rs]fB
|
| .P
|
| 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 \fBnpm ls\fR.
|
| .SS "Example"
|
| .SS "Workspaces support"
|
| .P
|
| It'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
|
| .SS "Example:"
|
| .P
|
| Here's an example running \fBnpm fund\fR in a project with a configured workspace \fBa\fR:
|
| .P
|
| .RS 2
|
| .nf
|
| $ npm fund
|
| test-workspaces-fund@1.0.0
|
| +
|
| | | `
|
| | `
|
| | `
|
| +
|
| | `
|
| `
|
| `
|
| .fi
|
| .RE
|
| .P
|
| And here is an example of the expected result when filtering only by a specific workspace \fBa\fR in the same project:
|
| .P
|
| .RS 2
|
| .nf
|
| $ npm fund -w a
|
| test-workspaces-fund@1.0.0
|
| `
|
| | `
|
| `
|
| `
|
| .fi
|
| .RE
|
| .SS "Configuration"
|
| .SS "\fBjson\fR"
|
| .RS 0
|
| .IP \(bu 4
|
| Default: false
|
| .IP \(bu 4
|
| Type: Boolean
|
| .RE 0
|
|
|
| .P
|
| Whether or not to output JSON data, rather than the normal output.
|
| .RS 0
|
| .IP \(bu 4
|
| In \fBnpm pkg set\fR it enables parsing set values with JSON.parse() before saving them to your \fBpackage.json\fR.
|
| .RE 0
|
|
|
| .P
|
| Not supported by all npm commands.
|
| .SS "\fBbrowser\fR"
|
| .RS 0
|
| .IP \(bu 4
|
| Default: macOS: \fB"open"\fR, Windows: \fB"start"\fR, Others: \fB"xdg-open"\fR
|
| .IP \(bu 4
|
| Type: null, Boolean, or String
|
| .RE 0
|
|
|
| .P
|
| The browser that is called by npm commands to open websites.
|
| .P
|
| Set to \fBfalse\fR to suppress browser behavior and instead print urls to terminal.
|
| .P
|
| Set to \fBtrue\fR to use default system URL opener.
|
| .SS "\fBunicode\fR"
|
| .RS 0
|
| .IP \(bu 4
|
| Default: 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.
|
| .IP \(bu 4
|
| Type: Boolean
|
| .RE 0
|
|
|
| .P
|
| When set to true, npm uses unicode characters in the tree output. When false, it uses ascii characters instead of unicode glyphs.
|
| .SS "\fBworkspace\fR"
|
| .RS 0
|
| .IP \(bu 4
|
| Default:
|
| .IP \(bu 4
|
| Type: String (can be set multiple times)
|
| .RE 0
|
|
|
| .P
|
| Enable 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.
|
| .P
|
| Valid values for the \fBworkspace\fR config are either:
|
| .RS 0
|
| .IP \(bu 4
|
| Workspace names
|
| .IP \(bu 4
|
| Path to a workspace directory
|
| .IP \(bu 4
|
| Path to a parent workspace directory (will result in selecting all workspaces within that folder)
|
| .RE 0
|
|
|
| .P
|
| When 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.
|
| .P
|
| This value is not exported to the environment for child processes.
|
| .SS "\fBwhich\fR"
|
| .RS 0
|
| .IP \(bu 4
|
| Default: null
|
| .IP \(bu 4
|
| Type: null or Number
|
| .RE 0
|
|
|
| .P
|
| If there are multiple funding sources, which 1-indexed source URL to open.
|
| .SH "SEE ALSO"
|
| .RS 0
|
| .IP \(bu 4
|
| npm help "package spec"
|
| .IP \(bu 4
|
| npm help install
|
| .IP \(bu 4
|
| npm help docs
|
| .IP \(bu 4
|
| npm help ls
|
| .IP \(bu 4
|
| npm help config
|
| .IP \(bu 4
|
| npm help workspaces
|
| .RE 0
|
|
|
