codekingpro/portable-devtools
114k
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
116header.title .version {
117 font-size: 0.8em;
118 color: #666666;
119}
120
121footer#edit {
122 border-top: solid 1px #e1e4e8;
123 margin: 3em 0 4em 0;
124 padding-top: 2em;
125}
126
127table {
128 width: 100%;
129 margin: 1em 0;
130 border-radius: 6px;
131 border: 1px solid #e1e4e8;
132 overflow: hidden;
133 border-collapse: separate;
134 border-spacing: 0;
135}
136
137table thead {
138 background-color: #f6f8fa;
139}
140
141table tbody {
142 background-color: #ffffff;
143}
144
145table th,
146table td {
147 padding: 0.75em;
148 text-align: left;
149 border-right: 1px solid #e1e4e8;
150 border-bottom: 1px solid #e1e4e8;
151}
152
153table th:last-child,
154table td:last-child {
155 border-right: none;
156}
157
158table tbody tr:last-child td {
159 border-bottom: none;
160}
161
162table th {
163 font-weight: 600;
164 background-color: #f6f8fa;
165}
166
167table code {
168 white-space: nowrap;
169}
170
171</style>
172</head>
173<body>
174<div id="banner">
175<div id="rainbar"></div>
176<div id="logobar">
177<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
178<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
179<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
180</svg>
181<div class="title">
182npm command-line interface
183</div>
184</div>
185</div>
186
187<section id="content">
188<header class="title">
189<h1 id="----npm-fund----11130">
190 <span>npm-fund</span>
191 <span class="version">@11.13.0</span>
192</h1>
193<span class="description">Retrieve funding information</span>
194</header>
195
196<section id="table_of_contents">
197<h2 id="table-of-contents">Table of contents</h2>
198<div id="_table_of_contents"><ul><li><a href="#see-also">See Also</a></li></ul></div>
199</section>
200
201<div id="_content"><h3 id="synopsis">Synopsis</h3>
202<pre><code class="language-bash">npm fund [<package-spec>]
203</code></pre>
204<h3 id="description">Description</h3>
205<p>This command retrieves information on how to fund the dependencies of a given project.
206If 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.
207If a package name is provided then it tries to open its funding url using the <a href="../using-npm/config#browser.html"><code>--browser</code> config</a> param; if there are multiple funding sources for the package, the user will be instructed to pass the
208<code>--which</code> option to disambiguate.</p>
209<p>The list will avoid duplicated entries and will stack all packages that share the same url as a single entry.
210Thus, the list does not have the same shape of the output from <code>npm ls</code>.</p>
211<h4 id="example">Example</h4>
212<h3 id="workspaces-support">Workspaces support</h3>
213<p>It's possible to filter the results to only include a single workspace and its dependencies using the <a href="../using-npm/config#workspace.html"><code>workspace</code> config</a> option.</p>
214<h4 id="example2">Example:</h4>
215<p>Here's an example running <code>npm fund</code> in a project with a configured workspace <code>a</code>:</p>
216<pre><code class="language-bash">$ npm fund
217test-workspaces-fund@1.0.0
218+-- https://example.com/a
219| | `-- a@1.0.0
220| `-- https://example.com/maintainer
221| `-- foo@1.0.0
222+-- https://example.com/npmcli-funding
223| `-- @npmcli/test-funding
224`-- https://example.com/org
225 `-- bar@2.0.0
226</code></pre>
227<p>And here is an example of the expected result when filtering only by a specific workspace <code>a</code> in the same project:</p>
228<pre><code class="language-bash">$ npm fund -w a
229test-workspaces-fund@1.0.0
230`-- https://example.com/a
231 | `-- a@1.0.0
232 `-- https://example.com/maintainer
233 `-- foo@2.0.0
234</code></pre>
235<h3 id="configuration">Configuration</h3>
236<h4 id="json"><code>json</code></h4>
237<ul>
238<li>Default: false</li>
239<li>Type: Boolean</li>
240</ul>
241<p>Whether or not to output JSON data, rather than the normal output.</p>
242<ul>
243<li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before
244saving them to your <code>package.json</code>.</li>
245</ul>
246<p>Not supported by all npm commands.</p>
247<h4 id="browser"><code>browser</code></h4>
248<ul>
249<li>Default: macOS: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li>
250<li>Type: null, Boolean, or String</li>
251</ul>
252<p>The browser that is called by npm commands to open websites.</p>
253<p>Set to <code>false</code> to suppress browser behavior and instead print urls to
254terminal.</p>
255<p>Set to <code>true</code> to use default system URL opener.</p>
256<h4 id="unicode"><code>unicode</code></h4>
257<ul>
258<li>Default: false on windows, true on mac/unix systems with a unicode locale,
259as defined by the <code>LC_ALL</code>, <code>LC_CTYPE</code>, or <code>LANG</code> environment variables.</li>
260<li>Type: Boolean</li>
261</ul>
262<p>When set to true, npm uses unicode characters in the tree output. When
263false, it uses ascii characters instead of unicode glyphs.</p>
264<h4 id="workspace"><code>workspace</code></h4>
265<ul>
266<li>Default:</li>
267<li>Type: String (can be set multiple times)</li>
268</ul>
269<p>Enable running a command in the context of the configured workspaces of the
270current project while filtering by running only the workspaces defined by
271this configuration option.</p>
272<p>Valid values for the <code>workspace</code> config are either:</p>
273<ul>
274<li>Workspace names</li>
275<li>Path to a workspace directory</li>
276<li>Path to a parent workspace directory (will result in selecting all
277workspaces within that folder)</li>
278</ul>
279<p>When set for the <code>npm init</code> command, this may be set to the folder of a
280workspace which does not yet exist, to create the folder and set it up as a
281brand new workspace within the project.</p>
282<p>This value is not exported to the environment for child processes.</p>
283<h4 id="which"><code>which</code></h4>
284<ul>
285<li>Default: null</li>
286<li>Type: null or Number</li>
287</ul>
288<p>If there are multiple funding sources, which 1-indexed source URL to open.</p>
289<h2 id="see-also">See Also</h2>
290<ul>
291<li><a href="../using-npm/package-spec.html">package spec</a></li>
292<li><a href="../commands/npm-install.html">npm install</a></li>
293<li><a href="../commands/npm-docs.html">npm docs</a></li>
294<li><a href="../commands/npm-ls.html">npm ls</a></li>
295<li><a href="../commands/npm-config.html">npm config</a></li>
296<li><a href="../using-npm/workspaces.html">npm workspaces</a></li>
297</ul></div>
298
299<footer id="edit">
300<a href="https://github.com/npm/cli/edit/latest/docs/lib/content/commands/npm-fund.md">
301<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
302<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>
303</svg>
304Edit this page on GitHub
305</a>
306</footer>
307</section>
308
309
310
311</body></html>