diff options
Diffstat (limited to 'docs/content/commands/npm-pack.md')
| -rw-r--r-- | docs/content/commands/npm-pack.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/content/commands/npm-pack.md b/docs/content/commands/npm-pack.md new file mode 100644 index 000000000..fddd1054f --- /dev/null +++ b/docs/content/commands/npm-pack.md @@ -0,0 +1,34 @@ +--- +title: npm-pack +section: 1 +description: Create a tarball from a package +--- + +### Synopsis + +```bash +npm pack [[<@scope>/]<pkg>...] [--dry-run] +``` + +### Description + +For anything that's installable (that is, a package folder, tarball, +tarball url, name@tag, name@version, name, or scoped name), this +command will fetch it to the cache, and then 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. + +The `--dry-run` argument will do everything that pack usually does without +actually packing anything. Reports on what would have gone into the tarball. + +### See Also + +* [npm cache](/cli-commands/cache) +* [npm publish](/cli-commands/publish) +* [npm config](/cli-commands/config) +* [npmrc](/configuring-npm/npmrc) |