FM / man1

/snap/node/11782/lib/node_modules/npm/man/man1/

/snap/node/11782/lib/node_modules/npm/man/man1

Name	Size	Mode	Actions
npm-access.1	4063	0644	edit dl rm
npm-adduser.1	1993	0644	edit dl rm
npm-audit.1	17382	0644	edit dl rm
npm-bugs.1	3380	0644	edit dl rm
npm-cache.1	3133	0644	edit dl rm
npm-ci.1	10182	0644	edit dl rm
npm-completion.1	998	0644	edit dl rm
npm-config.1	4637	0644	edit dl rm
npm-dedupe.1	9863	0644	edit dl rm
npm-deprecate.1	1893	0644	edit dl rm
npm-diff.1	9772	0644	edit dl rm
npm-dist-tag.1	5637	0644	edit dl rm
npm-docs.1	3362	0644	edit dl rm
npm-doctor.1	5373	0644	edit dl rm
npm-edit.1	1181	0644	edit dl rm
npm-exec.1	12492	0644	edit dl rm
npm-explain.1	2938	0644	edit dl rm
npm-explore.1	1090	0644	edit dl rm
npm-find-dupes.1	7591	0644	edit dl rm
npm-fund.1	4055	0644	edit dl rm
npm-help-search.1	868	0644	edit dl rm
npm-help.1	1100	0644	edit dl rm
npm-hook.1	2709	0644	edit dl rm
npm-init.1	11111	0644	edit dl rm
npm-install-ci-test.1	8321	0644	edit dl rm
npm-install-test.1	11150	0644	edit dl rm
npm-install.1	26772	0644	edit dl rm
npm-link.1	12951	0644	edit dl rm
npm-login.1	2346	0644	edit dl rm
npm-logout.1	1888	0644	edit dl rm
npm-ls.1	9420	0644	edit dl rm
npm-org.1	2311	0644	edit dl rm
npm-outdated.1	6378	0644	edit dl rm
npm-owner.1	3364	0644	edit dl rm
npm-pack.1	3877	0644	edit dl rm
npm-ping.1	850	0644	edit dl rm
npm-pkg.1	8705	0644	edit dl rm
npm-prefix.1	1318	0644	edit dl rm
npm-profile.1	3422	0644	edit dl rm
npm-prune.1	6458	0644	edit dl rm
npm-publish.1	8310	0644	edit dl rm
npm-query.1	7689	0644	edit dl rm
npm-rebuild.1	5665	0644	edit dl rm
npm-repo.1	3144	0644	edit dl rm
npm-restart.1	1710	0644	edit dl rm
npm-root.1	1195	0644	edit dl rm
npm-run-script.1	8378	0644	edit dl rm
npm-sbom.1	8997	0644	edit dl rm
npm-search.1	3953	0644	edit dl rm
npm-shrinkwrap.1	1005	0644	edit dl rm
npm-star.1	1808	0644	edit dl rm
npm-stars.1	796	0644	edit dl rm
npm-start.1	1836	0644	edit dl rm
npm-stop.1	1467	0644	edit dl rm
npm-team.1	4504	0644	edit dl rm
npm-test.1	1380	0644	edit dl rm
npm-token.1	3187	0644	edit dl rm
npm-uninstall.1	4987	0644	edit dl rm
npm-unpublish.1	4901	0644	edit dl rm
npm-unstar.1	1659	0644	edit dl rm
npm-update.1	13224	0644	edit dl rm
npm-version.1	7756	0644	edit dl rm
npm-view.1	6147	0644	edit dl rm
npm-whoami.1	874	0644	edit dl rm
npm.1	5948	0644	edit dl rm
npx.1	6408	0644	edit dl rm

Edit: /snap/node/11782/lib/node_modules/npm/man/man1/npm-docs.1 (3362B)

.TH "NPM-DOCS" "1" "March 2026" "NPM@10.9.8" ""
.SH "NAME"
\fBnpm-docs\fR - Open documentation for a package in a web browser
.SS "Synopsis"
.P
.RS 2
.nf
npm docs \[lB]<pkgname> \[lB]<pkgname> ...\[rB]\[rB]

alias: home
.fi
.RE
.SS "Description"
.P
This command tries to guess at the likely location of a package's documentation URL, and then tries to open it using the \fB\fB--browser\fR config\fR \fI\(la/using-npm/config#browser\(ra\fR param. You can pass multiple package names at once. If no package name is provided, it will search for a \fBpackage.json\fR in the current folder and use the \fBname\fR property.
.SS "Configuration"
.SS "\fBbrowser\fR"
.RS 0
.IP \(bu 4
Default: OS X: \fB"open"\fR, Windows: \fB"start"\fR, Others: \fB"xdg-open"\fR
.IP \(bu 4
Type: null, Boolean, or String
.RE 0

.P
The browser that is called by npm commands to open websites.
.P
Set to \fBfalse\fR to suppress browser behavior and instead print urls to terminal.
.P
Set to \fBtrue\fR to use default system URL opener.
.SS "\fBregistry\fR"
.RS 0
.IP \(bu 4
Default: "https://registry.npmjs.org/"
.IP \(bu 4
Type: URL
.RE 0

.P
The base URL of the npm registry.
.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 "See Also"
.RS 0
.IP \(bu 4
npm help view
.IP \(bu 4
npm help publish
.IP \(bu 4
npm help registry
.IP \(bu 4
npm help config
.IP \(bu 4
npm help npmrc
.IP \(bu 4
\fBpackage.json\fR \fI\(la/configuring-npm/package-json\(ra\fR
.RE 0

cmd: