summaryrefslogtreecommitdiff
path: root/deps/npm/man/man1/npm-config.1
blob: 81c797a1211cd87031215f57eb514324e91e5761 (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
.TH "NPM\-CONFIG" "1" "December 2018" "" ""
.SH "NAME"
\fBnpm-config\fR \- Manage the npm configuration files
.SH SYNOPSIS
.P
.RS 2
.nf
npm config set <key> <value> [\-g|\-\-global]
npm config get <key>
npm config delete <key>
npm config list [\-l] [\-\-json]
npm config edit
npm get <key>
npm set <key> <value> [\-g|\-\-global]

aliases: c
.fi
.RE
.SH DESCRIPTION
.P
npm gets its config settings from the command line, environment
variables, \fBnpmrc\fP files, and in some cases, the \fBpackage\.json\fP file\.
.P
See npm help 5 npmrc for more information about the npmrc files\.
.P
See npm help 7 \fBnpm\-config\fP for a more thorough discussion of the mechanisms
involved\.
.P
The \fBnpm config\fP command can be used to update and edit the contents
of the user and global npmrc files\.
.SH Sub\-commands
.P
Config supports the following sub\-commands:
.SS set
.P
.RS 2
.nf
npm config set key value
.fi
.RE
.P
Sets the config key to the value\.
.P
If value is omitted, then it sets it to "true"\.
.SS get
.P
.RS 2
.nf
npm config get key
.fi
.RE
.P
Echo the config value to stdout\.
.SS list
.P
.RS 2
.nf
npm config list
.fi
.RE
.P
Show all the config settings\. Use \fB\-l\fP to also show defaults\. Use \fB\-\-json\fP
to show the settings in json format\.
.SS delete
.P
.RS 2
.nf
npm config delete key
.fi
.RE
.P
Deletes the key from all configuration files\.
.SS edit
.P
.RS 2
.nf
npm config edit
.fi
.RE
.P
Opens the config file in an editor\.  Use the \fB\-\-global\fP flag to edit the
global config\.
.SH SEE ALSO
.RS 0
.IP \(bu 2
npm help 5 folders
.IP \(bu 2
npm help 7 config
.IP \(bu 2
npm help 5 package\.json
.IP \(bu 2
npm help 5 npmrc
.IP \(bu 2
npm help npm

.RE