131 lines
3.8 KiB
Groff
131 lines
3.8 KiB
Groff
.TH "NPM-PACK" "1" "February 2023" "" ""
|
|
.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
|