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