summaryrefslogtreecommitdiff
path: root/deps/npm/doc/cli/npm-config.md
blob: c60afc167c7420f8c00a467842c3f8780e89aa12 (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
npm-config(1) -- Manage the npm configuration files
===================================================

## SYNOPSIS

    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

## DESCRIPTION

npm gets its config settings from the command line, environment
variables, `npmrc` files, and in some cases, the `package.json` file.

See npmrc(5) for more information about the npmrc files.

See `npm-config(7)` for a more thorough discussion of the mechanisms
involved.

The `npm config` command can be used to update and edit the contents
of the user and global npmrc files.

## Sub-commands

Config supports the following sub-commands:

### set

    npm config set key value

Sets the config key to the value.

If value is omitted, then it sets it to "true".

### get

    npm config get key

Echo the config value to stdout.

### list

    npm config list

Show all the config settings. Use `-l` to also show defaults. Use `--json`
to show the settings in json format.

### delete

    npm config delete key

Deletes the key from all configuration files.

### edit

    npm config edit

Opens the config file in an editor.  Use the `--global` flag to edit the
global config.

## SEE ALSO

* npm-folders(5)
* npm-config(7)
* package.json(5)
* npmrc(5)
* npm(1)