mirror of
https://github.com/nodejs/node.git
synced 2025-05-13 16:39:33 +00:00
ffc11c6015
PR-URL: https://github.com/nodejs/node/pull/36572 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
101 lines
2.0 KiB
Markdown
101 lines
2.0 KiB
Markdown
---
|
|
title: npm-config
|
|
section: 1
|
|
description: Manage the npm configuration files
|
|
---
|
|
|
|
### Synopsis
|
|
|
|
```bash
|
|
npm config set <key>=<value> [<key>=<value> ...]
|
|
npm config get [<key> [<key> ...]]
|
|
npm config delete <key> [<key> ...]
|
|
npm config list [--json]
|
|
npm config edit
|
|
npm set <key>=<value> [<key>=<value> ...]
|
|
npm get [<key> [<key> ...]]
|
|
|
|
alias: 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](/configuring-npm/npmrc) for more information about the npmrc
|
|
files.
|
|
|
|
See [config(7)](/using-npm/config) for a more thorough explanation of the
|
|
mechanisms involved, and a full list of config options available.
|
|
|
|
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
|
|
|
|
```bash
|
|
npm config set key=value [key=value...]
|
|
npm set key=value [key=value...]
|
|
```
|
|
|
|
Sets each of the config keys to the value provided.
|
|
|
|
If value is omitted, then it sets it to an empty string.
|
|
|
|
Note: for backwards compatibility, `npm config set key value` is supported
|
|
as an alias for `npm config set key=value`.
|
|
|
|
#### get
|
|
|
|
```bash
|
|
npm config get [key ...]
|
|
npm get [key ...]
|
|
```
|
|
|
|
Echo the config value(s) to stdout.
|
|
|
|
If multiple keys are provided, then the values will be prefixed with the
|
|
key names.
|
|
|
|
If no keys are provided, then this command behaves the same as `npm config
|
|
list`.
|
|
|
|
#### list
|
|
|
|
```bash
|
|
npm config list
|
|
```
|
|
|
|
Show all the config settings. Use `-l` to also show defaults. Use `--json`
|
|
to show the settings in json format.
|
|
|
|
#### delete
|
|
|
|
```bash
|
|
npm config delete key [key ...]
|
|
```
|
|
|
|
Deletes the specified keys from all configuration files.
|
|
|
|
#### edit
|
|
|
|
```bash
|
|
npm config edit
|
|
```
|
|
|
|
Opens the config file in an editor. Use the `--global` flag to edit the
|
|
global config.
|
|
|
|
### See Also
|
|
|
|
* [npm folders](/configuring-npm/folders)
|
|
* [npm config](/commands/npm-config)
|
|
* [package.json](/configuring-npm/package-json)
|
|
* [npmrc](/configuring-npm/npmrc)
|
|
* [npm](/commands/npm)
|