1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>npm-pack</title>
4<style>
5body {
6    background-color: #ffffff;
7    color: #24292e;
8
9    margin: 0;
10
11    line-height: 1.5;
12
13    font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
14}
15#rainbar {
16    height: 10px;
17    background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
18}
19
20a {
21    text-decoration: none;
22    color: #0366d6;
23}
24a:hover {
25    text-decoration: underline;
26}
27
28pre {
29    margin: 1em 0px;
30    padding: 1em;
31    border: solid 1px #e1e4e8;
32    border-radius: 6px;
33
34    display: block;
35    overflow: auto;
36
37    white-space: pre;
38
39    background-color: #f6f8fa;
40    color: #393a34;
41}
42code {
43    font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
44    font-size: 85%;
45    padding: 0.2em 0.4em;
46    background-color: #f6f8fa;
47    color: #393a34;
48}
49pre > code {
50    padding: 0;
51    background-color: inherit;
52    color: inherit;
53}
54h1, h2, h3 {
55    font-weight: 600;
56}
57
58#logobar {
59    background-color: #333333;
60    margin: 0 auto;
61    padding: 1em 4em;
62}
63#logobar .logo {
64    float: left;
65}
66#logobar .title {
67    font-weight: 600;
68    color: #dddddd;
69    float: left;
70    margin: 5px 0 0 1em;
71}
72#logobar:after {
73    content: "";
74    display: block;
75    clear: both;
76}
77
78#content {
79    margin: 0 auto;
80    padding: 0 4em;
81}
82
83#table_of_contents > h2 {
84    font-size: 1.17em;
85}
86#table_of_contents ul:first-child {
87    border: solid 1px #e1e4e8;
88    border-radius: 6px;
89    padding: 1em;
90    background-color: #f6f8fa;
91    color: #393a34;
92}
93#table_of_contents ul {
94    list-style-type: none;
95    padding-left: 1.5em;
96}
97#table_of_contents li {
98    font-size: 0.9em;
99}
100#table_of_contents li a {
101    color: #000000;
102}
103
104header.title {
105    border-bottom: solid 1px #e1e4e8;
106}
107header.title > h1 {
108    margin-bottom: 0.25em;
109}
110header.title > .description {
111    display: block;
112    margin-bottom: 0.5em;
113    line-height: 1;
114}
115
116footer#edit {
117    border-top: solid 1px #e1e4e8;
118    margin: 3em 0 4em 0;
119    padding-top: 2em;
120}
121</style>
122</head>
123<body>
124<div id="banner">
125<div id="rainbar"></div>
126<div id="logobar">
127<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
128<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
129<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
130</svg>
131<div class="title">
132npm command-line interface
133</div>
134</div>
135</div>
136
137<section id="content">
138<header class="title">
139<h1 id="npm-pack">npm-pack</h1>
140<span class="description">Create a tarball from a package</span>
141</header>
142
143<section id="table_of_contents">
144<h2 id="table-of-contents">Table of contents</h2>
145<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#dry-run"><code>dry-run</code></a></li><li><a href="#json"><code>json</code></a></li><li><a href="#pack-destination"><code>pack-destination</code></a></li><li><a href="#workspace"><code>workspace</code></a></li><li><a href="#workspaces"><code>workspaces</code></a></li><li><a href="#include-workspace-root"><code>include-workspace-root</code></a></li></ul><li><a href="#description">Description</a></li><li><a href="#see-also">See Also</a></li></ul></div>
146</section>
147
148<div id="_content"><h3 id="synopsis">Synopsis</h3>
149<pre><code class="language-bash">npm pack &lt;package-spec&gt;
150</code></pre>
151<h3 id="configuration">Configuration</h3>
152<h4 id="dry-run"><code>dry-run</code></h4>
153<ul>
154<li>Default: false</li>
155<li>Type: Boolean</li>
156</ul>
157<p>Indicates that you don't want npm to make any changes and that it should
158only report what it would have done. This can be passed into any of the
159commands that modify your local installation, eg, <code>install</code>, <code>update</code>,
160<code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p>
161<p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>,
162<code>owner</code>, etc.</p>
163<h4 id="json"><code>json</code></h4>
164<ul>
165<li>Default: false</li>
166<li>Type: Boolean</li>
167</ul>
168<p>Whether or not to output JSON data, rather than the normal output.</p>
169<ul>
170<li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before
171saving them to your <code>package.json</code>.</li>
172</ul>
173<p>Not supported by all npm commands.</p>
174<h4 id="pack-destination"><code>pack-destination</code></h4>
175<ul>
176<li>Default: "."</li>
177<li>Type: String</li>
178</ul>
179<p>Directory in which <code>npm pack</code> will save tarballs.</p>
180<h4 id="workspace"><code>workspace</code></h4>
181<ul>
182<li>Default:</li>
183<li>Type: String (can be set multiple times)</li>
184</ul>
185<p>Enable running a command in the context of the configured workspaces of the
186current project while filtering by running only the workspaces defined by
187this configuration option.</p>
188<p>Valid values for the <code>workspace</code> config are either:</p>
189<ul>
190<li>Workspace names</li>
191<li>Path to a workspace directory</li>
192<li>Path to a parent workspace directory (will result in selecting all
193workspaces within that folder)</li>
194</ul>
195<p>When set for the <code>npm init</code> command, this may be set to the folder of a
196workspace which does not yet exist, to create the folder and set it up as a
197brand new workspace within the project.</p>
198<p>This value is not exported to the environment for child processes.</p>
199<h4 id="workspaces"><code>workspaces</code></h4>
200<ul>
201<li>Default: null</li>
202<li>Type: null or Boolean</li>
203</ul>
204<p>Set to true to run the command in the context of <strong>all</strong> configured
205workspaces.</p>
206<p>Explicitly setting this to false will cause commands like <code>install</code> to
207ignore workspaces altogether. When not set explicitly:</p>
208<ul>
209<li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
210will link workspaces into the <code>node_modules</code> folder. - Commands that do
211other things (test, exec, publish, etc.) will operate on the root project,
212<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
213</ul>
214<p>This value is not exported to the environment for child processes.</p>
215<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
216<ul>
217<li>Default: false</li>
218<li>Type: Boolean</li>
219</ul>
220<p>Include the workspace root when workspaces are enabled for a command.</p>
221<p>When false, specifying individual workspaces via the <code>workspace</code> config, or
222all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
223the specified workspaces, and not on the root project.</p>
224<p>This value is not exported to the environment for child processes.</p>
225<h3 id="description">Description</h3>
226<p>For anything that's installable (that is, a package folder, tarball,
227tarball url, git url, name@tag, name@version, name, or scoped name), this
228command will fetch it to the cache, copy the tarball to the current working
229directory as <code>&lt;name&gt;-&lt;version&gt;.tgz</code>, and then write the filenames out to
230stdout.</p>
231<p>If the same package is specified multiple times, then the file will be
232overwritten the second time.</p>
233<p>If no arguments are supplied, then npm packs the current package folder.</p>
234<h3 id="see-also">See Also</h3>
235<ul>
236<li><a href="../using-npm/package-spec.html">package spec</a></li>
237<li><a href="http://npm.im/npm-packlist">npm-packlist package</a></li>
238<li><a href="../commands/npm-cache.html">npm cache</a></li>
239<li><a href="../commands/npm-publish.html">npm publish</a></li>
240<li><a href="../commands/npm-config.html">npm config</a></li>
241<li><a href="../configuring-npm/npmrc.html">npmrc</a></li>
242</ul></div>
243
244<footer id="edit">
245<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-pack.md">
246<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
247<path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path>
248</svg>
249Edit this page on GitHub
250</a>
251</footer>
252</section>
253
254
255
256</body></html>