npm-config.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331
  1. <!DOCTYPE html><html><head>
  2. <meta charset="utf-8">
  3. <title>npm-config</title>
  4. <style>
  5. body {
  6. background-color: #ffffff;
  7. color: #24292e;
  8. margin: 0;
  9. line-height: 1.5;
  10. font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
  11. }
  12. #rainbar {
  13. height: 10px;
  14. background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
  15. }
  16. a {
  17. text-decoration: none;
  18. color: #0366d6;
  19. }
  20. a:hover {
  21. text-decoration: underline;
  22. }
  23. pre {
  24. margin: 1em 0px;
  25. padding: 1em;
  26. border: solid 1px #e1e4e8;
  27. border-radius: 6px;
  28. display: block;
  29. overflow: auto;
  30. white-space: pre;
  31. background-color: #f6f8fa;
  32. color: #393a34;
  33. }
  34. code {
  35. font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
  36. font-size: 85%;
  37. padding: 0.2em 0.4em;
  38. background-color: #f6f8fa;
  39. color: #393a34;
  40. }
  41. pre > code {
  42. padding: 0;
  43. background-color: inherit;
  44. color: inherit;
  45. }
  46. h1, h2, h3 {
  47. font-weight: 600;
  48. }
  49. #logobar {
  50. background-color: #333333;
  51. margin: 0 auto;
  52. padding: 1em 4em;
  53. }
  54. #logobar .logo {
  55. float: left;
  56. }
  57. #logobar .title {
  58. font-weight: 600;
  59. color: #dddddd;
  60. float: left;
  61. margin: 5px 0 0 1em;
  62. }
  63. #logobar:after {
  64. content: "";
  65. display: block;
  66. clear: both;
  67. }
  68. #content {
  69. margin: 0 auto;
  70. padding: 0 4em;
  71. }
  72. #table_of_contents > h2 {
  73. font-size: 1.17em;
  74. }
  75. #table_of_contents ul:first-child {
  76. border: solid 1px #e1e4e8;
  77. border-radius: 6px;
  78. padding: 1em;
  79. background-color: #f6f8fa;
  80. color: #393a34;
  81. }
  82. #table_of_contents ul {
  83. list-style-type: none;
  84. padding-left: 1.5em;
  85. }
  86. #table_of_contents li {
  87. font-size: 0.9em;
  88. }
  89. #table_of_contents li a {
  90. color: #000000;
  91. }
  92. header.title {
  93. border-bottom: solid 1px #e1e4e8;
  94. }
  95. header.title > h1 {
  96. margin-bottom: 0.25em;
  97. }
  98. header.title > .description {
  99. display: block;
  100. margin-bottom: 0.5em;
  101. line-height: 1;
  102. }
  103. header.title .version {
  104. font-size: 0.8em;
  105. color: #666666;
  106. }
  107. footer#edit {
  108. border-top: solid 1px #e1e4e8;
  109. margin: 3em 0 4em 0;
  110. padding-top: 2em;
  111. }
  112. table {
  113. width: 100%;
  114. margin: 1em 0;
  115. border-radius: 6px;
  116. border: 1px solid #e1e4e8;
  117. overflow: hidden;
  118. border-collapse: separate;
  119. border-spacing: 0;
  120. }
  121. table thead {
  122. background-color: #f6f8fa;
  123. }
  124. table tbody {
  125. background-color: #ffffff;
  126. }
  127. table th,
  128. table td {
  129. padding: 0.75em;
  130. text-align: left;
  131. border-right: 1px solid #e1e4e8;
  132. border-bottom: 1px solid #e1e4e8;
  133. }
  134. table th:last-child,
  135. table td:last-child {
  136. border-right: none;
  137. }
  138. table tbody tr:last-child td {
  139. border-bottom: none;
  140. }
  141. table th {
  142. font-weight: 600;
  143. background-color: #f6f8fa;
  144. }
  145. table code {
  146. white-space: nowrap;
  147. }
  148. </style>
  149. </head>
  150. <body>
  151. <div id="banner">
  152. <div id="rainbar"></div>
  153. <div id="logobar">
  154. <svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
  155. <polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
  156. <polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
  157. </svg>
  158. <div class="title">
  159. npm command-line interface
  160. </div>
  161. </div>
  162. </div>
  163. <section id="content">
  164. <header class="title">
  165. <h1 id="----npm-config----11120">
  166. <span>npm-config</span>
  167. <span class="version">@11.12.0</span>
  168. </h1>
  169. <span class="description">Manage the npm configuration files</span>
  170. </header>
  171. <section id="table_of_contents">
  172. <h2 id="table-of-contents">Table of contents</h2>
  173. <div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#sub-commands">Sub-commands</a></li><ul><li><a href="#set">set</a></li><li><a href="#get">get</a></li><li><a href="#list">list</a></li><li><a href="#delete">delete</a></li><li><a href="#edit2">edit</a></li><li><a href="#fix">fix</a></li></ul><li><a href="#configuration">Configuration</a></li><ul><li><a href="#json"><code>json</code></a></li><li><a href="#global"><code>global</code></a></li><li><a href="#editor"><code>editor</code></a></li><li><a href="#location"><code>location</code></a></li><li><a href="#long"><code>long</code></a></li></ul><li><a href="#see-also">See Also</a></li></ul></div>
  174. </section>
  175. <div id="_content"><h3 id="synopsis">Synopsis</h3>
  176. <pre><code class="language-bash">npm config set &lt;key&gt;=&lt;value&gt; [&lt;key&gt;=&lt;value&gt; ...]
  177. npm config get [&lt;key&gt; [&lt;key&gt; ...]]
  178. npm config delete &lt;key&gt; [&lt;key&gt; ...]
  179. npm config list [--json]
  180. npm config edit
  181. npm config fix
  182. alias: c
  183. </code></pre>
  184. <p>Note: This command is unaware of workspaces.</p>
  185. <h3 id="description">Description</h3>
  186. <p>npm gets its config settings from the command line, environment variables, <code>npmrc</code> files, and in some cases, the <code>package.json</code> file.</p>
  187. <p>See <a href="../configuring-npm/npmrc.html">npmrc</a> for more information about the npmrc files.</p>
  188. <p>See <a href="../using-npm/config.html">config</a> for a more thorough explanation of the mechanisms involved, and a full list of config options available.</p>
  189. <p>The <code>npm config</code> command can be used to update and edit the contents of the user and global npmrc files.</p>
  190. <h3 id="sub-commands">Sub-commands</h3>
  191. <p>Config supports the following sub-commands:</p>
  192. <h4 id="set">set</h4>
  193. <pre><code class="language-bash">npm config set key=value [key=value...]
  194. npm set key=value [key=value...]
  195. </code></pre>
  196. <p>Sets each of the config keys to the value provided.
  197. Modifies the user configuration file unless <a href="../commands/npm-config#location.html"><code>location</code></a> is passed.</p>
  198. <p>If value is omitted, the key will be removed from your config file entirely.</p>
  199. <p>Note: for backwards compatibility, <code>npm config set key value</code> is supported as an alias for <code>npm config set key=value</code>.</p>
  200. <h4 id="get">get</h4>
  201. <pre><code class="language-bash">npm config get [key ...]
  202. npm get [key ...]
  203. </code></pre>
  204. <p>Echo the config value(s) to stdout.</p>
  205. <p>If multiple keys are provided, then the values will be prefixed with the key names.</p>
  206. <p>If no keys are provided, then this command behaves the same as <code>npm config list</code>.</p>
  207. <h4 id="list">list</h4>
  208. <pre><code class="language-bash">npm config list
  209. </code></pre>
  210. <p>Show all the config settings.
  211. Use <code>-l</code> to also show defaults.
  212. Use <code>--json</code> to show the settings in json format.</p>
  213. <h4 id="delete">delete</h4>
  214. <pre><code class="language-bash">npm config delete key [key ...]
  215. </code></pre>
  216. <p>Deletes the specified keys from all configuration files.</p>
  217. <h4 id="edit2">edit</h4>
  218. <pre><code class="language-bash">npm config edit
  219. </code></pre>
  220. <p>Opens the config file in an editor.
  221. Use the <code>--global</code> flag to edit the global config.</p>
  222. <h4 id="fix">fix</h4>
  223. <pre><code class="language-bash">npm config fix
  224. </code></pre>
  225. <p>Attempts to repair invalid configuration items.
  226. Usually this means attaching authentication config (i.e.
  227. <code>_auth</code>, <code>_authToken</code>) to the configured <code>registry</code>.</p>
  228. <h3 id="configuration">Configuration</h3>
  229. <h4 id="json"><code>json</code></h4>
  230. <ul>
  231. <li>Default: false</li>
  232. <li>Type: Boolean</li>
  233. </ul>
  234. <p>Whether or not to output JSON data, rather than the normal output.</p>
  235. <ul>
  236. <li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before
  237. saving them to your <code>package.json</code>.</li>
  238. </ul>
  239. <p>Not supported by all npm commands.</p>
  240. <h4 id="global"><code>global</code></h4>
  241. <ul>
  242. <li>Default: false</li>
  243. <li>Type: Boolean</li>
  244. </ul>
  245. <p>Operates in "global" mode, so that packages are installed into the <code>prefix</code>
  246. folder instead of the current working directory. See
  247. <a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p>
  248. <ul>
  249. <li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead
  250. of the current working directory.</li>
  251. <li>bin files are linked to <code>{prefix}/bin</code></li>
  252. <li>man pages are linked to <code>{prefix}/share/man</code></li>
  253. </ul>
  254. <h4 id="editor"><code>editor</code></h4>
  255. <ul>
  256. <li>Default: The EDITOR or VISUAL environment variables, or
  257. '%SYSTEMROOT%\notepad.exe' on Windows, or 'vi' on Unix systems</li>
  258. <li>Type: String</li>
  259. </ul>
  260. <p>The command to run for <code>npm edit</code> and <code>npm config edit</code>.</p>
  261. <h4 id="location"><code>location</code></h4>
  262. <ul>
  263. <li>Default: "user" unless <code>--global</code> is passed, which will also set this value
  264. to "global"</li>
  265. <li>Type: "global", "user", or "project"</li>
  266. </ul>
  267. <p>When passed to <code>npm config</code> this refers to which config file to use.</p>
  268. <p>When set to "global" mode, packages are installed into the <code>prefix</code> folder
  269. instead of the current working directory. See
  270. <a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p>
  271. <ul>
  272. <li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead
  273. of the current working directory.</li>
  274. <li>bin files are linked to <code>{prefix}/bin</code></li>
  275. <li>man pages are linked to <code>{prefix}/share/man</code></li>
  276. </ul>
  277. <h4 id="long"><code>long</code></h4>
  278. <ul>
  279. <li>Default: false</li>
  280. <li>Type: Boolean</li>
  281. </ul>
  282. <p>Show extended information in <code>ls</code>, <code>search</code>, and <code>help-search</code>.</p>
  283. <h3 id="see-also">See Also</h3>
  284. <ul>
  285. <li><a href="../configuring-npm/folders.html">npm folders</a></li>
  286. <li><a href="../commands/npm-config.html">npm config</a></li>
  287. <li><a href="../configuring-npm/package-json.html">package.json</a></li>
  288. <li><a href="../configuring-npm/npmrc.html">npmrc</a></li>
  289. <li><a href="../commands/npm.html">npm</a></li>
  290. </ul></div>
  291. <footer id="edit">
  292. <a href="https://github.com/npm/cli/edit/latest/docs/lib/content/commands/npm-config.md">
  293. <svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
  294. <path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path>
  295. </svg>
  296. Edit this page on GitHub
  297. </a>
  298. </footer>
  299. </section>
  300. </body></html>