Na}{

File Content: `npm-pack.1`

.TH "NPM-PACK" "1" "July 2024" "NPM@10.8.2" ""
.SH "NAME"
\fBnpm-pack\fR - Create a tarball from a package
.SS "Synopsis"
.P
.RS 2
.nf
npm pack <package-spec>
.fi
.RE
.SS "Configuration"
.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 "\fBpack-destination\fR"
.RS 0
.IP \(bu 4
Default: "."
.IP \(bu 4
Type: String
.RE 0

.P
Directory in which \fBnpm pack\fR will save tarballs.
.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 "Description"
.P
For anything that's installable (that is, a package folder, tarball, tarball url, git url, name@tag, name@version, name, or scoped name), this command will fetch it to the cache, copy the tarball to the current working directory as \fB<name>-<version>.tgz\fR, and then write the filenames out to stdout.
.P
If the same package is specified multiple times, then the file will be overwritten the second time.
.P
If no arguments are supplied, then npm packs the current package folder.
.SS "See Also"
.RS 0
.IP \(bu 4
npm help "package spec"
.IP \(bu 4
\fBnpm-packlist package\fR \fI\(lahttp://npm.im/npm-packlist\(ra\fR
.IP \(bu 4
npm help cache
.IP \(bu 4
npm help publish
.IP \(bu 4
npm help config
.IP \(bu 4
npm help npmrc
.RE 0

Name	Size	Permission
npm-access.1	4062 bytes	0644
npm-adduser.1	1992 bytes	0644
npm-audit.1	17381 bytes	0644
npm-bugs.1	3379 bytes	0644
npm-cache.1	3132 bytes	0644
npm-ci.1	10181 bytes	0644
npm-completion.1	997 bytes	0644
npm-config.1	4636 bytes	0644
npm-dedupe.1	9862 bytes	0644
npm-deprecate.1	1892 bytes	0644
npm-diff.1	9771 bytes	0644
npm-dist-tag.1	5636 bytes	0644
npm-docs.1	3361 bytes	0644
npm-doctor.1	5372 bytes	0644
npm-edit.1	1180 bytes	0644
npm-exec.1	12491 bytes	0644
npm-explain.1	2937 bytes	0644
npm-explore.1	1089 bytes	0644
npm-find-dupes.1	7590 bytes	0644
npm-fund.1	4054 bytes	0644
npm-help-search.1	867 bytes	0644
npm-help.1	1099 bytes	0644
npm-hook.1	2708 bytes	0644
npm-init.1	11103 bytes	0644
npm-install-ci-test.1	8320 bytes	0644
npm-install-test.1	11149 bytes	0644
npm-install.1	26964 bytes	0644
npm-link.1	12950 bytes	0644
npm-login.1	2345 bytes	0644
npm-logout.1	1887 bytes	0644
npm-ls.1	9419 bytes	0644
npm-org.1	2310 bytes	0644
npm-outdated.1	6377 bytes	0644
npm-owner.1	3363 bytes	0644
npm-pack.1	3876 bytes	0644
npm-ping.1	849 bytes	0644
npm-pkg.1	8704 bytes	0644
npm-prefix.1	1317 bytes	0644
npm-profile.1	3421 bytes	0644
npm-prune.1	6457 bytes	0644
npm-publish.1	8309 bytes	0644
npm-query.1	7688 bytes	0644
npm-rebuild.1	5664 bytes	0644
npm-repo.1	3143 bytes	0644
npm-restart.1	1709 bytes	0644
npm-root.1	1194 bytes	0644
npm-run-script.1	8377 bytes	0644
npm-sbom.1	8996 bytes	0644
npm-search.1	3952 bytes	0644
npm-shrinkwrap.1	1004 bytes	0644
npm-star.1	1807 bytes	0644
npm-stars.1	795 bytes	0644
npm-start.1	1835 bytes	0644
npm-stop.1	1466 bytes	0644
npm-team.1	4503 bytes	0644
npm-test.1	1379 bytes	0644
npm-token.1	3186 bytes	0644
npm-uninstall.1	4986 bytes	0644
npm-unpublish.1	4900 bytes	0644
npm-unstar.1	1658 bytes	0644
npm-update.1	13223 bytes	0644
npm-version.1	7755 bytes	0644
npm-view.1	6146 bytes	0644
npm-whoami.1	873 bytes	0644
npm.1	5947 bytes	0644
npx.1	6407 bytes	0644

File Content: npm-pack.1

File Content: `npm-pack.1`