FM / man1

/usr/local/lib/node_modules/npm/man/man1/

/usr/local/lib/node_modules/npm/man/man1

Name	Size	Mode	Actions
npm-access.1	3270	0644	edit dl rm
npm-adduser.1	2207	0644	edit dl rm
npm-audit.1	18066	0644	edit dl rm
npm-bugs.1	3390	0644	edit dl rm
npm-cache.1	3695	0644	edit dl rm
npm-ci.1	10884	0644	edit dl rm
npm-completion.1	999	0644	edit dl rm
npm-config.1	4646	0644	edit dl rm
npm-dedupe.1	10565	0644	edit dl rm
npm-deprecate.1	2379	0644	edit dl rm
npm-diff.1	9781	0644	edit dl rm
npm-dist-tag.1	5646	0644	edit dl rm
npm-docs.1	3372	0644	edit dl rm
npm-doctor.1	5374	0644	edit dl rm
npm-edit.1	1190	0644	edit dl rm
npm-exec.1	12510	0644	edit dl rm
npm-explain.1	2939	0644	edit dl rm
npm-explore.1	1091	0644	edit dl rm
npm-find-dupes.1	7586	0644	edit dl rm
npm-fund.1	4073	0644	edit dl rm
npm-get.1	546	0644	edit dl rm
npm-help-search.1	869	0644	edit dl rm
npm-help.1	1101	0644	edit dl rm
npm-init.1	11590	0644	edit dl rm
npm-install-ci-test.1	9023	0644	edit dl rm
npm-install-test.1	13086	0644	edit dl rm
npm-install.1	31718	0644	edit dl rm
npm-link.1	13653	0644	edit dl rm
npm-ll.1	6591	0644	edit dl rm
npm-login.1	2558	0644	edit dl rm
npm-logout.1	1889	0644	edit dl rm
npm-ls.1	7964	0644	edit dl rm
npm-org.1	2312	0644	edit dl rm
npm-outdated.1	7759	0644	edit dl rm
npm-owner.1	3365	0644	edit dl rm
npm-pack.1	4326	0644	edit dl rm
npm-ping.1	851	0644	edit dl rm
npm-pkg.1	8722	0644	edit dl rm
npm-prefix.1	1306	0644	edit dl rm
npm-profile.1	3423	0644	edit dl rm
npm-prune.1	6453	0644	edit dl rm
npm-publish.1	8842	0644	edit dl rm
npm-query.1	7688	0644	edit dl rm
npm-rebuild.1	5659	0644	edit dl rm
npm-repo.1	3154	0644	edit dl rm
npm-restart.1	1690	0644	edit dl rm
npm-root.1	1196	0644	edit dl rm
npm-run.1	8383	0644	edit dl rm
npm-sbom.1	8999	0644	edit dl rm
npm-search.1	4067	0644	edit dl rm
npm-set.1	1632	0644	edit dl rm
npm-shrinkwrap.1	999	0644	edit dl rm
npm-star.1	1809	0644	edit dl rm
npm-stars.1	797	0644	edit dl rm
npm-start.1	1824	0644	edit dl rm
npm-stop.1	1454	0644	edit dl rm
npm-team.1	4505	0644	edit dl rm
npm-test.1	1367	0644	edit dl rm
npm-token.1	5522	0644	edit dl rm
npm-trust.1	10532	0644	edit dl rm
npm-undeprecate.1	1579	0644	edit dl rm
npm-uninstall.1	4988	0644	edit dl rm
npm-unpublish.1	4902	0644	edit dl rm
npm-unstar.1	1660	0644	edit dl rm
npm-update.1	14461	0644	edit dl rm
npm-version.1	9064	0644	edit dl rm
npm-view.1	8076	0644	edit dl rm
npm-whoami.1	875	0644	edit dl rm
npm.1	5968	0644	edit dl rm
npx.1	6865	0644	edit dl rm

Edit: /usr/local/lib/node_modules/npm/man/man1/npm-prune.1 (6453B)

.TH "NPM-PRUNE" "1" "March 2026" "NPM@11.12.0" ""
.SH "NAME"
\fBnpm-prune\fR - Remove extraneous packages
.SS "Synopsis"
.P
.RS 2
.nf
npm prune \[lB]\[lB]<@scope>/\[rB]<pkg>...\[rB]
.fi
.RE
.SS "Description"
.P
This command removes "extraneous" packages. If a package name is provided, then only packages matching one of the supplied names are removed.
.P
Extraneous packages are those present in the \fBnode_modules\fR folder that are not listed as any package's dependency list.
.P
If the \fB--omit=dev\fR flag is specified or the \fBNODE_ENV\fR environment variable is set to \fBproduction\fR, this command will remove the packages specified in your \fBdevDependencies\fR.
.P
If the \fB--dry-run\fR flag is used then no changes will actually be made.
.P
If the \fB--json\fR flag is used, then the changes \fBnpm prune\fR made (or would have made with \fB--dry-run\fR) are printed as a JSON object.
.P
In normal operation, extraneous modules are pruned automatically, so you'll only need this command with the \fB--production\fR flag. However, in the real world, operation is not always "normal". When crashes or mistakes happen, this command can help clean up any resulting garbage.
.SS "Configuration"
.SS "\fBomit\fR"
.RS 0
.IP \(bu 4
Default: 'dev' if the \fBNODE_ENV\fR environment variable is set to 'production'; otherwise, empty.
.IP \(bu 4
Type: "dev", "optional", or "peer" (can be set multiple times)
.RE 0

.P
Dependency types to omit from the installation tree on disk.
.P
Note that these dependencies \fIare\fR still resolved and added to the \fBpackage-lock.json\fR or \fBnpm-shrinkwrap.json\fR file. They are just not physically installed on disk.
.P
If a package type appears in both the \fB--include\fR and \fB--omit\fR lists, then it will be included.
.P
If the resulting omit list includes \fB'dev'\fR, then the \fBNODE_ENV\fR environment variable will be set to \fB'production'\fR for all lifecycle scripts.
.SS "\fBinclude\fR"
.RS 0
.IP \(bu 4
Default:
.IP \(bu 4
Type: "prod", "dev", "optional", or "peer" (can be set multiple times)
.RE 0

.P
Option that allows for defining which types of dependencies to install.
.P
This is the inverse of \fB--omit=<type>\fR.
.P
Dependency types specified in \fB--include\fR will not be omitted, regardless of the order in which omit/include are specified on the command-line.
.SS "\fBdry-run\fR"
.RS 0
.IP \(bu 4
Default: false
.IP \(bu 4
Type: Boolean
.RE 0

.P
Indicates that you don't want npm to make any changes and that it should only report what it would have done. This can be passed into any of the commands that modify your local installation, eg, \fBinstall\fR, \fBupdate\fR, \fBdedupe\fR, \fBuninstall\fR, as well as \fBpack\fR and \fBpublish\fR.
.P
Note: This is NOT honored by other network related commands, eg \fBdist-tags\fR, \fBowner\fR, etc.
.SS "\fBjson\fR"
.RS 0
.IP \(bu 4
Default: false
.IP \(bu 4
Type: Boolean
.RE 0

.P
Whether or not to output JSON data, rather than the normal output.
.RS 0
.IP \(bu 4
In \fBnpm pkg set\fR it enables parsing set values with JSON.parse() before saving them to your \fBpackage.json\fR.
.RE 0

.P
Not supported by all npm commands.
.SS "\fBforeground-scripts\fR"
.RS 0
.IP \(bu 4
Default: \fBfalse\fR unless when using \fBnpm pack\fR or \fBnpm publish\fR where it defaults to \fBtrue\fR
.IP \(bu 4
Type: Boolean
.RE 0

.P
Run all build scripts (ie, \fBpreinstall\fR, \fBinstall\fR, and \fBpostinstall\fR) scripts for installed packages in the foreground process, sharing standard input, output, and error with the main npm process.
.P
Note that this will generally make installs run slower, and be much noisier, but can be useful for debugging.
.SS "\fBignore-scripts\fR"
.RS 0
.IP \(bu 4
Default: false
.IP \(bu 4
Type: Boolean
.RE 0

.P
If true, npm does not run scripts specified in package.json files.
.P
Note that commands explicitly intended to run a particular script, such as \fBnpm start\fR, \fBnpm stop\fR, \fBnpm restart\fR, \fBnpm test\fR, and \fBnpm run\fR will still run their intended script if \fBignore-scripts\fR is set, but they will \fInot\fR run any pre- or post-scripts.
.SS "\fBworkspace\fR"
.RS 0
.IP \(bu 4
Default:
.IP \(bu 4
Type: String (can be set multiple times)
.RE 0

.P
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.
.P
Valid values for the \fBworkspace\fR config are either:
.RS 0
.IP \(bu 4
Workspace names
.IP \(bu 4
Path to a workspace directory
.IP \(bu 4
Path to a parent workspace directory (will result in selecting all workspaces within that folder)
.RE 0

.P
When set for the \fBnpm init\fR 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.
.P
This value is not exported to the environment for child processes.
.SS "\fBworkspaces\fR"
.RS 0
.IP \(bu 4
Default: null
.IP \(bu 4
Type: null or Boolean
.RE 0

.P
Set to true to run the command in the context of \fBall\fR configured workspaces.
.P
Explicitly setting this to false will cause commands like \fBinstall\fR to ignore workspaces altogether. When not set explicitly:
.RS 0
.IP \(bu 4
Commands that operate on the \fBnode_modules\fR tree (install, update, etc.) will link workspaces into the \fBnode_modules\fR folder. - Commands that do other things (test, exec, publish, etc.) will operate on the root project, \fIunless\fR one or more workspaces are specified in the \fBworkspace\fR config.
.RE 0

.P
This value is not exported to the environment for child processes.
.SS "\fBinclude-workspace-root\fR"
.RS 0
.IP \(bu 4
Default: false
.IP \(bu 4
Type: Boolean
.RE 0

.P
Include the workspace root when workspaces are enabled for a command.
.P
When false, specifying individual workspaces via the \fBworkspace\fR config, or all workspaces via the \fBworkspaces\fR flag, will cause npm to operate only on the specified workspaces, and not on the root project.
.P
This value is not exported to the environment for child processes.
.SS "\fBinstall-links\fR"
.RS 0
.IP \(bu 4
Default: false
.IP \(bu 4
Type: Boolean
.RE 0

.P
When set file: protocol dependencies will be packed and installed as regular dependencies instead of creating a symlink. This option has no effect on workspaces.
.SS "See Also"
.RS 0
.IP \(bu 4
npm help uninstall
.IP \(bu 4
npm help folders
.IP \(bu 4
npm help ls
.RE 0

cmd: