FM / commands

/home/techb158/.nvm/versions/node/v16.20.2/lib/node_modules/npm/docs/content/commands/

/home/techb158/.nvm/versions/node/v16.20.2/lib/node_modules/npm/docs/content/commands

Name	Size	Mode	Actions
npm-access.md	3359	0644	edit dl rm
npm-adduser.md	2315	0644	edit dl rm
npm-audit.md	14321	0644	edit dl rm
npm-bin.md	898	0644	edit dl rm
npm-bugs.md	2963	0644	edit dl rm
npm-cache.md	2999	0644	edit dl rm
npm-ci.md	9481	0644	edit dl rm
npm-completion.md	909	0644	edit dl rm
npm-config.md	3705	0644	edit dl rm
npm-dedupe.md	8160	0644	edit dl rm
npm-deprecate.md	1737	0644	edit dl rm
npm-diff.md	8971	0644	edit dl rm
npm-dist-tag.md	5079	0644	edit dl rm
npm-docs.md	2941	0644	edit dl rm
npm-doctor.md	4760	0644	edit dl rm
npm-edit.md	1077	0644	edit dl rm
npm-exec.md	11209	0644	edit dl rm
npm-explain.md	2793	0644	edit dl rm
npm-explore.md	1004	0644	edit dl rm
npm-find-dupes.md	6064	0644	edit dl rm
npm-fund.md	3605	0644	edit dl rm
npm-help-search.md	754	0644	edit dl rm
npm-help.md	1002	0644	edit dl rm
npm-hook.md	2390	0644	edit dl rm
npm-init.md	8986	0644	edit dl rm
npm-install-ci-test.md	7763	0644	edit dl rm
npm-install-test.md	7840	0644	edit dl rm
npm-install.md	23133	0644	edit dl rm
npm-link.md	11001	0644	edit dl rm
npm-logout.md	1746	0644	edit dl rm
npm-ls.md	8202	0644	edit dl rm
npm-org.md	1967	0644	edit dl rm
npm-outdated.md	5769	0644	edit dl rm
npm-owner.md	3100	0644	edit dl rm
npm-pack.md	3442	0644	edit dl rm
npm-ping.md	767	0644	edit dl rm
npm-pkg.md	7815	0644	edit dl rm
npm-prefix.md	1240	0644	edit dl rm
npm-profile.md	3899	0644	edit dl rm
npm-prune.md	5410	0644	edit dl rm
npm-publish.md	7289	0644	edit dl rm
npm-query.md	5069	0644	edit dl rm
npm-rebuild.md	4264	0644	edit dl rm
npm-repo.md	2721	0644	edit dl rm
npm-restart.md	1469	0644	edit dl rm
npm-root.md	1080	0644	edit dl rm
npm-run-script.md	7355	0644	edit dl rm
npm-search.md	3402	0644	edit dl rm
npm-set-script.md	2397	0644	edit dl rm
npm-shrinkwrap.md	923	0644	edit dl rm
npm-star.md	1707	0644	edit dl rm
npm-stars.md	741	0644	edit dl rm
npm-start.md	1663	0644	edit dl rm
npm-stop.md	1337	0644	edit dl rm
npm-team.md	4058	0644	edit dl rm
npm-test.md	1230	0644	edit dl rm
npm-token.md	4213	0644	edit dl rm
npm-uninstall.md	4021	0644	edit dl rm
npm-unpublish.md	4370	0644	edit dl rm
npm-unstar.md	1568	0644	edit dl rm
npm-update.md	11085	0644	edit dl rm
npm-version.md	6827	0644	edit dl rm
npm-view.md	5269	0644	edit dl rm
npm-whoami.md	798	0644	edit dl rm
npm.md	5586	0644	edit dl rm
npx.md	5730	0644	edit dl rm

Edit: /home/techb158/.nvm/versions/node/v16.20.2/lib/node_modules/npm/docs/content/commands/npm-pack.md (3442B)

---
title: npm-pack
section: 1
description: Create a tarball from a package
---

### Synopsis

```bash
npm pack <package-spec>
```

### Configuration

#### `dry-run`

* Default: false
* Type: Boolean

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, `install`, `update`,
`dedupe`, `uninstall`, as well as `pack` and `publish`.

Note: This is NOT honored by other network related commands, eg `dist-tags`,
`owner`, etc.

#### `json`

* Default: false
* Type: Boolean

Whether or not to output JSON data, rather than the normal output.

* In `npm pkg set` it enables parsing set values with JSON.parse() before
  saving them to your `package.json`.

Not supported by all npm commands.

#### `pack-destination`

* Default: "."
* Type: String

Directory in which `npm pack` will save tarballs.

#### `workspace`

* Default:
* Type: String (can be set multiple times)

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.

Valid values for the `workspace` config are either:

* Workspace names
* Path to a workspace directory
* Path to a parent workspace directory (will result in selecting all
  workspaces within that folder)

When set for the `npm init` 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.

This value is not exported to the environment for child processes.

#### `workspaces`

* Default: null
* Type: null or Boolean

Set to true to run the command in the context of **all** configured
workspaces.

Explicitly setting this to false will cause commands like `install` to
ignore workspaces altogether. When not set explicitly:

- Commands that operate on the `node_modules` tree (install, update, etc.)
will link workspaces into the `node_modules` folder. - Commands that do
other things (test, exec, publish, etc.) will operate on the root project,
_unless_ one or more workspaces are specified in the `workspace` config.

This value is not exported to the environment for child processes.

#### `include-workspace-root`

* Default: false
* Type: Boolean

Include the workspace root when workspaces are enabled for a command.

When false, specifying individual workspaces via the `workspace` config, or
all workspaces via the `workspaces` flag, will cause npm to operate only on
the specified workspaces, and not on the root project.

This value is not exported to the environment for child processes.

### 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

* [package spec](/using-npm/package-spec)
* [npm-packlist package](http://npm.im/npm-packlist)
* [npm cache](/commands/npm-cache)
* [npm publish](/commands/npm-publish)
* [npm config](/commands/npm-config)
* [npmrc](/configuring-npm/npmrc)

cmd: