Skip to content

npm-pack

Create a tarball from a package

Synopsis

npm pack [[<@scope>/]<pkg>...] [--dry-run]

Configuration

dry-run

Do everything that pack usually does without actually packing anything. That is, report on what would have gone into the tarball, but nothing else.

workspaces

Enables workspaces context while creating tarballs. Tarballs for each workspaces will be generated.

workspace

Enables workspaces context and limits results to only those specified by this config item. Tarballs will only be generated for the packages named in the workspaces given here.

Description

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 <name>-<version>.tgz, and then write the filenames out to stdout.

If the same package is specified multiple times, then the file will be overwritten the second time.

If no arguments are supplied, then npm packs the current package folder.

See Also