• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1---
2section: cli-commands
3title: npm-fund
4description: Retrieve funding information
5---
6
7# npm-fund(1)
8
9## Retrieve funding information
10
11### Synopsis
12
13```bash
14    npm fund [<pkg>]
15```
16
17### Description
18
19This command retrieves information on how to fund the dependencies of
20a given project. If no package name is provided, it will list all
21dependencies that are looking for funding in a tree-structure in which
22are listed the type of funding and the url to visit. If a package name
23is provided then it tries to open its funding url using the `--browser`
24config param; if there are multiple funding sources for the package, the
25user will be instructed to pass the `--which` command to disambiguate.
26
27The list will avoid duplicated entries and will stack all packages
28that share the same type/url as a single entry. Given this nature the
29list is not going to have the same shape of the output from `npm ls`.
30
31### Configuration
32
33#### browser
34
35* Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
36* Type: String
37
38The browser that is called by the `npm fund` command to open websites.
39
40#### json
41
42* Type: Boolean
43* Default: false
44
45Show information in JSON format.
46
47#### unicode
48
49* Type: Boolean
50* Default: true
51
52Whether to represent the tree structure using unicode characters.
53Set it to `false` in order to use all-ansi output.
54
55#### which
56
57* Type: Number
58* Default: undefined
59
60If there are multiple funding sources, which 1-indexed source URL to open.
61
62## See Also
63
64* [npm docs](/cli-commands/npm-docs)
65* [npm config](/cli-commands/npm-config)
66* [npm install](/cli-commands/npm-install)
67* [npm ls](/cli-commands/npm-ls)
68
69