/usr/local/lib/node_modules/npm/docs/content/commands
NameSizeModeActions
npm-access.md28880644editdlrm
npm-adduser.md20330644editdlrm
npm-audit.md162520644editdlrm
npm-bugs.md29970644editdlrm
npm-cache.md34500644editdlrm
npm-ci.md97700644editdlrm
npm-completion.md9080644editdlrm
npm-config.md40910644editdlrm
npm-dedupe.md95430644editdlrm
npm-deprecate.md21560644editdlrm
npm-diff.md89850644editdlrm
npm-dist-tag.md51700644editdlrm
npm-docs.md29750644editdlrm
npm-doctor.md50470644editdlrm
npm-edit.md10910644editdlrm
npm-exec.md113570644editdlrm
npm-explain.md27940644editdlrm
npm-explore.md10060644editdlrm
npm-find-dupes.md67910644editdlrm
npm-fund.md36740644editdlrm
npm-get.md4450644editdlrm
npm-help-search.md7550644editdlrm
npm-help.md10030644editdlrm
npm-init.md102130644editdlrm
npm-install-ci-test.md80830644editdlrm
npm-install-test.md115730644editdlrm
npm-install.md293060644editdlrm
npm-link.md123860644editdlrm
npm-ll.md56860644editdlrm
npm-login.md23540644editdlrm
npm-logout.md17490644editdlrm
npm-ls.md71480644editdlrm
npm-org.md19740644editdlrm
npm-outdated.md69780644editdlrm
npm-owner.md30820644editdlrm
npm-pack.md38320644editdlrm
npm-ping.md7690644editdlrm
npm-pkg.md80560644editdlrm
npm-prefix.md12060644editdlrm
npm-profile.md30670644editdlrm
npm-prune.md57370644editdlrm
npm-publish.md80280644editdlrm
npm-query.md69540644editdlrm
npm-rebuild.md49940644editdlrm
npm-repo.md27550644editdlrm
npm-restart.md14440644editdlrm
npm-root.md10960644editdlrm
npm-run.md75380644editdlrm
npm-sbom.md83380644editdlrm
npm-search.md35600644editdlrm
npm-set.md14330644editdlrm
npm-shrinkwrap.md9090644editdlrm
npm-star.md17120644editdlrm
npm-stars.md7430644editdlrm
npm-start.md16320644editdlrm
npm-stop.md13200644editdlrm
npm-team.md40840644editdlrm
npm-test.md12130644editdlrm
npm-token.md49050644editdlrm
npm-trust.md100730644editdlrm
npm-undeprecate.md14060644editdlrm
npm-uninstall.md44470644editdlrm
npm-unpublish.md44910644editdlrm
npm-unstar.md15740644editdlrm
npm-update.md129720644editdlrm
npm-version.md80110644editdlrm
npm-view.md74250644editdlrm
npm-whoami.md8000644editdlrm
npm.md56380644editdlrm
npx.md62870644editdlrm
Edit: /usr/local/lib/node_modules/npm/docs/content/commands/npm-fund.md (3674B)
--- title: npm-fund section: 1 description: Retrieve funding information --- ### Synopsis ```bash npm fund [] ``` ### 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](/using-npm/config#browser) 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](/using-npm/config#workspace) 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: macOS: `"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)