blob: bf7f9be409e4b3cb2ee552667f5390adaa7fb5e1 (
plain)
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
|
.\" Generated with Ronnjs 0.3.8
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPMRC" "5" "July 2014" "" ""
.
.SH "NAME"
\fBnpmrc\fR \-\- The npm config files
.
.SH "DESCRIPTION"
npm gets its config settings from the command line, environment
variables, and \fBnpmrc\fR files\.
.
.P
The \fBnpm config\fR command can be used to update and edit the contents
of the user and global npmrc files\.
.
.P
npm help For a list of available configuration options, see npm\-config\.
.
.SH "FILES"
The four relevant files are:
.
.IP "\(bu" 4
per\-project config file (/path/to/my/project/\.npmrc)
.
.IP "\(bu" 4
per\-user config file (~/\.npmrc)
.
.IP "\(bu" 4
global config file ($PREFIX/npmrc)
.
.IP "\(bu" 4
npm builtin config file (/path/to/npm/npmrc)
.
.IP "" 0
.
.P
All npm config files are an ini\-formatted list of \fBkey = value\fR
parameters\. Environment variables can be replaced using \fB${VARIABLE_NAME}\fR\|\. For example:
.
.IP "" 4
.
.nf
prefix = ${HOME}/\.npm\-packages
.
.fi
.
.IP "" 0
.
.P
Each of these files is loaded, and config options are resolved in
priority order\. For example, a setting in the userconfig file would
override the setting in the globalconfig file\.
.
.SS "Per\-project config file"
When working locally in a project, a \fB\|\.npmrc\fR file in the root of the
project (ie, a sibling of \fBnode_modules\fR and \fBpackage\.json\fR) will set
config values specific to this project\.
.
.P
Note that this only applies to the root of the project that you\'re
running npm in\. It has no effect when your module is published\. For
example, you can\'t publish a module that forces itself to install
globally, or in a different location\.
.
.SS "Per\-user config file"
\fB$HOME/\.npmrc\fR (or the \fBuserconfig\fR param, if set in the environment
or on the command line)
.
.SS "Global config file"
\fB$PREFIX/etc/npmrc\fR (or the \fBglobalconfig\fR param, if set above):
This file is an ini\-file formatted list of \fBkey = value\fR parameters\.
Environment variables can be replaced as above\.
.
.SS "Built\-in config file"
\fBpath/to/npm/itself/npmrc\fR
.
.P
This is an unchangeable "builtin" configuration file that npm keeps
consistent across updates\. Set fields in here using the \fB\|\./configure\fR
script that comes with npm\. This is primarily for distribution
maintainers to override default configs in a standard and consistent
manner\.
.
.SH "SEE ALSO"
.
.IP "\(bu" 4
npm help folders
.
.IP "\(bu" 4
npm help config
.
.IP "\(bu" 4
npm help config
.
.IP "\(bu" 4
npm help package\.json
.
.IP "\(bu" 4
npm help npm
.
.IP "" 0
|
