FM / commands

/snap/node/11691/lib/node_modules/npm/docs/content/commands/

/snap/node/11691/lib/node_modules/npm/docs/content/commands

Name	Size	Mode	Actions
npm-access.md	3664	0644	edit dl rm
npm-adduser.md	1847	0644	edit dl rm
npm-audit.md	15656	0644	edit dl rm
npm-bugs.md	2996	0644	edit dl rm
npm-cache.md	2962	0644	edit dl rm
npm-ci.md	9125	0644	edit dl rm
npm-completion.md	909	0644	edit dl rm
npm-config.md	4093	0644	edit dl rm
npm-dedupe.md	8895	0644	edit dl rm
npm-deprecate.md	1741	0644	edit dl rm
npm-diff.md	9109	0644	edit dl rm
npm-dist-tag.md	5181	0644	edit dl rm
npm-docs.md	2974	0644	edit dl rm
npm-doctor.md	5057	0644	edit dl rm
npm-edit.md	1091	0644	edit dl rm
npm-exec.md	11401	0644	edit dl rm
npm-explain.md	2795	0644	edit dl rm
npm-explore.md	1006	0644	edit dl rm
npm-find-dupes.md	6797	0644	edit dl rm
npm-fund.md	3673	0644	edit dl rm
npm-help-search.md	756	0644	edit dl rm
npm-help.md	1004	0644	edit dl rm
npm-hook.md	2394	0644	edit dl rm
npm-init.md	9855	0644	edit dl rm
npm-install-ci-test.md	7434	0644	edit dl rm
npm-install-test.md	9814	0644	edit dl rm
npm-install.md	24984	0644	edit dl rm
npm-link.md	11742	0644	edit dl rm
npm-login.md	2171	0644	edit dl rm
npm-logout.md	1749	0644	edit dl rm
npm-ls.md	8547	0644	edit dl rm
npm-org.md	1975	0644	edit dl rm
npm-outdated.md	5779	0644	edit dl rm
npm-owner.md	3093	0644	edit dl rm
npm-pack.md	3448	0644	edit dl rm
npm-ping.md	769	0644	edit dl rm
npm-pkg.md	8129	0644	edit dl rm
npm-prefix.md	1211	0644	edit dl rm
npm-profile.md	3102	0644	edit dl rm
npm-prune.md	5745	0644	edit dl rm
npm-publish.md	7622	0644	edit dl rm
npm-query.md	6958	0644	edit dl rm
npm-rebuild.md	5001	0644	edit dl rm
npm-repo.md	2754	0644	edit dl rm
npm-restart.md	1473	0644	edit dl rm
npm-root.md	1097	0644	edit dl rm
npm-run-script.md	7561	0644	edit dl rm
npm-sbom.md	8337	0644	edit dl rm
npm-search.md	3464	0644	edit dl rm
npm-shrinkwrap.md	923	0644	edit dl rm
npm-star.md	1713	0644	edit dl rm
npm-stars.md	743	0644	edit dl rm
npm-start.md	1667	0644	edit dl rm
npm-stop.md	1341	0644	edit dl rm
npm-team.md	4090	0644	edit dl rm
npm-test.md	1234	0644	edit dl rm
npm-token.md	2893	0644	edit dl rm
npm-uninstall.md	4447	0644	edit dl rm
npm-unpublish.md	4491	0644	edit dl rm
npm-unstar.md	1574	0644	edit dl rm
npm-update.md	11871	0644	edit dl rm
npm-version.md	6902	0644	edit dl rm
npm-view.md	5612	0644	edit dl rm
npm-whoami.md	800	0644	edit dl rm
npm.md	5670	0644	edit dl rm
npx.md	5895	0644	edit dl rm

Edit: /snap/node/11691/lib/node_modules/npm/docs/content/commands/npm-explain.md (2795B)

---
title: npm-explain
section: 1
description: Explain installed packages
---

### Synopsis

```bash
npm explain <package-spec>

alias: why
```

### Description

This command will print the chain of dependencies causing a given package
to be installed in the current project.

If one or more package specs are provided, then only packages matching
one of the specifiers will have their relationships explained.

The package spec can also refer to a folder within `./node_modules`

For example, running `npm explain glob` within npm's source tree will show:

```bash
glob@7.1.6
node_modules/glob
  glob@"^7.1.4" from the root project

glob@7.1.1 dev
node_modules/tacks/node_modules/glob
  glob@"^7.0.5" from rimraf@2.6.2
  node_modules/tacks/node_modules/rimraf
    rimraf@"^2.6.2" from tacks@1.3.0
    node_modules/tacks
      dev tacks@"^1.3.0" from the root project
```

To explain just the package residing at a specific folder, pass that as the
argument to the command.  This can be useful when trying to figure out
exactly why a given dependency is being duplicated to satisfy conflicting
version requirements within the project.

```bash
$ npm explain node_modules/nyc/node_modules/find-up
find-up@3.0.0 dev
node_modules/nyc/node_modules/find-up
  find-up@"^3.0.0" from nyc@14.1.1
  node_modules/nyc
    nyc@"^14.1.1" from tap@14.10.8
    node_modules/tap
      dev tap@"^14.10.8" from the root project
```

### 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.

#### `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.

### See Also

* [package spec](/using-npm/package-spec)
* [npm config](/commands/npm-config)
* [npmrc](/configuring-npm/npmrc)
* [npm folders](/configuring-npm/folders)
* [npm ls](/commands/npm-ls)
* [npm install](/commands/npm-install)
* [npm link](/commands/npm-link)
* [npm prune](/commands/npm-prune)
* [npm outdated](/commands/npm-outdated)
* [npm update](/commands/npm-update)

--- title: npm-explain section: 1 description: Explain installed packages --- ### Synopsis ```bash npm explain alias: why ``` ### Description This command will print the chain of dependencies causing a given package to be installed in the current project. If one or more package specs are provided, then only packages matching one of the specifiers will have their relationships explained. The package spec can also refer to a folder within `./node_modules` For example, running `npm explain glob` within npm's source tree will show: ```bash glob@7.1.6 node_modules/glob glob@"^7.1.4" from the root project glob@7.1.1 dev node_modules/tacks/node_modules/glob glob@"^7.0.5" from rimraf@2.6.2 node_modules/tacks/node_modules/rimraf rimraf@"^2.6.2" from tacks@1.3.0 node_modules/tacks dev tacks@"^1.3.0" from the root project ``` To explain just the package residing at a specific folder, pass that as the argument to the command. This can be useful when trying to figure out exactly why a given dependency is being duplicated to satisfy conflicting version requirements within the project. ```bash $ npm explain node_modules/nyc/node_modules/find-up find-up@3.0.0 dev node_modules/nyc/node_modules/find-up find-up@"^3.0.0" from nyc@14.1.1 node_modules/nyc nyc@"^14.1.1" from tap@14.10.8 node_modules/tap dev tap@"^14.10.8" from the root project ``` ### 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. #### `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. ### See Also * [package spec](/using-npm/package-spec) * [npm config](/commands/npm-config) * [npmrc](/configuring-npm/npmrc) * [npm folders](/configuring-npm/folders) * [npm ls](/commands/npm-ls) * [npm install](/commands/npm-install) * [npm link](/commands/npm-link) * [npm prune](/commands/npm-prune) * [npm outdated](/commands/npm-outdated) * [npm update](/commands/npm-update)