cb9b48d8f88eaaa405ce6c470872fa6966f63cf8
[platform/upstream/nodejs.git] / deps / npm / html / doc / api / 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
7   <body>
8     <div id="wrapper">
9 <h1><a href="../api/npm-publish.html">npm-publish</a></h1> <p>Publish a package</p>
10
11 <h2 id="SYNOPSIS">SYNOPSIS</h2>
12
13 <pre><code>npm.commands.publish([packages,] callback)</code></pre>
14
15 <h2 id="DESCRIPTION">DESCRIPTION</h2>
16
17 <p>Publishes a package to the registry so that it can be installed by name.
18 Possible values in the &#39;packages&#39; array are:</p>
19
20 <ul><li><p><code>&lt;folder&gt;</code>:
21 A folder containing a package.json file</p></li><li><p><code>&lt;tarball&gt;</code>:
22 A url or file path to a gzipped tar archive containing a single folder
23 with a package.json file inside.</p></li></ul>
24
25 <p>If the package array is empty, npm will try to publish something in the
26 current working directory.</p>
27
28 <p>This command could fails if one of the packages specified already exists in
29 the registry.  Overwrites when the &quot;force&quot; environment variable is set.</p>
30
31 <h2 id="SEE-ALSO">SEE ALSO</h2>
32
33 <ul><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li><li><a href="../api/npm-owner.html">npm-owner(3)</a></li></ul>
34 </div>
35 <p id="footer">npm-publish &mdash; npm@1.3.15</p>
36 <script>
37 ;(function () {
38 var wrapper = document.getElementById("wrapper")
39 var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0)
40   .filter(function (el) {
41     return el.parentNode === wrapper
42         && el.tagName.match(/H[1-6]/)
43         && el.id
44   })
45 var l = 2
46   , toc = document.createElement("ul")
47 toc.innerHTML = els.map(function (el) {
48   var i = el.tagName.charAt(1)
49     , out = ""
50   while (i > l) {
51     out += "<ul>"
52     l ++
53   }
54   while (i < l) {
55     out += "</ul>"
56     l --
57   }
58   out += "<li><a href='#" + el.id + "'>" +
59     ( el.innerText || el.text || el.innerHTML)
60     + "</a>"
61   return out
62 }).join("\n")
63 toc.id = "toc"
64 document.body.appendChild(toc)
65 })()
66 </script>