1 .TH "NPM" "1" "October 2016" "" ""
3 \fBnpm\fR \- a JavaScript package manager
5 Build Status \fIhttps://img\.shields\.io/travis/npm/npm/master\.svg\fR \fIhttps://travis\-ci\.org/npm/npm\fR
8 This is just enough info to get you up and running\.
10 Much more info available via \fBnpm help\fP once it's installed\.
13 \fBYou need node v0\.10 or higher to run this program\.\fR
15 To install an old \fBand unsupported\fR version of npm that works on node 0\.3
16 and prior, clone the git repo and dig through the old tags and branches\.
18 \fBnpm is configured to use npm, Inc\.'s public package registry at
19 https://registry\.npmjs\.org by default\.\fR
21 You can configure npm to use any compatible registry you
22 like, and even run your own registry\. Check out the doc on
23 registries \fIhttps://docs\.npmjs\.com/misc/registry\fR\|\.
25 Use of someone else's registry may be governed by terms of use\. The
26 terms of use for the default public registry are available at
27 https://www\.npmjs\.com\|\.
28 .SH Super Easy Install
30 npm is bundled with node \fIhttp://nodejs\.org/download/\fR\|\.
33 Get the MSI \fIhttp://nodejs\.org/download/\fR\|\. npm is in it\.
34 .SS Apple Macintosh Computers
36 Get the pkg \fIhttp://nodejs\.org/download/\fR\|\. npm is in it\.
37 .SS Other Sorts of Unices
39 Run \fBmake install\fP\|\. npm will be installed with node\.
41 If you want a more fancy pants install (a different version, customized
42 paths, etc\.) then read on\.
43 .SH Fancy Install (Unix)
45 There's a pretty robust install script at
46 https://www\.npmjs\.com/install\.sh\|\. You can download that and run it\.
48 Here's an example using curl:
52 curl \-L https://www\.npmjs\.com/install\.sh | sh
57 You can set any npm configuration params with that script:
61 npm_config_prefix=/some/path sh install\.sh
65 Or, you can run it in uber\-debuggery mode:
69 npm_debug=1 sh install\.sh
74 Get the code with git\. Use \fBmake\fP to build the docs and do other stuff\.
75 If you plan on hacking on npm, \fBmake link\fP is your friend\.
77 If you've got the npm source code, you can also semi\-permanently set
78 arbitrary config keys using the \fB\|\./configure \-\-key=val \.\.\.\fP, and then
79 run npm commands by doing \fBnode cli\.js <cmd> <args>\fP\|\. (This is helpful
80 for testing, or running stuff without actually installing npm itself\.)
81 .SH Windows Install or Upgrade
83 You can download a zip file from https://github\.com/npm/npm/releases, and
84 unpack it in the \fBnode_modules\\npm\\\fP folder inside node's installation folder\.
86 To upgrade to npm 2, follow the Windows upgrade instructions in
87 the npm Troubleshooting Guide:
89 https://github\.com/npm/npm/wiki/Troubleshooting#upgrading\-on\-windows
91 If that's not fancy enough for you, then you can fetch the code with
92 git, and mess with it directly\.
93 .SH Installing on Cygwin
98 So sad to see you go\.
102 sudo npm uninstall npm \-g
113 .SH More Severe Uninstalling
115 Usually, the above instructions are sufficient\. That will remove
116 npm, but leave behind anything you've installed\.
118 If you would like to remove all the packages that you have installed,
119 then you can use the \fBnpm ls\fP command to find them, and then \fBnpm rm\fP to
122 To remove cruft left behind by npm 0\.x, you can use the included
123 \fBclean\-old\.sh\fP script file\. You can run it conveniently like this:
127 npm explore npm \-g \-\- sh scripts/clean\-old\.sh
131 npm uses two configuration files, one for per\-user configs, and another
132 for global (every\-user) configs\. You can view them by doing:
136 npm config get userconfig # defaults to ~/\.npmrc
137 npm config get globalconfig # defaults to /usr/local/etc/npmrc
141 Uninstalling npm does not remove configuration files by default\. You
142 must remove them yourself manually if you want them gone\. Note that
143 this means that future npm installs will not remember the settings that
147 Check out the docs \fIhttps://docs\.npmjs\.com/\fR,
148 especially the faq \fIhttps://docs\.npmjs\.com/misc/faq\fR\|\.
150 You can use the \fBnpm help\fP command to read any of them\.
152 If you're a developer, and you want to use npm to publish your program,
153 you should read this \fIhttps://docs\.npmjs\.com/misc/developers\fR
156 When you find issues, please report them:
160 https://github\.com/npm/npm/issues
164 Be sure to include \fIall\fR of the output from the npm command that didn't work
165 as expected\. The \fBnpm\-debug\.log\fP file is also helpful to provide\.
167 You can also look for isaacs in #node\.js on irc://irc\.freenode\.net\. He
168 will no doubt tell you to put the output in a gist or email\.