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/README.html">
7 <script async=true src="../../static/toc.js"></script>
12 <h1><a href="cli/npm.html">npm</a></h1> <p>a JavaScript package manager</p>
13 <p><a href="https://travis-ci.org/npm/npm"><img src="https://img.shields.io/travis/npm/npm/master.svg" alt="Build Status"></a></p>
14 <h2 id="synopsis">SYNOPSIS</h2>
15 <p>This is just enough info to get you up and running.</p>
16 <p>Much more info available via <code>npm help</code> once it's installed.</p>
17 <h2 id="important">IMPORTANT</h2>
18 <p><strong>You need node v0.8 or higher to run this program.</strong></p>
19 <p>To install an old <strong>and unsupported</strong> version of npm that works on node 0.3
20 and prior, clone the git repo and dig through the old tags and branches.</p>
21 <h2 id="super-easy-install">Super Easy Install</h2>
22 <p>npm comes with <a href="http://nodejs.org/download/">node</a> now.</p>
23 <h3 id="windows-computers">Windows Computers</h3>
24 <p><a href="http://nodejs.org/download/">Get the MSI</a>. npm is in it.</p>
25 <h3 id="apple-macintosh-computers">Apple Macintosh Computers</h3>
26 <p><a href="http://nodejs.org/download/">Get the pkg</a>. npm is in it.</p>
27 <h3 id="other-sorts-of-unices">Other Sorts of Unices</h3>
28 <p>Run <code>make install</code>. npm will be installed with node.</p>
29 <p>If you want a more fancy pants install (a different version, customized
30 paths, etc.) then read on.</p>
31 <h2 id="fancy-install-unix-">Fancy Install (Unix)</h2>
32 <p>There's a pretty robust install script at
33 <a href="https://www.npmjs.com/install.sh">https://www.npmjs.com/install.sh</a>. You can download that and run it.</p>
34 <p>Here's an example using curl:</p>
35 <pre><code>curl -L https://npmjs.com/install.sh | sh
36 </code></pre><h3 id="slightly-fancier">Slightly Fancier</h3>
37 <p>You can set any npm configuration params with that script:</p>
38 <pre><code>npm_config_prefix=/some/path sh install.sh
39 </code></pre><p>Or, you can run it in uber-debuggery mode:</p>
40 <pre><code>npm_debug=1 sh install.sh
41 </code></pre><h3 id="even-fancier">Even Fancier</h3>
42 <p>Get the code with git. Use <code>make</code> to build the docs and do other stuff.
43 If you plan on hacking on npm, <code>make link</code> is your friend.</p>
44 <p>If you've got the npm source code, you can also semi-permanently set
45 arbitrary config keys using the <code>./configure --key=val ...</code>, and then
46 run npm commands by doing <code>node cli.js <cmd> <args></code>. (This is helpful
47 for testing, or running stuff without actually installing npm itself.)</p>
48 <h2 id="windows-install-or-upgrade">Windows Install or Upgrade</h2>
49 <p>You can download a zip file from <a href="https://github.com/npm/npm/releases">https://github.com/npm/npm/releases</a>, and unpack it
50 in the same folder where node.exe lives.</p>
51 <p>The latest version in a zip file is 1.4.12. To upgrade to npm 2, follow the
52 Windows upgrade instructions in the npm Troubleshooting Guide:</p>
53 <p><a href="https://github.com/npm/npm/wiki/Troubleshooting#upgrading-on-windows">https://github.com/npm/npm/wiki/Troubleshooting#upgrading-on-windows</a></p>
54 <p>If that's not fancy enough for you, then you can fetch the code with
55 git, and mess with it directly.</p>
56 <h2 id="installing-on-cygwin">Installing on Cygwin</h2>
58 <h2 id="uninstalling">Uninstalling</h2>
59 <p>So sad to see you go.</p>
60 <pre><code>sudo npm uninstall npm -g
61 </code></pre><p>Or, if that fails,</p>
62 <pre><code>sudo make uninstall
63 </code></pre><h2 id="more-severe-uninstalling">More Severe Uninstalling</h2>
64 <p>Usually, the above instructions are sufficient. That will remove
65 npm, but leave behind anything you've installed.</p>
66 <p>If you would like to remove all the packages that you have installed,
67 then you can use the <code>npm ls</code> command to find them, and then <code>npm rm</code> to
69 <p>To remove cruft left behind by npm 0.x, you can use the included
70 <code>clean-old.sh</code> script file. You can run it conveniently like this:</p>
71 <pre><code>npm explore npm -g -- sh scripts/clean-old.sh
72 </code></pre><p>npm uses two configuration files, one for per-user configs, and another
73 for global (every-user) configs. You can view them by doing:</p>
74 <pre><code>npm config get userconfig # defaults to ~/.npmrc
75 npm config get globalconfig # defaults to /usr/local/etc/npmrc
76 </code></pre><p>Uninstalling npm does not remove configuration files by default. You
77 must remove them yourself manually if you want them gone. Note that
78 this means that future npm installs will not remember the settings that
80 <h2 id="using-npm-programmatically">Using npm Programmatically</h2>
81 <p>If you would like to use npm programmatically, you can do that.
82 It's not very well documented, but it <em>is</em> rather simple.</p>
83 <p>Most of the time, unless you actually want to do all the things that
84 npm does, you should try using one of npm's dependencies rather than
85 using npm itself, if possible.</p>
86 <p>Eventually, npm will be just a thin cli wrapper around the modules
87 that it depends on, but for now, there are some things that you must
88 use npm itself to do.</p>
89 <pre><code>var npm = require("npm")
90 npm.load(myConfigObject, function (er) {
91 if (er) return handlError(er)
92 npm.commands.install(["some", "args"], function (er, data) {
93 if (er) return commandFailed(er)
94 // command succeeded, and data might have some info
96 npm.registry.log.on("log", function (message) { .... })
98 </code></pre><p>The <code>load</code> function takes an object hash of the command-line configs.
99 The various <code>npm.commands.<cmd></code> functions take an <strong>array</strong> of
100 positional argument <strong>strings</strong>. The last argument to any
101 <code>npm.commands.<cmd></code> function is a callback. Some commands take other
102 optional arguments. Read the source.</p>
103 <p>You cannot set configs individually for any single npm function at this
104 time. Since <code>npm</code> is a singleton, any call to <code>npm.config.set</code> will
105 change the value for <em>all</em> npm commands in that process.</p>
106 <p>See <code>./bin/npm-cli.js</code> for an example of pulling config values off of the
107 command line arguments using nopt. You may also want to check out <code>npm
108 help config</code> to learn about all the options you can set there.</p>
109 <h2 id="more-docs">More Docs</h2>
110 <p>Check out the <a href="https://docs.npmjs.com/">docs</a>,
111 especially the <a href="https://docs.npmjs.com/misc/faq">faq</a>.</p>
112 <p>You can use the <code>npm help</code> command to read any of them.</p>
113 <p>If you're a developer, and you want to use npm to publish your program,
114 you should <a href="https://docs.npmjs.com/misc/developers">read this</a></p>
115 <h2 id="legal-stuff">Legal Stuff</h2>
116 <p>"npm" and "The npm Registry" are owned by npm, Inc.
117 All rights reserved. See the included LICENSE file for more details.</p>
118 <p>"Node.js" and "node" are trademarks owned by Joyent, Inc.</p>
119 <p>Modules published on the npm registry are not officially endorsed by
120 npm, Inc. or the Node.js project.</p>
121 <p>Data published to the npm registry is not part of npm itself, and is
122 the sole property of the publisher. While every effort is made to
123 ensure accountability, there is absolutely no guarantee, warranty, or
124 assertion expressed or implied as to the quality, fitness for a
125 specific purpose, or lack of malice in any given npm package.</p>
126 <p>If you have a complaint about a package in the public npm registry,
127 and cannot <a href="https://docs.npmjs.com/misc/disputes">resolve it with the package
128 owner</a>, please email
129 <a href="mailto:support@npmjs.com">support@npmjs.com</a> and explain the situation.</p>
130 <p>Any data published to The npm Registry (including user account
131 information) may be removed or modified at the sole discretion of the
132 npm server administrators.</p>
133 <h3 id="in-plainer-english">In plainer english</h3>
134 <p>npm is the property of npm, Inc.</p>
135 <p>If you publish something, it's yours, and you are solely accountable
137 <p>If other people publish something, it's theirs.</p>
138 <p>Users can publish Bad Stuff. It will be removed promptly if reported.
139 But there is no vetting process for published modules, and you use
140 them at your own risk. Please inspect the source.</p>
141 <p>If you publish Bad Stuff, we may delete it from the registry, or even
142 ban your account in extreme cases. So don't do that.</p>
143 <h2 id="bugs">BUGS</h2>
144 <p>When you find issues, please report them:</p>
147 <a href="https://github.com/npm/npm/issues">https://github.com/npm/npm/issues</a></li>
149 <p>Be sure to include <em>all</em> of the output from the npm command that didn't work
150 as expected. The <code>npm-debug.log</code> file is also helpful to provide.</p>
151 <p>You can also look for isaacs in #node.js on irc://irc.freenode.net. He
152 will no doubt tell you to put the output in a gist or email.</p>
153 <h2 id="see-also">SEE ALSO</h2>
155 <li><a href="cli/npm.html"><a href="cli/npm.html">npm(1)</a></a></li>
156 <li><a href="misc/npm-faq.html"><a href="misc/npm-faq.html">npm-faq(7)</a></a></li>
157 <li><a href="cli/npm-help.html"><a href="cli/npm-help.html">npm-help(1)</a></a></li>
158 <li><a href="misc/npm-index.html"><a href="misc/npm-index.html">npm-index(7)</a></a></li>
163 <table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
164 <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
165 <tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
166 <tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
167 <tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
168 <tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
169 <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr>
170 <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr>
172 <p id="footer"><a href="../doc/README.html">README</a> — npm@2.7.4</p>
projects / platform / upstream / nodejs.git / blob