npm-config.html 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282
  1. <html><head>
  2. <title>npm-config</title>
  3. <style>
  4. body {
  5. background-color: #ffffff;
  6. color: #24292e;
  7. margin: 0;
  8. line-height: 1.5;
  9. font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
  10. }
  11. #rainbar {
  12. height: 10px;
  13. background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
  14. }
  15. a {
  16. text-decoration: none;
  17. color: #0366d6;
  18. }
  19. a:hover {
  20. text-decoration: underline;
  21. }
  22. pre {
  23. margin: 1em 0px;
  24. padding: 1em;
  25. border: solid 1px #e1e4e8;
  26. border-radius: 6px;
  27. display: block;
  28. overflow: auto;
  29. white-space: pre;
  30. background-color: #f6f8fa;
  31. color: #393a34;
  32. }
  33. code {
  34. font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
  35. font-size: 85%;
  36. padding: 0.2em 0.4em;
  37. background-color: #f6f8fa;
  38. color: #393a34;
  39. }
  40. pre > code {
  41. padding: 0;
  42. background-color: inherit;
  43. color: inherit;
  44. }
  45. h1, h2, h3 {
  46. font-weight: 600;
  47. }
  48. #logobar {
  49. background-color: #333333;
  50. margin: 0 auto;
  51. padding: 1em 4em;
  52. }
  53. #logobar .logo {
  54. float: left;
  55. }
  56. #logobar .title {
  57. font-weight: 600;
  58. color: #dddddd;
  59. float: left;
  60. margin: 5px 0 0 1em;
  61. }
  62. #logobar:after {
  63. content: "";
  64. display: block;
  65. clear: both;
  66. }
  67. #content {
  68. margin: 0 auto;
  69. padding: 0 4em;
  70. }
  71. #table_of_contents > h2 {
  72. font-size: 1.17em;
  73. }
  74. #table_of_contents ul:first-child {
  75. border: solid 1px #e1e4e8;
  76. border-radius: 6px;
  77. padding: 1em;
  78. background-color: #f6f8fa;
  79. color: #393a34;
  80. }
  81. #table_of_contents ul {
  82. list-style-type: none;
  83. padding-left: 1.5em;
  84. }
  85. #table_of_contents li {
  86. font-size: 0.9em;
  87. }
  88. #table_of_contents li a {
  89. color: #000000;
  90. }
  91. header.title {
  92. border-bottom: solid 1px #e1e4e8;
  93. }
  94. header.title > h1 {
  95. margin-bottom: 0.25em;
  96. }
  97. header.title > .description {
  98. display: block;
  99. margin-bottom: 0.5em;
  100. line-height: 1;
  101. }
  102. footer#edit {
  103. border-top: solid 1px #e1e4e8;
  104. margin: 3em 0 4em 0;
  105. padding-top: 2em;
  106. }
  107. </style>
  108. </head>
  109. <body>
  110. <div id="banner">
  111. <div id="rainbar"></div>
  112. <div id="logobar">
  113. <svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
  114. <polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
  115. <polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
  116. </svg>
  117. <div class="title">
  118. npm command-line interface
  119. </div>
  120. </div>
  121. </div>
  122. <section id="content">
  123. <header class="title">
  124. <h1 id="npm-config">npm-config</h1>
  125. <span class="description">Manage the npm configuration files</span>
  126. </header>
  127. <section id="table_of_contents">
  128. <h2 id="table-of-contents">Table of contents</h2>
  129. <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></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>
  130. </section>
  131. <div id="_content"><h3 id="synopsis">Synopsis</h3>
  132. <pre lang="bash"><code>npm config set &lt;key&gt;=&lt;value&gt; [&lt;key&gt;=&lt;value&gt; ...]
  133. npm config get [&lt;key&gt; [&lt;key&gt; ...]]
  134. npm config delete &lt;key&gt; [&lt;key&gt; ...]
  135. npm config list [--json]
  136. npm config edit
  137. npm set &lt;key&gt;=&lt;value&gt; [&lt;key&gt;=&lt;value&gt; ...]
  138. npm get [&lt;key&gt; [&lt;key&gt; ...]]
  139. alias: c
  140. </code></pre>
  141. <p>Note: This command is unaware of workspaces.</p>
  142. <h3 id="description">Description</h3>
  143. <p>npm gets its config settings from the command line, environment
  144. variables, <code>npmrc</code> files, and in some cases, the <code>package.json</code> file.</p>
  145. <p>See <a href="../configuring-npm/npmrc.html">npmrc</a> for more information about the npmrc
  146. files.</p>
  147. <p>See <a href="../using-npm/config.html">config(7)</a> for a more thorough explanation of the
  148. mechanisms involved, and a full list of config options available.</p>
  149. <p>The <code>npm config</code> command can be used to update and edit the contents
  150. of the user and global npmrc files.</p>
  151. <h3 id="sub-commands">Sub-commands</h3>
  152. <p>Config supports the following sub-commands:</p>
  153. <h4 id="set">set</h4>
  154. <pre lang="bash"><code>npm config set key=value [key=value...]
  155. npm set key=value [key=value...]
  156. </code></pre>
  157. <p>Sets each of the config keys to the value provided.</p>
  158. <p>If value is omitted, then it sets it to an empty string.</p>
  159. <p>Note: for backwards compatibility, <code>npm config set key value</code> is supported
  160. as an alias for <code>npm config set key=value</code>.</p>
  161. <h4 id="get">get</h4>
  162. <pre lang="bash"><code>npm config get [key ...]
  163. npm get [key ...]
  164. </code></pre>
  165. <p>Echo the config value(s) to stdout.</p>
  166. <p>If multiple keys are provided, then the values will be prefixed with the
  167. key names.</p>
  168. <p>If no keys are provided, then this command behaves the same as <code>npm config list</code>.</p>
  169. <h4 id="list">list</h4>
  170. <pre lang="bash"><code>npm config list
  171. </code></pre>
  172. <p>Show all the config settings. Use <code>-l</code> to also show defaults. Use <code>--json</code>
  173. to show the settings in json format.</p>
  174. <h4 id="delete">delete</h4>
  175. <pre lang="bash"><code>npm config delete key [key ...]
  176. </code></pre>
  177. <p>Deletes the specified keys from all configuration files.</p>
  178. <h4 id="edit2">edit</h4>
  179. <pre lang="bash"><code>npm config edit
  180. </code></pre>
  181. <p>Opens the config file in an editor. Use the <code>--global</code> flag to edit the
  182. global config.</p>
  183. <h3 id="configuration">Configuration</h3>
  184. <!-- raw HTML omitted -->
  185. <!-- raw HTML omitted -->
  186. <!-- raw HTML omitted -->
  187. <h4 id="json"><code>json</code></h4>
  188. <ul>
  189. <li>Default: false</li>
  190. <li>Type: Boolean</li>
  191. </ul>
  192. <p>Whether or not to output JSON data, rather than the normal output.</p>
  193. <ul>
  194. <li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before
  195. saving them to your <code>package.json</code>.</li>
  196. </ul>
  197. <p>Not supported by all npm commands.</p>
  198. <!-- raw HTML omitted -->
  199. <!-- raw HTML omitted -->
  200. <h4 id="global"><code>global</code></h4>
  201. <ul>
  202. <li>Default: false</li>
  203. <li>Type: Boolean</li>
  204. </ul>
  205. <p>Operates in “global” mode, so that packages are installed into the <code>prefix</code>
  206. folder instead of the current working directory. See
  207. <a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p>
  208. <ul>
  209. <li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead
  210. of the current working directory.</li>
  211. <li>bin files are linked to <code>{prefix}/bin</code></li>
  212. <li>man pages are linked to <code>{prefix}/share/man</code></li>
  213. </ul>
  214. <!-- raw HTML omitted -->
  215. <!-- raw HTML omitted -->
  216. <h4 id="editor"><code>editor</code></h4>
  217. <ul>
  218. <li>Default: The EDITOR or VISUAL environment variables, or ‘notepad.exe’ on
  219. Windows, or ‘vim’ on Unix systems</li>
  220. <li>Type: String</li>
  221. </ul>
  222. <p>The command to run for <code>npm edit</code> and <code>npm config edit</code>.</p>
  223. <!-- raw HTML omitted -->
  224. <!-- raw HTML omitted -->
  225. <h4 id="location"><code>location</code></h4>
  226. <ul>
  227. <li>Default: “user” unless <code>--global</code> is passed, which will also set this value
  228. to “global”</li>
  229. <li>Type: “global”, “user”, or “project”</li>
  230. </ul>
  231. <p>When passed to <code>npm config</code> this refers to which config file to use.</p>
  232. <!-- raw HTML omitted -->
  233. <!-- raw HTML omitted -->
  234. <h4 id="long"><code>long</code></h4>
  235. <ul>
  236. <li>Default: false</li>
  237. <li>Type: Boolean</li>
  238. </ul>
  239. <p>Show extended information in <code>ls</code>, <code>search</code>, and <code>help-search</code>.</p>
  240. <!-- raw HTML omitted -->
  241. <!-- raw HTML omitted -->
  242. <!-- raw HTML omitted -->
  243. <h3 id="see-also">See Also</h3>
  244. <ul>
  245. <li><a href="../configuring-npm/folders.html">npm folders</a></li>
  246. <li><a href="../commands/npm-config.html">npm config</a></li>
  247. <li><a href="../configuring-npm/package-json.html">package.json</a></li>
  248. <li><a href="../configuring-npm/npmrc.html">npmrc</a></li>
  249. <li><a href="../commands/npm.html">npm</a></li>
  250. </ul>
  251. </div>
  252. <footer id="edit">
  253. <a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-config.md">
  254. <svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
  255. <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>
  256. </svg>
  257. Edit this page on GitHub
  258. </a>
  259. </footer>
  260. </section>
  261. </body></html>