deps/npm/html/doc/cli/npm-publish.html

   1 <!doctype html>
   2 <html>
   3   <title>npm-publish</title>
   4   <meta http-equiv="content-type" value="text/html;utf-8">
   5   <link rel="stylesheet" type="text/css" href="../../static/style.css">
   6   <link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-publish.html">
   7   <script async=true src="../../static/toc.js"></script>
   8
   9   <body>
  10     <div id="wrapper">
  11
  12 <h1><a href="../cli/npm-publish.html">npm-publish</a></h1> <p>Publish a package</p>
  13 <h2 id="synopsis">SYNOPSIS</h2>
  14 <pre><code>npm publish &lt;tarball&gt; [--tag &lt;tag&gt;]
  15 npm publish &lt;folder&gt; [--tag &lt;tag&gt;]
  16 </code></pre><h2 id="description">DESCRIPTION</h2>
  17 <p>Publishes a package to the registry so that it can be installed by name.</p>
  18 <ul>
  19 <li><p><code>&lt;folder&gt;</code>:
  20 A folder containing a package.json file</p>
  21 </li>
  22 <li><p><code>&lt;tarball&gt;</code>:
  23 A url or file path to a gzipped tar archive containing a single folder
  24 with a package.json file inside.</p>
  25 </li>
  26 <li><p><code>[--tag &lt;tag&gt;]</code>
  27 Registers the published package with the given tag, such that <code>npm install
  28 &lt;name&gt;@&lt;tag&gt;</code> will install this version.  By default, <code>npm publish</code> updates
  29 and <code>npm install</code> installs the <code>latest</code> tag.</p>
  30 </li>
  31 </ul>
  32 <p>Fails if the package name and version combination already exists in
  33 the registry.</p>
  34 <p>Once a package is published with a given name and version, that
  35 specific name and version combination can never be used again, even if
  36 it is removed with <a href="../cli/npm-unpublish.html">npm-unpublish(1)</a>.</p>
  37 <h2 id="see-also">SEE ALSO</h2>
  38 <ul>
  39 <li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
  40 <li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li>
  41 <li><a href="../cli/npm-owner.html">npm-owner(1)</a></li>
  42 <li><a href="../cli/npm-deprecate.html">npm-deprecate(1)</a></li>
  43 <li><a href="../cli/npm-tag.html">npm-tag(1)</a></li>
  44 </ul>
  45
  46 </div>
  47
  48 <table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
  49 <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18>&nbsp;</td></tr>
  50 <tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td colspan=6 style="width:60px;height:10px;background:#fff">&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td></tr>
  51 <tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2>&nbsp;</td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td></tr>
  52 <tr><td style="width:10px;height:10px;background:#fff" rowspan=2>&nbsp;</td></tr>
  53 <tr><td style="width:10px;height:10px;background:#fff">&nbsp;</td></tr>
  54 <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6>&nbsp;</td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td></tr>
  55 <tr><td colspan=5 style="width:50px;height:10px;background:#fff">&nbsp;</td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4>&nbsp;</td><td style="width:90px;height:10px;background:#fff" colspan=9>&nbsp;</td></tr>
  56 </table>
  57 <p id="footer">npm-publish &mdash; npm@1.4.14</p>
  58