@cryptotaxi247 / documentation
Code Commits Issues Pulls Sessions CI/CD
patch-1
@reggi/path-to-regexp dependabot/npm_and_yarn/main/copy-to-clipboard-4.0.2 dependabot/npm_and_yarn/main/eslint-10.4.0 dependabot/npm_and_yarn/main/npmcli/eslint-config-7.0.0 dependabot/npm_and_yarn/main/proc-log-7.0.0 dependabot/npm_and_yarn/npm_and_yarn-826852524d dependabot/npm_and_yarn/npm_and_yarn-ab9a7f4bc2 deprecate-totp-2fa dhei/classic-tokens gat-bypass-2fa-docs jpg619/fix-accessibility-content-flow jpg619/version-bump-tar-2 kartykp/gat-bypass-2fa-docs kartykp/upgrade-path-to-regex main maitxn/version-bump-tar patch-1 reggi/cache-based-on-version reggi/dev-engines reggi/fix-transform-prettier reggi/overrides update-search-sensitivity
mdx 69 lines 2.01 KB
Raw
1 ---
2 title: npm-fund
3 section: 1
4 description: Retrieve funding information
5 github_repo: npm/cli
6 github_branch: release/v6
7 github_path: docs/content/commands/npm-fund.md
8 redirect_from:
9 - /cli-documentation/v6/cli-commands/fund
10 - /cli-documentation/v6/cli-commands/npm-fund
11 - /cli-documentation/v6/commands/fund
12 - /cli-documentation/v6/commands/npm-fund
13 - /cli-documentation/v6/fund
14 - /cli-documentation/v6/npm-fund
15 - /cli/v6/cli-commands/fund
16 - /cli/v6/cli-commands/npm-fund
17 - /cli/v6/commands/fund
18 - /cli/v6/fund
19 - /cli/v6/npm-fund
20 ---
21
22 ### Synopsis
23
24 ```bash
25 npm fund [<pkg>]
26 ```
27
28 ### Description
29
30 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 in which are listed 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` command to disambiguate.
31
32 The list will avoid duplicated entries and will stack all packages that share the same type/url as a single entry. Given this nature the list is not going to have the same shape of the output from `npm ls`.
33
34 ### Configuration
35
36 #### browser
37
38 - Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
39 - Type: String
40
41 The browser that is called by the `npm fund` command to open websites.
42
43 #### json
44
45 - Type: Boolean
46 - Default: false
47
48 Show information in JSON format.
49
50 #### unicode
51
52 - Type: Boolean
53 - Default: true
54
55 Whether to represent the tree structure using unicode characters. Set it to `false` in order to use all-ansi output.
56
57 #### which
58
59 - Type: Number
60 - Default: undefined
61
62 If there are multiple funding sources, which 1-indexed source URL to open.
63
64 ## See Also
65
66 - [npm docs](/cli/v6/commands/npm-docs)
67 - [npm config](/cli/v6/commands/npm-config)
68 - [npm install](/cli/v6/commands/npm-install)
69 - [npm ls](/cli/v6/commands/npm-ls)