FM / commands

/home/techb158/.nvm/versions/node/v16.20.2/lib/node_modules/npm/docs/content/commands/

/home/techb158/.nvm/versions/node/v16.20.2/lib/node_modules/npm/docs/content/commands

Name	Size	Mode	Actions
npm-access.md	3359	0644	edit dl rm
npm-adduser.md	2315	0644	edit dl rm
npm-audit.md	14321	0644	edit dl rm
npm-bin.md	898	0644	edit dl rm
npm-bugs.md	2963	0644	edit dl rm
npm-cache.md	2999	0644	edit dl rm
npm-ci.md	9481	0644	edit dl rm
npm-completion.md	909	0644	edit dl rm
npm-config.md	3705	0644	edit dl rm
npm-dedupe.md	8160	0644	edit dl rm
npm-deprecate.md	1737	0644	edit dl rm
npm-diff.md	8971	0644	edit dl rm
npm-dist-tag.md	5079	0644	edit dl rm
npm-docs.md	2941	0644	edit dl rm
npm-doctor.md	4760	0644	edit dl rm
npm-edit.md	1077	0644	edit dl rm
npm-exec.md	11209	0644	edit dl rm
npm-explain.md	2793	0644	edit dl rm
npm-explore.md	1004	0644	edit dl rm
npm-find-dupes.md	6064	0644	edit dl rm
npm-fund.md	3605	0644	edit dl rm
npm-help-search.md	754	0644	edit dl rm
npm-help.md	1002	0644	edit dl rm
npm-hook.md	2390	0644	edit dl rm
npm-init.md	8986	0644	edit dl rm
npm-install-ci-test.md	7763	0644	edit dl rm
npm-install-test.md	7840	0644	edit dl rm
npm-install.md	23133	0644	edit dl rm
npm-link.md	11001	0644	edit dl rm
npm-logout.md	1746	0644	edit dl rm
npm-ls.md	8202	0644	edit dl rm
npm-org.md	1967	0644	edit dl rm
npm-outdated.md	5769	0644	edit dl rm
npm-owner.md	3100	0644	edit dl rm
npm-pack.md	3442	0644	edit dl rm
npm-ping.md	767	0644	edit dl rm
npm-pkg.md	7815	0644	edit dl rm
npm-prefix.md	1240	0644	edit dl rm
npm-profile.md	3899	0644	edit dl rm
npm-prune.md	5410	0644	edit dl rm
npm-publish.md	7289	0644	edit dl rm
npm-query.md	5069	0644	edit dl rm
npm-rebuild.md	4264	0644	edit dl rm
npm-repo.md	2721	0644	edit dl rm
npm-restart.md	1469	0644	edit dl rm
npm-root.md	1080	0644	edit dl rm
npm-run-script.md	7355	0644	edit dl rm
npm-search.md	3402	0644	edit dl rm
npm-set-script.md	2397	0644	edit dl rm
npm-shrinkwrap.md	923	0644	edit dl rm
npm-star.md	1707	0644	edit dl rm
npm-stars.md	741	0644	edit dl rm
npm-start.md	1663	0644	edit dl rm
npm-stop.md	1337	0644	edit dl rm
npm-team.md	4058	0644	edit dl rm
npm-test.md	1230	0644	edit dl rm
npm-token.md	4213	0644	edit dl rm
npm-uninstall.md	4021	0644	edit dl rm
npm-unpublish.md	4370	0644	edit dl rm
npm-unstar.md	1568	0644	edit dl rm
npm-update.md	11085	0644	edit dl rm
npm-version.md	6827	0644	edit dl rm
npm-view.md	5269	0644	edit dl rm
npm-whoami.md	798	0644	edit dl rm
npm.md	5586	0644	edit dl rm
npx.md	5730	0644	edit dl rm

Edit: /home/techb158/.nvm/versions/node/v16.20.2/lib/node_modules/npm/docs/content/commands/npm-fund.md (3605B)

---
title: npm-fund
section: 1
description: Retrieve funding information
---

### Synopsis

```bash
npm fund [<package-spec>]
```

### Description

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 `--browser` config
param; if there are multiple funding sources for the package, the user
will be instructed to pass the `--which` option to disambiguate.

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 `npm ls`.

#### Example

### Workspaces support

It's possible to filter the results to only include a single workspace
and its dependencies using the `workspace` config option.

#### Example:

Here's an example running `npm fund` in a project with a configured
workspace `a`:

```bash
$ npm fund
test-workspaces-fund@1.0.0
+-- https://example.com/a
| | `-- a@1.0.0
| `-- https://example.com/maintainer
|     `-- foo@1.0.0
+-- https://example.com/npmcli-funding
|   `-- @npmcli/test-funding
`-- https://example.com/org
    `-- bar@2.0.0
```

And here is an example of the expected result when filtering only by a
specific workspace `a` in the same project:

```bash
$ npm fund -w a
test-workspaces-fund@1.0.0
`-- https://example.com/a
  | `-- a@1.0.0
  `-- https://example.com/maintainer
      `-- foo@2.0.0
```

### Configuration

#### `json`

* Default: false
* Type: Boolean

Whether or not to output JSON data, rather than the normal output.

* In `npm pkg set` it enables parsing set values with JSON.parse() before
  saving them to your `package.json`.

Not supported by all npm commands.

#### `browser`

* Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
* Type: null, Boolean, or String

The browser that is called by npm commands to open websites.

Set to `false` to suppress browser behavior and instead print urls to
terminal.

Set to `true` to use default system URL opener.

#### `unicode`

* Default: false on windows, true on mac/unix systems with a unicode locale,
  as defined by the `LC_ALL`, `LC_CTYPE`, or `LANG` environment variables.
* Type: Boolean

When set to true, npm uses unicode characters in the tree output. When
false, it uses ascii characters instead of unicode glyphs.

#### `workspace`

* Default:
* Type: String (can be set multiple times)

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.

Valid values for the `workspace` config are either:

* Workspace names
* Path to a workspace directory
* Path to a parent workspace directory (will result in selecting all
  workspaces within that folder)

When set for the `npm init` 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.

This value is not exported to the environment for child processes.

#### `which`

* Default: null
* Type: null or Number

If there are multiple funding sources, which 1-indexed source URL to open.

## See Also

* [package spec](/using-npm/package-spec)
* [npm install](/commands/npm-install)
* [npm docs](/commands/npm-docs)
* [npm ls](/commands/npm-ls)
* [npm config](/commands/npm-config)
* [npm workspaces](/using-npm/workspaces)

cmd: