Skip to content
This repository
Newer
Older
100644 171 lines (170 sloc) 4.395 kb
f2ccd178 »
2010-08-18 Use ronnjs instead of the ronn rubygem to build docs
1 .\" Generated with Ronnjs/v0.1
2 .\" http://github.com/kapouer/ronnjs/
b70b2a09 »
2010-05-03 Add built documentation to project, so that the install doesn't requi…
3 .
0ce98538 »
2011-03-03 make doc
4 .TH "NPM" "1" "March 2011" "" ""
b70b2a09 »
2010-05-03 Add built documentation to project, so that the install doesn't requi…
5 .
6 .SH "NAME"
f2ccd178 »
2010-08-18 Use ronnjs instead of the ronn rubygem to build docs
7 \fBnpm\fR \-\- node package manager
b70b2a09 »
2010-05-03 Add built documentation to project, so that the install doesn't requi…
8 .
9 .SH "SYNOPSIS"
10 .
11 .nf
12 npm <command> [args]
13 .
14 .fi
15 .
16 .SH "DESCRIPTION"
3703cee2 »
2010-11-26 better manpage docs.
17 npm is the package manager for the Node JavaScript platform\. It puts
18 modules in place so that node can find them, and manages dependency
19 conflicts intelligently\.
b70b2a09 »
2010-05-03 Add built documentation to project, so that the install doesn't requi…
20 .
21 .P
3703cee2 »
2010-11-26 better manpage docs.
22 It is extremely configurable to support a wide variety of use cases\.
23 Most commonly, it is used to publish, discover, install, and develop node
24 programs\.
b70b2a09 »
2010-05-03 Add built documentation to project, so that the install doesn't requi…
25 .
26 .P
3703cee2 »
2010-11-26 better manpage docs.
27 Run \fBnpm help\fR to get a list of available commands\.
b70b2a09 »
2010-05-03 Add built documentation to project, so that the install doesn't requi…
28 .
3703cee2 »
2010-11-26 better manpage docs.
29 .SH "INTRODUCTION"
a3b0aa84 »
2010-09-28 Merge the "help" and "npm" man pages.
30 You probably got npm because you want to install stuff\.
31 .
32 .P
33 Use \fBnpm install blerg\fR to install the latest version of "blerg"\. Check out \fBnpm help install\fR for more info\. It can do a lot of stuff\.
34 .
35 .P
3703cee2 »
2010-11-26 better manpage docs.
36 Use the \fBnpm ls\fR command to show everything that\'s available\.
37 Use \fBnpm ls installed\fR to show everything you\'ve installed\. \fBnpm help ls\fR will tell you more\.
a3b0aa84 »
2010-09-28 Merge the "help" and "npm" man pages.
38 .
3703cee2 »
2010-11-26 better manpage docs.
39 .SH "DEVELOPER USAGE"
40 If you\'re using npm to develop and publish your code, check out the
41 following help topics:
a3b0aa84 »
2010-09-28 Merge the "help" and "npm" man pages.
42 .
43 .IP "\(bu" 4
44 json:
3703cee2 »
2010-11-26 better manpage docs.
45 Make a package\.json file\. See \fBnpm help json\fR\|\.
a3b0aa84 »
2010-09-28 Merge the "help" and "npm" man pages.
46 .
47 .IP "\(bu" 4
48 link:
3703cee2 »
2010-11-26 better manpage docs.
49 For linking your current working code into Node\'s path, so that you
50 don\'t have to reinstall every time you make a change\. Use \fBnpm link\fR to do this\.
a3b0aa84 »
2010-09-28 Merge the "help" and "npm" man pages.
51 .
52 .IP "\(bu" 4
53 install:
3703cee2 »
2010-11-26 better manpage docs.
54 It\'s a good idea to install things if you don\'t need the symbolic link\.
55 Especially, installing other peoples code from the registry is done via \fBnpm install\fR
a3b0aa84 »
2010-09-28 Merge the "help" and "npm" man pages.
56 .
57 .IP "\(bu" 4
58 adduser:
3703cee2 »
2010-11-26 better manpage docs.
59 Create an account or log in\. Creditials are stored (encrypted) in the
60 user config file\.
a3b0aa84 »
2010-09-28 Merge the "help" and "npm" man pages.
61 .
62 .IP "\(bu" 4
63 publish:
3703cee2 »
2010-11-26 better manpage docs.
64 Use the \fBnpm publish\fR command to upload your code to the registry\.
65 .
66 .IP "" 0
67 .
68 .SH "CONFIGURATION"
69 npm is extremely configurable\. It reads its configuration options from
70 5 places\.
71 .
72 .IP "\(bu" 4
73 Command line switches:
74 .
75 .br
76 Set a config with \fB\-\-key val\fR\|\. All keys take a value, even if they
77 are booleans (the config parser doesn\'t know what the options are at
78 the time of parsing\.) If no value is provided, then the option is set
79 to boolean \fBtrue\fR\|\.
80 .
81 .IP "\(bu" 4
82 Environment Variables:
83 .
84 .br
85 Set any config by prefixing the name in an environment variable with \fBnpm_config_\fR\|\. For example, \fBexport npm_config_key=val\fR\|\.
86 .
87 .IP "\(bu" 4
88 User Configs:
89 .
90 .br
91 The file at $HOME/\.npmrc is an ini\-formatted list of configs\. If
92 present, it is parsed\. If the \fBuserconfig\fR option is set in the cli
93 or env, then that will be used instead\.
94 .
95 .IP "\(bu" 4
96 Global Configs:
97 .
98 .br
99 The file found at \.\./etc/npmrc (from the node executable, by default
100 this resolves to /usr/local/etc/npmrc) will be parsed if it is found\.
101 If the \fBglobalconfig\fR option is set in the cli, env, or user config,
102 then that file is parsed instead\.
103 .
104 .IP "\(bu" 4
105 Defaults:
106 .
107 .br
108 npm\'s default configuration options are defined in
109 lib/utils/default\-config\.js\. These should not be changed\.
a3b0aa84 »
2010-09-28 Merge the "help" and "npm" man pages.
110 .
111 .IP "" 0
112 .
3703cee2 »
2010-11-26 better manpage docs.
113 .P
0ce98538 »
2011-03-03 make doc
114 See \fBnpm help config\fR for much much more information\.
3703cee2 »
2010-11-26 better manpage docs.
115 .
a3b0aa84 »
2010-09-28 Merge the "help" and "npm" man pages.
116 .SH "CONTRIBUTIONS"
117 Patches welcome!
118 .
119 .IP "\(bu" 4
120 code:
3703cee2 »
2010-11-26 better manpage docs.
121 Read through \fBnpm help coding\-style\fR if you plan to submit code\.
122 You don\'t have to agree with it, but you do have to follow it\.
a3b0aa84 »
2010-09-28 Merge the "help" and "npm" man pages.
123 .
124 .IP "\(bu" 4
125 docs:
3703cee2 »
2010-11-26 better manpage docs.
126 If you find an error in the documentation, edit the appropriate markdown
127 file in the "doc" folder\. (Don\'t worry about generating the man page\.)
a3b0aa84 »
2010-09-28 Merge the "help" and "npm" man pages.
128 .
129 .IP "" 0
130 .
131 .P
3703cee2 »
2010-11-26 better manpage docs.
132 Contributors are listed in npm\'s \fBpackage\.json\fR file\. You can view them
133 easily by doing \fBnpm view npm contributors\fR\|\.
b70b2a09 »
2010-05-03 Add built documentation to project, so that the install doesn't requi…
134 .
135 .P
3703cee2 »
2010-11-26 better manpage docs.
136 If you would like to contribute, but don\'t know what to work on, check
137 the issues list or ask on the mailing list\.
b70b2a09 »
2010-05-03 Add built documentation to project, so that the install doesn't requi…
138 .
3703cee2 »
2010-11-26 better manpage docs.
139 .IP "\(bu" 4
140 \fIhttp://github\.com/isaacs/npm/issues\fR
b70b2a09 »
2010-05-03 Add built documentation to project, so that the install doesn't requi…
141 .
3703cee2 »
2010-11-26 better manpage docs.
142 .IP "\(bu" 4
143 \fInpm\-@googlegroups\.com\fR
b70b2a09 »
2010-05-03 Add built documentation to project, so that the install doesn't requi…
144 .
3703cee2 »
2010-11-26 better manpage docs.
145 .IP "" 0
b70b2a09 »
2010-05-03 Add built documentation to project, so that the install doesn't requi…
146 .
4ad295c0 »
2010-07-22 make doc
147 .SH "BUGS"
148 When you find issues, please report them:
b70b2a09 »
2010-05-03 Add built documentation to project, so that the install doesn't requi…
149 .
f2ccd178 »
2010-08-18 Use ronnjs instead of the ronn rubygem to build docs
150 .IP "\(bu" 4
151 web: \fIhttp://github\.com/isaacs/npm/issues\fR
152 .
153 .IP "\(bu" 4
154 email: \fInpm\-@googlegroups\.com\fR
b70b2a09 »
2010-05-03 Add built documentation to project, so that the install doesn't requi…
155 .
f2ccd178 »
2010-08-18 Use ronnjs instead of the ronn rubygem to build docs
156 .IP "" 0
2a35c6d0 »
2010-05-03 trim the docs a bit, and organize the changelist
157 .
4ad295c0 »
2010-07-22 make doc
158 .P
f2ccd178 »
2010-08-18 Use ronnjs instead of the ronn rubygem to build docs
159 Be sure to include \fIall\fR of the output from the npm command that didn\'t work
160 as expected\.
b70b2a09 »
2010-05-03 Add built documentation to project, so that the install doesn't requi…
161 .
a3b0aa84 »
2010-09-28 Merge the "help" and "npm" man pages.
162 .P
3703cee2 »
2010-11-26 better manpage docs.
163 You can also look for isaacs in #node\.js on irc://irc\.freenode\.net\. He
164 will no doubt tell you to put the output in a gist or email\.
a3b0aa84 »
2010-09-28 Merge the "help" and "npm" man pages.
165 .
4ad295c0 »
2010-07-22 make doc
166 .SH "HISTORY"
f39ee04c »
2010-11-14 Make doc
167 See npm\-changelog(1)
3703cee2 »
2010-11-26 better manpage docs.
168 .
169 .SH "AUTHOR"
170 Isaac Z\. Schlueter :: isaacs :: @izs :: \fIi@izs\.me\fR
Something went wrong with that request. Please try again.