Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages


home | help
NPMRC(5)							      NPMRC(5)

       npmrc - The npm config files

       npm  gets  its config settings from the command line, environment vari-
       ables, and npmrc	files.

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

       For a list of available configuration options, see npm help 7 config.

       The four	relevant files are:

       o per-project config file (/path/to/my/project/.npmrc)

       o per-user config file (~/.npmrc)

       o global	config file ($PREFIX/etc/npmrc)

       o npm builtin config file (/path/to/npm/npmrc)

       All  npm	 config	files are an ini-formatted list	of key = value parame-
       ters.  Environment variables can	be  replaced  using  ${VARIABLE_NAME}.
       For example:

	 prefix	= ${HOME}/.npm-packages

       Each  of	these files is loaded, and config options are resolved in pri-
       ority order.  For example, a setting in the userconfig file would over-
       ride the	setting	in the globalconfig file.

       Array values are	specified by adding "[]" after the key name. For exam-

	 key[] = "first	value"
	 key[] = "second value"

       Lines in	.npmrc files are interpreted as	comments when they begin  with
       a   ;   or   #	character.   .npmrc   files   are  parsed  by  npm/ini, which specifies this	comment	syntax.

       For example:

	 # last	modified: 01 Jan 2016
	 ; Set a new registry for a scoped package

   Per-project config file
       When working locally in a project, a .npmrc file	in  the	 root  of  the
       project	(ie, a sibling of node_modules and package.json) will set con-
       fig values specific to this project.

       Note that this only applies to the root of the project that you're run-
       ning  npm in.  It has no	effect when your module	is published.  For ex-
       ample, you can't	publish	a module that forces itself to	install	 glob-
       ally, or	in a different location.

       Additionally,  this  file is not	read in	global mode, such as when run-
       ning npm	install	-g.

   Per-user config file
       $HOME/.npmrc (or	the userconfig param, if set in	the environment	or  on
       the command line)

   Global config file
       $PREFIX/etc/npmrc  (or the globalconfig param, if set above): This file
       is an ini-file formatted	list of	key = value  parameters.   Environment
       variables can be	replaced as above.

   Built-in config file

       This  is	 an  unchangeable  "builtin" configuration file	that npm keeps
       consistent across updates.  Set fields in here  using  the  ./configure
       script  that  comes with	npm.  This is primarily	for distribution main-
       tainers to override default configs in a	standard and  consistent  man-

       o npm help 5 folders

       o npm help config

       o npm help 7 config

       o npm help 5 package.json

       o npm help npm

				 October 2019			      NPMRC(5)


Want to link to this manual page? Use this URL:

home | help