1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>npm-fund</title>
4<style>
5body {
6    background-color: #ffffff;
7    color: #24292e;
8
9    margin: 0;
10
11    line-height: 1.5;
12
13    font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
14}
15#rainbar {
16    height: 10px;
17    background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
18}
19
20a {
21    text-decoration: none;
22    color: #0366d6;
23}
24a:hover {
25    text-decoration: underline;
26}
27
28pre {
29    margin: 1em 0px;
30    padding: 1em;
31    border: solid 1px #e1e4e8;
32    border-radius: 6px;
33
34    display: block;
35    overflow: auto;
36
37    white-space: pre;
38
39    background-color: #f6f8fa;
40    color: #393a34;
41}
42code {
43    font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
44    font-size: 85%;
45    padding: 0.2em 0.4em;
46    background-color: #f6f8fa;
47    color: #393a34;
48}
49pre > code {
50    padding: 0;
51    background-color: inherit;
52    color: inherit;
53}
54h1, h2, h3 {
55    font-weight: 600;
56}
57
58#logobar {
59    background-color: #333333;
60    margin: 0 auto;
61    padding: 1em 4em;
62}
63#logobar .logo {
64    float: left;
65}
66#logobar .title {
67    font-weight: 600;
68    color: #dddddd;
69    float: left;
70    margin: 5px 0 0 1em;
71}
72#logobar:after {
73    content: "";
74    display: block;
75    clear: both;
76}
77
78#content {
79    margin: 0 auto;
80    padding: 0 4em;
81}
82
83#table_of_contents > h2 {
84    font-size: 1.17em;
85}
86#table_of_contents ul:first-child {
87    border: solid 1px #e1e4e8;
88    border-radius: 6px;
89    padding: 1em;
90    background-color: #f6f8fa;
91    color: #393a34;
92}
93#table_of_contents ul {
94    list-style-type: none;
95    padding-left: 1.5em;
96}
97#table_of_contents li {
98    font-size: 0.9em;
99}
100#table_of_contents li a {
101    color: #000000;
102}
103
104header.title {
105    border-bottom: solid 1px #e1e4e8;
106}
107header.title > h1 {
108    margin-bottom: 0.25em;
109}
110header.title > .description {
111    display: block;
112    margin-bottom: 0.5em;
113    line-height: 1;
114}
115
116footer#edit {
117    border-top: solid 1px #e1e4e8;
118    margin: 3em 0 4em 0;
119    padding-top: 2em;
120}
121</style>
122</head>
123<body>
124<div id="banner">
125<div id="rainbar"></div>
126<div id="logobar">
127<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
128<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
129<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
130</svg>
131<div class="title">
132npm command-line interface
133</div>
134</div>
135</div>
136
137<section id="content">
138<header class="title">
139<h1 id="npm-fund">npm-fund</h1>
140<span class="description">Retrieve funding information</span>
141</header>
142
143<section id="table_of_contents">
144<h2 id="table-of-contents">Table of contents</h2>
145<div id="_table_of_contents"><ul><li><a href="#see-also">See Also</a></li></ul></div>
146</section>
147
148<div id="_content"><h3 id="synopsis">Synopsis</h3>
149<pre><code class="language-bash">npm fund [&lt;package-spec&gt;]
150</code></pre>
151<h3 id="description">Description</h3>
152<p>This command retrieves information on how to fund the dependencies of a
153given project. If no package name is provided, it will list all
154dependencies that are looking for funding in a tree structure, listing
155the type of funding and the url to visit. If a package name is provided
156then it tries to open its funding url using the
157<a href="../using-npm/config#browser.html"><code>--browser</code> config</a> param; if there are multiple
158funding sources for the package, the user will be instructed to pass the
159<code>--which</code> option to disambiguate.</p>
160<p>The list will avoid duplicated entries and will stack all packages that
161share the same url as a single entry. Thus, the list does not have the
162same shape of the output from <code>npm ls</code>.</p>
163<h4 id="example">Example</h4>
164<h3 id="workspaces-support">Workspaces support</h3>
165<p>It's possible to filter the results to only include a single workspace
166and its dependencies using the
167<a href="../using-npm/config#workspace.html"><code>workspace</code> config</a> option.</p>
168<h4 id="example2">Example:</h4>
169<p>Here's an example running <code>npm fund</code> in a project with a configured
170workspace <code>a</code>:</p>
171<pre><code class="language-bash">$ npm fund
172test-workspaces-fund@1.0.0
173+-- https://example.com/a
174| | `-- a@1.0.0
175| `-- https://example.com/maintainer
176|     `-- foo@1.0.0
177+-- https://example.com/npmcli-funding
178|   `-- @npmcli/test-funding
179`-- https://example.com/org
180    `-- bar@2.0.0
181</code></pre>
182<p>And here is an example of the expected result when filtering only by a
183specific workspace <code>a</code> in the same project:</p>
184<pre><code class="language-bash">$ npm fund -w a
185test-workspaces-fund@1.0.0
186`-- https://example.com/a
187  | `-- a@1.0.0
188  `-- https://example.com/maintainer
189      `-- foo@2.0.0
190</code></pre>
191<h3 id="configuration">Configuration</h3>
192<h4 id="json"><code>json</code></h4>
193<ul>
194<li>Default: false</li>
195<li>Type: Boolean</li>
196</ul>
197<p>Whether or not to output JSON data, rather than the normal output.</p>
198<ul>
199<li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before
200saving them to your <code>package.json</code>.</li>
201</ul>
202<p>Not supported by all npm commands.</p>
203<h4 id="browser"><code>browser</code></h4>
204<ul>
205<li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li>
206<li>Type: null, Boolean, or String</li>
207</ul>
208<p>The browser that is called by npm commands to open websites.</p>
209<p>Set to <code>false</code> to suppress browser behavior and instead print urls to
210terminal.</p>
211<p>Set to <code>true</code> to use default system URL opener.</p>
212<h4 id="unicode"><code>unicode</code></h4>
213<ul>
214<li>Default: false on windows, true on mac/unix systems with a unicode locale,
215as defined by the <code>LC_ALL</code>, <code>LC_CTYPE</code>, or <code>LANG</code> environment variables.</li>
216<li>Type: Boolean</li>
217</ul>
218<p>When set to true, npm uses unicode characters in the tree output. When
219false, it uses ascii characters instead of unicode glyphs.</p>
220<h4 id="workspace"><code>workspace</code></h4>
221<ul>
222<li>Default:</li>
223<li>Type: String (can be set multiple times)</li>
224</ul>
225<p>Enable running a command in the context of the configured workspaces of the
226current project while filtering by running only the workspaces defined by
227this configuration option.</p>
228<p>Valid values for the <code>workspace</code> config are either:</p>
229<ul>
230<li>Workspace names</li>
231<li>Path to a workspace directory</li>
232<li>Path to a parent workspace directory (will result in selecting all
233workspaces within that folder)</li>
234</ul>
235<p>When set for the <code>npm init</code> command, this may be set to the folder of a
236workspace which does not yet exist, to create the folder and set it up as a
237brand new workspace within the project.</p>
238<p>This value is not exported to the environment for child processes.</p>
239<h4 id="which"><code>which</code></h4>
240<ul>
241<li>Default: null</li>
242<li>Type: null or Number</li>
243</ul>
244<p>If there are multiple funding sources, which 1-indexed source URL to open.</p>
245<h2 id="see-also">See Also</h2>
246<ul>
247<li><a href="../using-npm/package-spec.html">package spec</a></li>
248<li><a href="../commands/npm-install.html">npm install</a></li>
249<li><a href="../commands/npm-docs.html">npm docs</a></li>
250<li><a href="../commands/npm-ls.html">npm ls</a></li>
251<li><a href="../commands/npm-config.html">npm config</a></li>
252<li><a href="../using-npm/workspaces.html">npm workspaces</a></li>
253</ul></div>
254
255<footer id="edit">
256<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-fund.md">
257<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
258<path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path>
259</svg>
260Edit this page on GitHub
261</a>
262</footer>
263</section>
264
265
266
267</body></html>