Accueil Explorer Aide
Connexion
xusl
/
pfr
1
0
Fork 0
Fichiers Tickets 0 Pull Requests 0 Wiki
Aborescence: d390c15285
Branches Tags
pfr
/
ui
/
node
/
node_modules
/
npm
/
docs
/
output
/
using-npm
/
config.html

config.html 76 KB
Historique Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806 
  1. <html><head>
    2. 

  2. <title>config</title>
    3. 

  3. <style>
    4. 

  4. body {
    5. 

  5.     background-color: #ffffff;
    6. 

  6.     color: #24292e;
    7. 

  7. 

  8.     margin: 0;
    9. 

  9. 

  10.     line-height: 1.5;
    11. 

  11. 

  12.     font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
    13. 

  13. }
    14. 

  14. #rainbar {
    15. 

  15.     height: 10px;
    16. 

  16.     background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
    17. 

  17. }
    18. 

  18. 

  19. a {
    20. 

  20.     text-decoration: none;
    21. 

  21.     color: #0366d6;
    22. 

  22. }
    23. 

  23. a:hover {
    24. 

  24.     text-decoration: underline;
    25. 

  25. }
    26. 

  26. 

  27. pre {
    28. 

  28.     margin: 1em 0px;
    29. 

  29.     padding: 1em;
    30. 

  30.     border: solid 1px #e1e4e8;
    31. 

  31.     border-radius: 6px;
    32. 

  32. 

  33.     display: block;
    34. 

  34.     overflow: auto;
    35. 

  35. 

  36.     white-space: pre;
    37. 

  37. 

  38.     background-color: #f6f8fa;
    39. 

  39.     color: #393a34;
    40. 

  40. }
    41. 

  41. code {
    42. 

  42.     font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
    43. 

  43.     font-size: 85%;
    44. 

  44.     padding: 0.2em 0.4em;
    45. 

  45.     background-color: #f6f8fa;
    46. 

  46.     color: #393a34;
    47. 

  47. }
    48. 

  48. pre > code {
    49. 

  49.     padding: 0;
    50. 

  50.     background-color: inherit;
    51. 

  51.     color: inherit;
    52. 

  52. }
    53. 

  53. h1, h2, h3 {
    54. 

  54.     font-weight: 600;
    55. 

  55. }
    56. 

  56. 

  57. #logobar {
    58. 

  58.     background-color: #333333;
    59. 

  59.     margin: 0 auto;
    60. 

  60.     padding: 1em 4em;
    61. 

  61. }
    62. 

  62. #logobar .logo {
    63. 

  63.     float: left;
    64. 

  64. }
    65. 

  65. #logobar .title {
    66. 

  66.     font-weight: 600;
    67. 

  67.     color: #dddddd;
    68. 

  68.     float: left;
    69. 

  69.     margin: 5px 0 0 1em;
    70. 

  70. }
    71. 

  71. #logobar:after {
    72. 

  72.     content: "";
    73. 

  73.     display: block;
    74. 

  74.     clear: both;
    75. 

  75. }
    76. 

  76. 

  77. #content {
    78. 

  78.     margin: 0 auto;
    79. 

  79.     padding: 0 4em;
    80. 

  80. }
    81. 

  81. 

  82. #table_of_contents > h2 {
    83. 

  83.     font-size: 1.17em;
    84. 

  84. }
    85. 

  85. #table_of_contents ul:first-child {
    86. 

  86.     border: solid 1px #e1e4e8;
    87. 

  87.     border-radius: 6px;
    88. 

  88.     padding: 1em;
    89. 

  89.     background-color: #f6f8fa;
    90. 

  90.     color: #393a34;
    91. 

  91. }
    92. 

  92. #table_of_contents ul {
    93. 

  93.     list-style-type: none;
    94. 

  94.     padding-left: 1.5em;
    95. 

  95. }
    96. 

  96. #table_of_contents li {
    97. 

  97.     font-size: 0.9em;
    98. 

  98. }
    99. 

  99. #table_of_contents li a {
    100. 

  100.     color: #000000;
    101. 

  101. }
    102. 

  102. 

  103. header.title {
    104. 

  104.     border-bottom: solid 1px #e1e4e8;
    105. 

  105. }
    106. 

  106. header.title > h1 {
    107. 

  107.     margin-bottom: 0.25em;
    108. 

  108. }
    109. 

  109. header.title > .description {
    110. 

  110.     display: block;
    111. 

  111.     margin-bottom: 0.5em;
    112. 

  112.     line-height: 1;
    113. 

  113. }
    114. 

  114. 

  115. footer#edit {
    116. 

  116.     border-top: solid 1px #e1e4e8;
    117. 

  117.     margin: 3em 0 4em 0;
    118. 

  118.     padding-top: 2em;
    119. 

  119. }
    120. 

  120. </style>
    121. 

  121. </head>
    122. 

  122. <body>
    123. 

  123. <div id="banner">
    124. 

  124. <div id="rainbar"></div>
    125. 

  125. <div id="logobar">
    126. 

  126. <svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
    127. 

  127. <polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
    128. 

  128. <polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
    129. 

  129. </svg>
    130. 

  130. <div class="title">
    131. 

  131. npm command-line interface
    132. 

  132. </div>
    133. 

  133. </div>
    134. 

  134. </div>
    135. 

  135. 

  136. <section id="content">
    137. 

  137. <header class="title">
    138. 

  138. <h1 id="config">config</h1>
    139. 

  139. <span class="description">More than you probably want to know about npm configuration</span>
    140. 

  140. </header>
    141. 

  141. 

  142. <section id="table_of_contents">
    143. 

  143. <h2 id="table-of-contents">Table of contents</h2>
    144. 

  144. <div id="_table_of_contents"><ul><li><a href="#description">Description</a></li><ul><li><a href="#command-line-flags">Command Line Flags</a></li><li><a href="#environment-variables">Environment Variables</a></li><li><a href="#npmrc-files">npmrc Files</a></li><li><a href="#default-configs">Default Configs</a></li></ul><li><a href="#shorthands-and-other-cli-niceties">Shorthands and Other CLI Niceties</a></li><li><a href="#config-settings">Config Settings</a></li><ul><li><a href="#auth"><code>_auth</code></a></li><li><a href="#access"><code>access</code></a></li><li><a href="#all"><code>all</code></a></li><li><a href="#allow-same-version"><code>allow-same-version</code></a></li><li><a href="#audit"><code>audit</code></a></li><li><a href="#audit-level"><code>audit-level</code></a></li><li><a href="#before"><code>before</code></a></li><li><a href="#bin-links"><code>bin-links</code></a></li><li><a href="#browser"><code>browser</code></a></li><li><a href="#ca"><code>ca</code></a></li><li><a href="#cache"><code>cache</code></a></li><li><a href="#cafile"><code>cafile</code></a></li><li><a href="#call"><code>call</code></a></li><li><a href="#cert"><code>cert</code></a></li><li><a href="#ci-name"><code>ci-name</code></a></li><li><a href="#cidr"><code>cidr</code></a></li><li><a href="#color"><code>color</code></a></li><li><a href="#commit-hooks"><code>commit-hooks</code></a></li><li><a href="#depth"><code>depth</code></a></li><li><a href="#description2"><code>description</code></a></li><li><a href="#diff"><code>diff</code></a></li><li><a href="#diff-dst-prefix"><code>diff-dst-prefix</code></a></li><li><a href="#diff-ignore-all-space"><code>diff-ignore-all-space</code></a></li><li><a href="#diff-name-only"><code>diff-name-only</code></a></li><li><a href="#diff-no-prefix"><code>diff-no-prefix</code></a></li><li><a href="#diff-src-prefix"><code>diff-src-prefix</code></a></li><li><a href="#diff-text"><code>diff-text</code></a></li><li><a href="#diff-unified"><code>diff-unified</code></a></li><li><a href="#dry-run"><code>dry-run</code></a></li><li><a href="#editor"><code>editor</code></a></li><li><a href="#engine-strict"><code>engine-strict</code></a></li><li><a href="#fetch-retries"><code>fetch-retries</code></a></li><li><a href="#fetch-retry-factor"><code>fetch-retry-factor</code></a></li><li><a href="#fetch-retry-maxtimeout"><code>fetch-retry-maxtimeout</code></a></li><li><a href="#fetch-retry-mintimeout"><code>fetch-retry-mintimeout</code></a></li><li><a href="#fetch-timeout"><code>fetch-timeout</code></a></li><li><a href="#force"><code>force</code></a></li><li><a href="#foreground-scripts"><code>foreground-scripts</code></a></li><li><a href="#format-package-lock"><code>format-package-lock</code></a></li><li><a href="#fund"><code>fund</code></a></li><li><a href="#git"><code>git</code></a></li><li><a href="#git-tag-version"><code>git-tag-version</code></a></li><li><a href="#global"><code>global</code></a></li><li><a href="#global-style"><code>global-style</code></a></li><li><a href="#globalconfig"><code>globalconfig</code></a></li><li><a href="#heading"><code>heading</code></a></li><li><a href="#https-proxy"><code>https-proxy</code></a></li><li><a href="#if-present"><code>if-present</code></a></li><li><a href="#ignore-scripts"><code>ignore-scripts</code></a></li><li><a href="#include"><code>include</code></a></li><li><a href="#include-staged"><code>include-staged</code></a></li><li><a href="#include-workspace-root"><code>include-workspace-root</code></a></li><li><a href="#init-author-email"><code>init-author-email</code></a></li><li><a href="#init-author-name"><code>init-author-name</code></a></li><li><a href="#init-author-url"><code>init-author-url</code></a></li><li><a href="#init-license"><code>init-license</code></a></li><li><a href="#init-module"><code>init-module</code></a></li><li><a href="#init-version"><code>init-version</code></a></li><li><a href="#json"><code>json</code></a></li><li><a href="#key"><code>key</code></a></li><li><a href="#legacy-bundling"><code>legacy-bundling</code></a></li><li><a href="#legacy-peer-deps"><code>legacy-peer-deps</code></a></li><li><a href="#link"><code>link</code></a></li><li><a href="#local-address"><code>local-address</code></a></li><li><a href="#location"><code>location</code></a></li><li><a href="#lockfile-version"><code>lockfile-version</code></a></li><li><a href="#loglevel"><code>loglevel</code></a></li><li><a href="#logs-max"><code>logs-max</code></a></li><li><a href="#long"><code>long</code></a></li><li><a href="#maxsockets"><code>maxsockets</code></a></li><li><a href="#message"><code>message</code></a></li><li><a href="#node-options"><code>node-options</code></a></li><li><a href="#node-version"><code>node-version</code></a></li><li><a href="#noproxy"><code>noproxy</code></a></li><li><a href="#npm-version"><code>npm-version</code></a></li><li><a href="#offline"><code>offline</code></a></li><li><a href="#omit"><code>omit</code></a></li><li><a href="#otp"><code>otp</code></a></li><li><a href="#pack-destination"><code>pack-destination</code></a></li><li><a href="#package"><code>package</code></a></li><li><a href="#package-lock"><code>package-lock</code></a></li><li><a href="#package-lock-only"><code>package-lock-only</code></a></li><li><a href="#parseable"><code>parseable</code></a></li><li><a href="#prefer-offline"><code>prefer-offline</code></a></li><li><a href="#prefer-online"><code>prefer-online</code></a></li><li><a href="#prefix"><code>prefix</code></a></li><li><a href="#preid"><code>preid</code></a></li><li><a href="#progress"><code>progress</code></a></li><li><a href="#proxy"><code>proxy</code></a></li><li><a href="#read-only"><code>read-only</code></a></li><li><a href="#rebuild-bundle"><code>rebuild-bundle</code></a></li><li><a href="#registry"><code>registry</code></a></li><li><a href="#save"><code>save</code></a></li><li><a href="#save-bundle"><code>save-bundle</code></a></li><li><a href="#save-dev"><code>save-dev</code></a></li><li><a href="#save-exact"><code>save-exact</code></a></li><li><a href="#save-optional"><code>save-optional</code></a></li><li><a href="#save-peer"><code>save-peer</code></a></li><li><a href="#save-prefix"><code>save-prefix</code></a></li><li><a href="#save-prod"><code>save-prod</code></a></li><li><a href="#scope"><code>scope</code></a></li><li><a href="#script-shell"><code>script-shell</code></a></li><li><a href="#searchexclude"><code>searchexclude</code></a></li><li><a href="#searchlimit"><code>searchlimit</code></a></li><li><a href="#searchopts"><code>searchopts</code></a></li><li><a href="#searchstaleness"><code>searchstaleness</code></a></li><li><a href="#shell"><code>shell</code></a></li><li><a href="#sign-git-commit"><code>sign-git-commit</code></a></li><li><a href="#sign-git-tag"><code>sign-git-tag</code></a></li><li><a href="#strict-peer-deps"><code>strict-peer-deps</code></a></li><li><a href="#strict-ssl"><code>strict-ssl</code></a></li><li><a href="#tag"><code>tag</code></a></li><li><a href="#tag-version-prefix"><code>tag-version-prefix</code></a></li><li><a href="#timing"><code>timing</code></a></li><li><a href="#umask"><code>umask</code></a></li><li><a href="#unicode"><code>unicode</code></a></li><li><a href="#update-notifier"><code>update-notifier</code></a></li><li><a href="#usage"><code>usage</code></a></li><li><a href="#user-agent"><code>user-agent</code></a></li><li><a href="#userconfig"><code>userconfig</code></a></li><li><a href="#version"><code>version</code></a></li><li><a href="#versions"><code>versions</code></a></li><li><a href="#viewer"><code>viewer</code></a></li><li><a href="#which"><code>which</code></a></li><li><a href="#workspace"><code>workspace</code></a></li><li><a href="#workspaces"><code>workspaces</code></a></li><li><a href="#yes"><code>yes</code></a></li><li><a href="#also"><code>also</code></a></li><li><a href="#auth-type"><code>auth-type</code></a></li><li><a href="#cache-max"><code>cache-max</code></a></li><li><a href="#cache-min"><code>cache-min</code></a></li><li><a href="#dev"><code>dev</code></a></li><li><a href="#initauthoremail"><code>init.author.email</code></a></li><li><a href="#initauthorname"><code>init.author.name</code></a></li><li><a href="#initauthorurl"><code>init.author.url</code></a></li><li><a href="#initlicense"><code>init.license</code></a></li><li><a href="#initmodule"><code>init.module</code></a></li><li><a href="#initversion"><code>init.version</code></a></li><li><a href="#only"><code>only</code></a></li><li><a href="#optional"><code>optional</code></a></li><li><a href="#production"><code>production</code></a></li><li><a href="#shrinkwrap"><code>shrinkwrap</code></a></li><li><a href="#sso-poll-frequency"><code>sso-poll-frequency</code></a></li><li><a href="#sso-type"><code>sso-type</code></a></li><li><a href="#tmp"><code>tmp</code></a></li></ul><li><a href="#see-also">See also</a></li></ul></div>
    145. 

  145. </section>
    146. 

  146. 

  147. <div id="_content"><h3 id="description">Description</h3>
    148. 

  148. <p>npm gets its configuration values from the following sources, sorted by priority:</p>
    149. 

  149. <h4 id="command-line-flags">Command Line Flags</h4>
    150. 

  150. <p>Putting <code>--foo bar</code> on the command line sets the <code>foo</code> configuration
    151. 

  151. parameter to <code>"bar"</code>.  A <code>--</code> argument tells the cli parser to stop
    152. 

  152. reading flags.  Using <code>--flag</code> without specifying any value will set
    153. 

  153. the value to <code>true</code>.</p>
    154. 

  154. <p>Example: <code>--flag1 --flag2</code> will set both configuration parameters
    155. 

  155. to <code>true</code>, while <code>--flag1 --flag2 bar</code> will set <code>flag1</code> to <code>true</code>,
    156. 

  156. and <code>flag2</code> to <code>bar</code>.  Finally, <code>--flag1 --flag2 -- bar</code> will set
    157. 

  157. both configuration parameters to <code>true</code>, and the <code>bar</code> is taken
    158. 

  158. as a command argument.</p>
    159. 

  159. <h4 id="environment-variables">Environment Variables</h4>
    160. 

  160. <p>Any environment variables that start with <code>npm_config_</code> will be
    161. 

  161. interpreted as a configuration parameter.  For example, putting
    162. 

  162. <code>npm_config_foo=bar</code> in your environment will set the <code>foo</code>
    163. 

  163. configuration parameter to <code>bar</code>.  Any environment configurations that
    164. 

  164. are not given a value will be given the value of <code>true</code>.  Config
    165. 

  165. values are case-insensitive, so <code>NPM_CONFIG_FOO=bar</code> will work the
    166. 

  166. same. However, please note that inside <a href="../using-npm/scripts.html"><code>scripts</code></a>
    167. 

  167. npm will set its own environment variables and Node will prefer
    168. 

  168. those lowercase versions over any uppercase ones that you might set.
    169. 

  169. For details see <a href="https://github.com/npm/npm/issues/14528">this issue</a>.</p>
    170. 

  170. <p>Notice that you need to use underscores instead of dashes, so <code>--allow-same-version</code>
    171. 

  171. would become <code>npm_config_allow_same_version=true</code>.</p>
    172. 

  172. <h4 id="npmrc-files">npmrc Files</h4>
    173. 

  173. <p>The four relevant files are:</p>
    174. 

  174. <ul>
    175. 

  175. <li>per-project configuration file (<code>/path/to/my/project/.npmrc</code>)</li>
    176. 

  176. <li>per-user configuration file (defaults to <code>$HOME/.npmrc</code>; configurable via CLI
    177. 

  177. option <code>--userconfig</code> or environment variable <code>$NPM_CONFIG_USERCONFIG</code>)</li>
    178. 

  178. <li>global configuration file (defaults to <code>$PREFIX/etc/npmrc</code>; configurable via
    179. 

  179. CLI option <code>--globalconfig</code> or environment variable <code>$NPM_CONFIG_GLOBALCONFIG</code>)</li>
    180. 

  180. <li>npm’s built-in configuration file (<code>/path/to/npm/npmrc</code>)</li>
    181. 

  181. </ul>
    182. 

  182. <p>See <a href="../configuring-npm/npmrc.html">npmrc</a> for more details.</p>
    183. 

  183. <h4 id="default-configs">Default Configs</h4>
    184. 

  184. <p>Run <code>npm config ls -l</code> to see a set of configuration parameters that are
    185. 

  185. internal to npm, and are defaults if nothing else is specified.</p>
    186. 

  186. <h3 id="shorthands-and-other-cli-niceties">Shorthands and Other CLI Niceties</h3>
    187. 

  187. <p>The following shorthands are parsed on the command-line:</p>
    188. 

  188. <!-- raw HTML omitted -->
    189. 

  189. <!-- raw HTML omitted -->
    190. 

  190. <!-- raw HTML omitted -->
    191. 

  191. <ul>
    192. 

  192. <li><code>-a</code>: <code>--all</code></li>
    193. 

  193. <li><code>--enjoy-by</code>: <code>--before</code></li>
    194. 

  194. <li><code>-c</code>: <code>--call</code></li>
    195. 

  195. <li><code>--desc</code>: <code>--description</code></li>
    196. 

  196. <li><code>-f</code>: <code>--force</code></li>
    197. 

  197. <li><code>-g</code>: <code>--global</code></li>
    198. 

  198. <li><code>-L</code>: <code>--location</code></li>
    199. 

  199. <li><code>-d</code>: <code>--loglevel info</code></li>
    200. 

  200. <li><code>-s</code>: <code>--loglevel silent</code></li>
    201. 

  201. <li><code>--silent</code>: <code>--loglevel silent</code></li>
    202. 

  202. <li><code>--ddd</code>: <code>--loglevel silly</code></li>
    203. 

  203. <li><code>--dd</code>: <code>--loglevel verbose</code></li>
    204. 

  204. <li><code>--verbose</code>: <code>--loglevel verbose</code></li>
    205. 

  205. <li><code>-q</code>: <code>--loglevel warn</code></li>
    206. 

  206. <li><code>--quiet</code>: <code>--loglevel warn</code></li>
    207. 

  207. <li><code>-l</code>: <code>--long</code></li>
    208. 

  208. <li><code>-m</code>: <code>--message</code></li>
    209. 

  209. <li><code>--local</code>: <code>--no-global</code></li>
    210. 

  210. <li><code>-n</code>: <code>--no-yes</code></li>
    211. 

  211. <li><code>--no</code>: <code>--no-yes</code></li>
    212. 

  212. <li><code>-p</code>: <code>--parseable</code></li>
    213. 

  213. <li><code>--porcelain</code>: <code>--parseable</code></li>
    214. 

  214. <li><code>-C</code>: <code>--prefix</code></li>
    215. 

  215. <li><code>--readonly</code>: <code>--read-only</code></li>
    216. 

  216. <li><code>--reg</code>: <code>--registry</code></li>
    217. 

  217. <li><code>-S</code>: <code>--save</code></li>
    218. 

  218. <li><code>-B</code>: <code>--save-bundle</code></li>
    219. 

  219. <li><code>-D</code>: <code>--save-dev</code></li>
    220. 

  220. <li><code>-E</code>: <code>--save-exact</code></li>
    221. 

  221. <li><code>-O</code>: <code>--save-optional</code></li>
    222. 

  222. <li><code>-P</code>: <code>--save-prod</code></li>
    223. 

  223. <li><code>-?</code>: <code>--usage</code></li>
    224. 

  224. <li><code>-h</code>: <code>--usage</code></li>
    225. 

  225. <li><code>-H</code>: <code>--usage</code></li>
    226. 

  226. <li><code>--help</code>: <code>--usage</code></li>
    227. 

  227. <li><code>-v</code>: <code>--version</code></li>
    228. 

  228. <li><code>-w</code>: <code>--workspace</code></li>
    229. 

  229. <li><code>--ws</code>: <code>--workspaces</code></li>
    230. 

  230. <li><code>-y</code>: <code>--yes</code></li>
    231. 

  231. </ul>
    232. 

  232. <!-- raw HTML omitted -->
    233. 

  233. <!-- raw HTML omitted -->
    234. 

  234. <!-- raw HTML omitted -->
    235. 

  235. <p>If the specified configuration param resolves unambiguously to a known
    236. 

  236. configuration parameter, then it is expanded to that configuration
    237. 

  237. parameter.  For example:</p>
    238. 

  238. <pre lang="bash"><code>npm ls --par
    239. 

  239. # same as:
    240. 

  240. npm ls --parseable
    241. 

  241. </code></pre>
    242. 

  242. <p>If multiple single-character shorthands are strung together, and the
    243. 

  243. resulting combination is unambiguously not some other configuration
    244. 

  244. param, then it is expanded to its various component pieces.  For
    245. 

  245. example:</p>
    246. 

  246. <pre lang="bash"><code>npm ls -gpld
    247. 

  247. # same as:
    248. 

  248. npm ls --global --parseable --long --loglevel info
    249. 

  249. </code></pre>
    250. 

  250. <h3 id="config-settings">Config Settings</h3>
    251. 

  251. <!-- raw HTML omitted -->
    252. 

  252. <!-- raw HTML omitted -->
    253. 

  253. <!-- raw HTML omitted -->
    254. 

  254. <h4 id="auth"><code>_auth</code></h4>
    255. 

  255. <ul>
    256. 

  256. <li>Default: null</li>
    257. 

  257. <li>Type: null or String</li>
    258. 

  258. </ul>
    259. 

  259. <p>A basic-auth string to use when authenticating against the npm registry.</p>
    260. 

  260. <p>Warning: This should generally not be set via a command-line option. It is
    261. 

  261. safer to use a registry-provided authentication bearer token stored in the
    262. 

  262. ~/.npmrc file by running <code>npm login</code>.</p>
    263. 

  263. <!-- raw HTML omitted -->
    264. 

  264. <!-- raw HTML omitted -->
    265. 

  265. <h4 id="access"><code>access</code></h4>
    266. 

  266. <ul>
    267. 

  267. <li>Default: ‘restricted’ for scoped packages, ‘public’ for unscoped packages</li>
    268. 

  268. <li>Type: null, “restricted”, or “public”</li>
    269. 

  269. </ul>
    270. 

  270. <p>When publishing scoped packages, the access level defaults to <code>restricted</code>.
    271. 

  271. If you want your scoped package to be publicly viewable (and installable)
    272. 

  272. set <code>--access=public</code>. The only valid values for <code>access</code> are <code>public</code> and
    273. 

  273. <code>restricted</code>. Unscoped packages <em>always</em> have an access level of <code>public</code>.</p>
    274. 

  274. <p>Note: Using the <code>--access</code> flag on the <code>npm publish</code> command will only set
    275. 

  275. the package access level on the initial publish of the package. Any
    276. 

  276. subsequent <code>npm publish</code> commands using the <code>--access</code> flag will not have an
    277. 

  277. effect to the access level. To make changes to the access level after the
    278. 

  278. initial publish use <code>npm access</code>.</p>
    279. 

  279. <!-- raw HTML omitted -->
    280. 

  280. <!-- raw HTML omitted -->
    281. 

  281. <h4 id="all"><code>all</code></h4>
    282. 

  282. <ul>
    283. 

  283. <li>Default: false</li>
    284. 

  284. <li>Type: Boolean</li>
    285. 

  285. </ul>
    286. 

  286. <p>When running <code>npm outdated</code> and <code>npm ls</code>, setting <code>--all</code> will show all
    287. 

  287. outdated or installed packages, rather than only those directly depended
    288. 

  288. upon by the current project.</p>
    289. 

  289. <!-- raw HTML omitted -->
    290. 

  290. <!-- raw HTML omitted -->
    291. 

  291. <h4 id="allow-same-version"><code>allow-same-version</code></h4>
    292. 

  292. <ul>
    293. 

  293. <li>Default: false</li>
    294. 

  294. <li>Type: Boolean</li>
    295. 

  295. </ul>
    296. 

  296. <p>Prevents throwing an error when <code>npm version</code> is used to set the new version
    297. 

  297. to the same value as the current version.</p>
    298. 

  298. <!-- raw HTML omitted -->
    299. 

  299. <!-- raw HTML omitted -->
    300. 

  300. <h4 id="audit"><code>audit</code></h4>
    301. 

  301. <ul>
    302. 

  302. <li>Default: true</li>
    303. 

  303. <li>Type: Boolean</li>
    304. 

  304. </ul>
    305. 

  305. <p>When “true” submit audit reports alongside the current npm command to the
    306. 

  306. default registry and all registries configured for scopes. See the
    307. 

  307. documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is
    308. 

  308. submitted.</p>
    309. 

  309. <!-- raw HTML omitted -->
    310. 

  310. <!-- raw HTML omitted -->
    311. 

  311. <h4 id="audit-level"><code>audit-level</code></h4>
    312. 

  312. <ul>
    313. 

  313. <li>Default: null</li>
    314. 

  314. <li>Type: null, “info”, “low”, “moderate”, “high”, “critical”, or “none”</li>
    315. 

  315. </ul>
    316. 

  316. <p>The minimum level of vulnerability for <code>npm audit</code> to exit with a non-zero
    317. 

  317. exit code.</p>
    318. 

  318. <!-- raw HTML omitted -->
    319. 

  319. <!-- raw HTML omitted -->
    320. 

  320. <h4 id="before"><code>before</code></h4>
    321. 

  321. <ul>
    322. 

  322. <li>Default: null</li>
    323. 

  323. <li>Type: null or Date</li>
    324. 

  324. </ul>
    325. 

  325. <p>If passed to <code>npm install</code>, will rebuild the npm tree such that only
    326. 

  326. versions that were available <strong>on or before</strong> the <code>--before</code> time get
    327. 

  327. installed. If there’s no versions available for the current set of direct
    328. 

  328. dependencies, the command will error.</p>
    329. 

  329. <p>If the requested version is a <code>dist-tag</code> and the given tag does not pass the
    330. 

  330. <code>--before</code> filter, the most recent version less than or equal to that tag
    331. 

  331. will be used. For example, <code>foo@latest</code> might install <code>foo@1.2</code> even though
    332. 

  332. <code>latest</code> is <code>2.0</code>.</p>
    333. 

  333. <!-- raw HTML omitted -->
    334. 

  334. <!-- raw HTML omitted -->
    335. 

  335. <h4 id="bin-links"><code>bin-links</code></h4>
    336. 

  336. <ul>
    337. 

  337. <li>Default: true</li>
    338. 

  338. <li>Type: Boolean</li>
    339. 

  339. </ul>
    340. 

  340. <p>Tells npm to create symlinks (or <code>.cmd</code> shims on Windows) for package
    341. 

  341. executables.</p>
    342. 

  342. <p>Set to false to have it not do this. This can be used to work around the
    343. 

  343. fact that some file systems don’t support symlinks, even on ostensibly Unix
    344. 

  344. systems.</p>
    345. 

  345. <!-- raw HTML omitted -->
    346. 

  346. <!-- raw HTML omitted -->
    347. 

  347. <h4 id="browser"><code>browser</code></h4>
    348. 

  348. <ul>
    349. 

  349. <li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li>
    350. 

  350. <li>Type: null, Boolean, or String</li>
    351. 

  351. </ul>
    352. 

  352. <p>The browser that is called by npm commands to open websites.</p>
    353. 

  353. <p>Set to <code>false</code> to suppress browser behavior and instead print urls to
    354. 

  354. terminal.</p>
    355. 

  355. <p>Set to <code>true</code> to use default system URL opener.</p>
    356. 

  356. <!-- raw HTML omitted -->
    357. 

  357. <!-- raw HTML omitted -->
    358. 

  358. <h4 id="ca"><code>ca</code></h4>
    359. 

  359. <ul>
    360. 

  360. <li>Default: null</li>
    361. 

  361. <li>Type: null or String (can be set multiple times)</li>
    362. 

  362. </ul>
    363. 

  363. <p>The Certificate Authority signing certificate that is trusted for SSL
    364. 

  364. connections to the registry. Values should be in PEM format (Windows calls
    365. 

  365. it “Base-64 encoded X.509 (.CER)”) with newlines replaced by the string
    366. 

  366. “\n”. For example:</p>
    367. 

  367. <pre lang="ini"><code>ca="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"
    368. 

  368. </code></pre>
    369. 

  369. <p>Set to <code>null</code> to only allow “known” registrars, or to a specific CA cert to
    370. 

  370. trust only that specific signing authority.</p>
    371. 

  371. <p>Multiple CAs can be trusted by specifying an array of certificates:</p>
    372. 

  372. <pre lang="ini"><code>ca[]="..."
    373. 

  373. ca[]="..."
    374. 

  374. </code></pre>
    375. 

  375. <p>See also the <code>strict-ssl</code> config.</p>
    376. 

  376. <!-- raw HTML omitted -->
    377. 

  377. <!-- raw HTML omitted -->
    378. 

  378. <h4 id="cache"><code>cache</code></h4>
    379. 

  379. <ul>
    380. 

  380. <li>Default: Windows: <code>%LocalAppData%\npm-cache</code>, Posix: <code>~/.npm</code></li>
    381. 

  381. <li>Type: Path</li>
    382. 

  382. </ul>
    383. 

  383. <p>The location of npm’s cache directory. See <a href="../commands/npm-cache.html"><code>npm cache</code></a></p>
    384. 

  384. <!-- raw HTML omitted -->
    385. 

  385. <!-- raw HTML omitted -->
    386. 

  386. <h4 id="cafile"><code>cafile</code></h4>
    387. 

  387. <ul>
    388. 

  388. <li>Default: null</li>
    389. 

  389. <li>Type: Path</li>
    390. 

  390. </ul>
    391. 

  391. <p>A path to a file containing one or multiple Certificate Authority signing
    392. 

  392. certificates. Similar to the <code>ca</code> setting, but allows for multiple CA’s, as
    393. 

  393. well as for the CA information to be stored in a file on disk.</p>
    394. 

  394. <!-- raw HTML omitted -->
    395. 

  395. <!-- raw HTML omitted -->
    396. 

  396. <h4 id="call"><code>call</code></h4>
    397. 

  397. <ul>
    398. 

  398. <li>Default: “”</li>
    399. 

  399. <li>Type: String</li>
    400. 

  400. </ul>
    401. 

  401. <p>Optional companion option for <code>npm exec</code>, <code>npx</code> that allows for specifying a
    402. 

  402. custom command to be run along with the installed packages.</p>
    403. 

  403. <pre lang="bash"><code>npm exec --package yo --package generator-node --call "yo node"
    404. 

  404. </code></pre>
    405. 

  405. <!-- raw HTML omitted -->
    406. 

  406. <!-- raw HTML omitted -->
    407. 

  407. <h4 id="cert"><code>cert</code></h4>
    408. 

  408. <ul>
    409. 

  409. <li>Default: null</li>
    410. 

  410. <li>Type: null or String</li>
    411. 

  411. </ul>
    412. 

  412. <p>A client certificate to pass when accessing the registry. Values should be
    413. 

  413. in PEM format (Windows calls it “Base-64 encoded X.509 (.CER)”) with
    414. 

  414. newlines replaced by the string “\n”. For example:</p>
    415. 

  415. <pre lang="ini"><code>cert="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"
    416. 

  416. </code></pre>
    417. 

  417. <p>It is <em>not</em> the path to a certificate file (and there is no “certfile”
    418. 

  418. option).</p>
    419. 

  419. <!-- raw HTML omitted -->
    420. 

  420. <!-- raw HTML omitted -->
    421. 

  421. <h4 id="ci-name"><code>ci-name</code></h4>
    422. 

  422. <ul>
    423. 

  423. <li>Default: The name of the current CI system, or <code>null</code> when not on a known CI
    424. 

  424. platform.</li>
    425. 

  425. <li>Type: null or String</li>
    426. 

  426. </ul>
    427. 

  427. <p>The name of a continuous integration system. If not set explicitly, npm will
    428. 

  428. detect the current CI environment using the
    429. 

  429. <a href="http://npm.im/@npmcli/ci-detect"><code>@npmcli/ci-detect</code></a> module.</p>
    430. 

  430. <!-- raw HTML omitted -->
    431. 

  431. <!-- raw HTML omitted -->
    432. 

  432. <h4 id="cidr"><code>cidr</code></h4>
    433. 

  433. <ul>
    434. 

  434. <li>Default: null</li>
    435. 

  435. <li>Type: null or String (can be set multiple times)</li>
    436. 

  436. </ul>
    437. 

  437. <p>This is a list of CIDR address to be used when configuring limited access
    438. 

  438. tokens with the <code>npm token create</code> command.</p>
    439. 

  439. <!-- raw HTML omitted -->
    440. 

  440. <!-- raw HTML omitted -->
    441. 

  441. <h4 id="color"><code>color</code></h4>
    442. 

  442. <ul>
    443. 

  443. <li>Default: true unless the NO_COLOR environ is set to something other than ‘0’</li>
    444. 

  444. <li>Type: “always” or Boolean</li>
    445. 

  445. </ul>
    446. 

  446. <p>If false, never shows colors. If <code>"always"</code> then always shows colors. If
    447. 

  447. true, then only prints color codes for tty file descriptors.</p>
    448. 

  448. <!-- raw HTML omitted -->
    449. 

  449. <!-- raw HTML omitted -->
    450. 

  450. <h4 id="commit-hooks"><code>commit-hooks</code></h4>
    451. 

  451. <ul>
    452. 

  452. <li>Default: true</li>
    453. 

  453. <li>Type: Boolean</li>
    454. 

  454. </ul>
    455. 

  455. <p>Run git commit hooks when using the <code>npm version</code> command.</p>
    456. 

  456. <!-- raw HTML omitted -->
    457. 

  457. <!-- raw HTML omitted -->
    458. 

  458. <h4 id="depth"><code>depth</code></h4>
    459. 

  459. <ul>
    460. 

  460. <li>Default: <code>Infinity</code> if <code>--all</code> is set, otherwise <code>1</code></li>
    461. 

  461. <li>Type: null or Number</li>
    462. 

  462. </ul>
    463. 

  463. <p>The depth to go when recursing packages for <code>npm ls</code>.</p>
    464. 

  464. <p>If not set, <code>npm ls</code> will show only the immediate dependencies of the root
    465. 

  465. project. If <code>--all</code> is set, then npm will show all dependencies by default.</p>
    466. 

  466. <!-- raw HTML omitted -->
    467. 

  467. <!-- raw HTML omitted -->
    468. 

  468. <h4 id="description2"><code>description</code></h4>
    469. 

  469. <ul>
    470. 

  470. <li>Default: true</li>
    471. 

  471. <li>Type: Boolean</li>
    472. 

  472. </ul>
    473. 

  473. <p>Show the description in <code>npm search</code></p>
    474. 

  474. <!-- raw HTML omitted -->
    475. 

  475. <!-- raw HTML omitted -->
    476. 

  476. <h4 id="diff"><code>diff</code></h4>
    477. 

  477. <ul>
    478. 

  478. <li>Default:</li>
    479. 

  479. <li>Type: String (can be set multiple times)</li>
    480. 

  480. </ul>
    481. 

  481. <p>Define arguments to compare in <code>npm diff</code>.</p>
    482. 

  482. <!-- raw HTML omitted -->
    483. 

  483. <!-- raw HTML omitted -->
    484. 

  484. <h4 id="diff-dst-prefix"><code>diff-dst-prefix</code></h4>
    485. 

  485. <ul>
    486. 

  486. <li>Default: “b/”</li>
    487. 

  487. <li>Type: String</li>
    488. 

  488. </ul>
    489. 

  489. <p>Destination prefix to be used in <code>npm diff</code> output.</p>
    490. 

  490. <!-- raw HTML omitted -->
    491. 

  491. <!-- raw HTML omitted -->
    492. 

  492. <h4 id="diff-ignore-all-space"><code>diff-ignore-all-space</code></h4>
    493. 

  493. <ul>
    494. 

  494. <li>Default: false</li>
    495. 

  495. <li>Type: Boolean</li>
    496. 

  496. </ul>
    497. 

  497. <p>Ignore whitespace when comparing lines in <code>npm diff</code>.</p>
    498. 

  498. <!-- raw HTML omitted -->
    499. 

  499. <!-- raw HTML omitted -->
    500. 

  500. <h4 id="diff-name-only"><code>diff-name-only</code></h4>
    501. 

  501. <ul>
    502. 

  502. <li>Default: false</li>
    503. 

  503. <li>Type: Boolean</li>
    504. 

  504. </ul>
    505. 

  505. <p>Prints only filenames when using <code>npm diff</code>.</p>
    506. 

  506. <!-- raw HTML omitted -->
    507. 

  507. <!-- raw HTML omitted -->
    508. 

  508. <h4 id="diff-no-prefix"><code>diff-no-prefix</code></h4>
    509. 

  509. <ul>
    510. 

  510. <li>Default: false</li>
    511. 

  511. <li>Type: Boolean</li>
    512. 

  512. </ul>
    513. 

  513. <p>Do not show any source or destination prefix in <code>npm diff</code> output.</p>
    514. 

  514. <p>Note: this causes <code>npm diff</code> to ignore the <code>--diff-src-prefix</code> and
    515. 

  515. <code>--diff-dst-prefix</code> configs.</p>
    516. 

  516. <!-- raw HTML omitted -->
    517. 

  517. <!-- raw HTML omitted -->
    518. 

  518. <h4 id="diff-src-prefix"><code>diff-src-prefix</code></h4>
    519. 

  519. <ul>
    520. 

  520. <li>Default: “a/”</li>
    521. 

  521. <li>Type: String</li>
    522. 

  522. </ul>
    523. 

  523. <p>Source prefix to be used in <code>npm diff</code> output.</p>
    524. 

  524. <!-- raw HTML omitted -->
    525. 

  525. <!-- raw HTML omitted -->
    526. 

  526. <h4 id="diff-text"><code>diff-text</code></h4>
    527. 

  527. <ul>
    528. 

  528. <li>Default: false</li>
    529. 

  529. <li>Type: Boolean</li>
    530. 

  530. </ul>
    531. 

  531. <p>Treat all files as text in <code>npm diff</code>.</p>
    532. 

  532. <!-- raw HTML omitted -->
    533. 

  533. <!-- raw HTML omitted -->
    534. 

  534. <h4 id="diff-unified"><code>diff-unified</code></h4>
    535. 

  535. <ul>
    536. 

  536. <li>Default: 3</li>
    537. 

  537. <li>Type: Number</li>
    538. 

  538. </ul>
    539. 

  539. <p>The number of lines of context to print in <code>npm diff</code>.</p>
    540. 

  540. <!-- raw HTML omitted -->
    541. 

  541. <!-- raw HTML omitted -->
    542. 

  542. <h4 id="dry-run"><code>dry-run</code></h4>
    543. 

  543. <ul>
    544. 

  544. <li>Default: false</li>
    545. 

  545. <li>Type: Boolean</li>
    546. 

  546. </ul>
    547. 

  547. <p>Indicates that you don’t want npm to make any changes and that it should
    548. 

  548. only report what it would have done. This can be passed into any of the
    549. 

  549. commands that modify your local installation, eg, <code>install</code>, <code>update</code>,
    550. 

  550. <code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p>
    551. 

  551. <p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>,
    552. 

  552. <code>owner</code>, etc.</p>
    553. 

  553. <!-- raw HTML omitted -->
    554. 

  554. <!-- raw HTML omitted -->
    555. 

  555. <h4 id="editor"><code>editor</code></h4>
    556. 

  556. <ul>
    557. 

  557. <li>Default: The EDITOR or VISUAL environment variables, or ‘notepad.exe’ on
    558. 

  558. Windows, or ‘vim’ on Unix systems</li>
    559. 

  559. <li>Type: String</li>
    560. 

  560. </ul>
    561. 

  561. <p>The command to run for <code>npm edit</code> and <code>npm config edit</code>.</p>
    562. 

  562. <!-- raw HTML omitted -->
    563. 

  563. <!-- raw HTML omitted -->
    564. 

  564. <h4 id="engine-strict"><code>engine-strict</code></h4>
    565. 

  565. <ul>
    566. 

  566. <li>Default: false</li>
    567. 

  567. <li>Type: Boolean</li>
    568. 

  568. </ul>
    569. 

  569. <p>If set to true, then npm will stubbornly refuse to install (or even consider
    570. 

  570. installing) any package that claims to not be compatible with the current
    571. 

  571. Node.js version.</p>
    572. 

  572. <p>This can be overridden by setting the <code>--force</code> flag.</p>
    573. 

  573. <!-- raw HTML omitted -->
    574. 

  574. <!-- raw HTML omitted -->
    575. 

  575. <h4 id="fetch-retries"><code>fetch-retries</code></h4>
    576. 

  576. <ul>
    577. 

  577. <li>Default: 2</li>
    578. 

  578. <li>Type: Number</li>
    579. 

  579. </ul>
    580. 

  580. <p>The “retries” config for the <code>retry</code> module to use when fetching packages
    581. 

  581. from the registry.</p>
    582. 

  582. <p>npm will retry idempotent read requests to the registry in the case of
    583. 

  583. network failures or 5xx HTTP errors.</p>
    584. 

  584. <!-- raw HTML omitted -->
    585. 

  585. <!-- raw HTML omitted -->
    586. 

  586. <h4 id="fetch-retry-factor"><code>fetch-retry-factor</code></h4>
    587. 

  587. <ul>
    588. 

  588. <li>Default: 10</li>
    589. 

  589. <li>Type: Number</li>
    590. 

  590. </ul>
    591. 

  591. <p>The “factor” config for the <code>retry</code> module to use when fetching packages.</p>
    592. 

  592. <!-- raw HTML omitted -->
    593. 

  593. <!-- raw HTML omitted -->
    594. 

  594. <h4 id="fetch-retry-maxtimeout"><code>fetch-retry-maxtimeout</code></h4>
    595. 

  595. <ul>
    596. 

  596. <li>Default: 60000 (1 minute)</li>
    597. 

  597. <li>Type: Number</li>
    598. 

  598. </ul>
    599. 

  599. <p>The “maxTimeout” config for the <code>retry</code> module to use when fetching
    600. 

  600. packages.</p>
    601. 

  601. <!-- raw HTML omitted -->
    602. 

  602. <!-- raw HTML omitted -->
    603. 

  603. <h4 id="fetch-retry-mintimeout"><code>fetch-retry-mintimeout</code></h4>
    604. 

  604. <ul>
    605. 

  605. <li>Default: 10000 (10 seconds)</li>
    606. 

  606. <li>Type: Number</li>
    607. 

  607. </ul>
    608. 

  608. <p>The “minTimeout” config for the <code>retry</code> module to use when fetching
    609. 

  609. packages.</p>
    610. 

  610. <!-- raw HTML omitted -->
    611. 

  611. <!-- raw HTML omitted -->
    612. 

  612. <h4 id="fetch-timeout"><code>fetch-timeout</code></h4>
    613. 

  613. <ul>
    614. 

  614. <li>Default: 300000 (5 minutes)</li>
    615. 

  615. <li>Type: Number</li>
    616. 

  616. </ul>
    617. 

  617. <p>The maximum amount of time to wait for HTTP requests to complete.</p>
    618. 

  618. <!-- raw HTML omitted -->
    619. 

  619. <!-- raw HTML omitted -->
    620. 

  620. <h4 id="force"><code>force</code></h4>
    621. 

  621. <ul>
    622. 

  622. <li>Default: false</li>
    623. 

  623. <li>Type: Boolean</li>
    624. 

  624. </ul>
    625. 

  625. <p>Removes various protections against unfortunate side effects, common
    626. 

  626. mistakes, unnecessary performance degradation, and malicious input.</p>
    627. 

  627. <ul>
    628. 

  628. <li>Allow clobbering non-npm files in global installs.</li>
    629. 

  629. <li>Allow the <code>npm version</code> command to work on an unclean git repository.</li>
    630. 

  630. <li>Allow deleting the cache folder with <code>npm cache clean</code>.</li>
    631. 

  631. <li>Allow installing packages that have an <code>engines</code> declaration requiring a
    632. 

  632. different version of npm.</li>
    633. 

  633. <li>Allow installing packages that have an <code>engines</code> declaration requiring a
    634. 

  634. different version of <code>node</code>, even if <code>--engine-strict</code> is enabled.</li>
    635. 

  635. <li>Allow <code>npm audit fix</code> to install modules outside your stated dependency
    636. 

  636. range (including SemVer-major changes).</li>
    637. 

  637. <li>Allow unpublishing all versions of a published package.</li>
    638. 

  638. <li>Allow conflicting peerDependencies to be installed in the root project.</li>
    639. 

  639. <li>Implicitly set <code>--yes</code> during <code>npm init</code>.</li>
    640. 

  640. <li>Allow clobbering existing values in <code>npm pkg</code></li>
    641. 

  641. </ul>
    642. 

  642. <p>If you don’t have a clear idea of what you want to do, it is strongly
    643. 

  643. recommended that you do not use this option!</p>
    644. 

  644. <!-- raw HTML omitted -->
    645. 

  645. <!-- raw HTML omitted -->
    646. 

  646. <h4 id="foreground-scripts"><code>foreground-scripts</code></h4>
    647. 

  647. <ul>
    648. 

  648. <li>Default: false</li>
    649. 

  649. <li>Type: Boolean</li>
    650. 

  650. </ul>
    651. 

  651. <p>Run all build scripts (ie, <code>preinstall</code>, <code>install</code>, and <code>postinstall</code>)
    652. 

  652. scripts for installed packages in the foreground process, sharing standard
    653. 

  653. input, output, and error with the main npm process.</p>
    654. 

  654. <p>Note that this will generally make installs run slower, and be much noisier,
    655. 

  655. but can be useful for debugging.</p>
    656. 

  656. <!-- raw HTML omitted -->
    657. 

  657. <!-- raw HTML omitted -->
    658. 

  658. <h4 id="format-package-lock"><code>format-package-lock</code></h4>
    659. 

  659. <ul>
    660. 

  660. <li>Default: true</li>
    661. 

  661. <li>Type: Boolean</li>
    662. 

  662. </ul>
    663. 

  663. <p>Format <code>package-lock.json</code> or <code>npm-shrinkwrap.json</code> as a human readable
    664. 

  664. file.</p>
    665. 

  665. <!-- raw HTML omitted -->
    666. 

  666. <!-- raw HTML omitted -->
    667. 

  667. <h4 id="fund"><code>fund</code></h4>
    668. 

  668. <ul>
    669. 

  669. <li>Default: true</li>
    670. 

  670. <li>Type: Boolean</li>
    671. 

  671. </ul>
    672. 

  672. <p>When “true” displays the message at the end of each <code>npm install</code>
    673. 

  673. acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p>
    674. 

  674. <!-- raw HTML omitted -->
    675. 

  675. <!-- raw HTML omitted -->
    676. 

  676. <h4 id="git"><code>git</code></h4>
    677. 

  677. <ul>
    678. 

  678. <li>Default: “git”</li>
    679. 

  679. <li>Type: String</li>
    680. 

  680. </ul>
    681. 

  681. <p>The command to use for git commands. If git is installed on the computer,
    682. 

  682. but is not in the <code>PATH</code>, then set this to the full path to the git binary.</p>
    683. 

  683. <!-- raw HTML omitted -->
    684. 

  684. <!-- raw HTML omitted -->
    685. 

  685. <h4 id="git-tag-version"><code>git-tag-version</code></h4>
    686. 

  686. <ul>
    687. 

  687. <li>Default: true</li>
    688. 

  688. <li>Type: Boolean</li>
    689. 

  689. </ul>
    690. 

  690. <p>Tag the commit when using the <code>npm version</code> command.</p>
    691. 

  691. <!-- raw HTML omitted -->
    692. 

  692. <!-- raw HTML omitted -->
    693. 

  693. <h4 id="global"><code>global</code></h4>
    694. 

  694. <ul>
    695. 

  695. <li>Default: false</li>
    696. 

  696. <li>Type: Boolean</li>
    697. 

  697. </ul>
    698. 

  698. <p>Operates in “global” mode, so that packages are installed into the <code>prefix</code>
    699. 

  699. folder instead of the current working directory. See
    700. 

  700. <a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p>
    701. 

  701. <ul>
    702. 

  702. <li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead
    703. 

  703. of the current working directory.</li>
    704. 

  704. <li>bin files are linked to <code>{prefix}/bin</code></li>
    705. 

  705. <li>man pages are linked to <code>{prefix}/share/man</code></li>
    706. 

  706. </ul>
    707. 

  707. <!-- raw HTML omitted -->
    708. 

  708. <!-- raw HTML omitted -->
    709. 

  709. <h4 id="global-style"><code>global-style</code></h4>
    710. 

  710. <ul>
    711. 

  711. <li>Default: false</li>
    712. 

  712. <li>Type: Boolean</li>
    713. 

  713. </ul>
    714. 

  714. <p>Causes npm to install the package into your local <code>node_modules</code> folder with
    715. 

  715. the same layout it uses with the global <code>node_modules</code> folder. Only your
    716. 

  716. direct dependencies will show in <code>node_modules</code> and everything they depend
    717. 

  717. on will be flattened in their <code>node_modules</code> folders. This obviously will
    718. 

  718. eliminate some deduping. If used with <code>legacy-bundling</code>, <code>legacy-bundling</code>
    719. 

  719. will be preferred.</p>
    720. 

  720. <!-- raw HTML omitted -->
    721. 

  721. <!-- raw HTML omitted -->
    722. 

  722. <h4 id="globalconfig"><code>globalconfig</code></h4>
    723. 

  723. <ul>
    724. 

  724. <li>Default: The global –prefix setting plus ‘etc/npmrc’. For example,
    725. 

  725. ‘/usr/local/etc/npmrc’</li>
    726. 

  726. <li>Type: Path</li>
    727. 

  727. </ul>
    728. 

  728. <p>The config file to read for global config options.</p>
    729. 

  729. <!-- raw HTML omitted -->
    730. 

  730. <!-- raw HTML omitted -->
    731. 

  731. <h4 id="heading"><code>heading</code></h4>
    732. 

  732. <ul>
    733. 

  733. <li>Default: “npm”</li>
    734. 

  734. <li>Type: String</li>
    735. 

  735. </ul>
    736. 

  736. <p>The string that starts all the debugging log output.</p>
    737. 

  737. <!-- raw HTML omitted -->
    738. 

  738. <!-- raw HTML omitted -->
    739. 

  739. <h4 id="https-proxy"><code>https-proxy</code></h4>
    740. 

  740. <ul>
    741. 

  741. <li>Default: null</li>
    742. 

  742. <li>Type: null or URL</li>
    743. 

  743. </ul>
    744. 

  744. <p>A proxy to use for outgoing https requests. If the <code>HTTPS_PROXY</code> or
    745. 

  745. <code>https_proxy</code> or <code>HTTP_PROXY</code> or <code>http_proxy</code> environment variables are set,
    746. 

  746. proxy settings will be honored by the underlying <code>make-fetch-happen</code>
    747. 

  747. library.</p>
    748. 

  748. <!-- raw HTML omitted -->
    749. 

  749. <!-- raw HTML omitted -->
    750. 

  750. <h4 id="if-present"><code>if-present</code></h4>
    751. 

  751. <ul>
    752. 

  752. <li>Default: false</li>
    753. 

  753. <li>Type: Boolean</li>
    754. 

  754. </ul>
    755. 

  755. <p>If true, npm will not exit with an error code when <code>run-script</code> is invoked
    756. 

  756. for a script that isn’t defined in the <code>scripts</code> section of <code>package.json</code>.
    757. 

  757. This option can be used when it’s desirable to optionally run a script when
    758. 

  758. it’s present and fail if the script fails. This is useful, for example, when
    759. 

  759. running scripts that may only apply for some builds in an otherwise generic
    760. 

  760. CI setup.</p>
    761. 

  761. <!-- raw HTML omitted -->
    762. 

  762. <!-- raw HTML omitted -->
    763. 

  763. <h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
    764. 

  764. <ul>
    765. 

  765. <li>Default: false</li>
    766. 

  766. <li>Type: Boolean</li>
    767. 

  767. </ul>
    768. 

  768. <p>If true, npm does not run scripts specified in package.json files.</p>
    769. 

  769. <p>Note that commands explicitly intended to run a particular script, such as
    770. 

  770. <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code>
    771. 

  771. will still run their intended script if <code>ignore-scripts</code> is set, but they
    772. 

  772. will <em>not</em> run any pre- or post-scripts.</p>
    773. 

  773. <!-- raw HTML omitted -->
    774. 

  774. <!-- raw HTML omitted -->
    775. 

  775. <h4 id="include"><code>include</code></h4>
    776. 

  776. <ul>
    777. 

  777. <li>Default:</li>
    778. 

  778. <li>Type: “prod”, “dev”, “optional”, or “peer” (can be set multiple times)</li>
    779. 

  779. </ul>
    780. 

  780. <p>Option that allows for defining which types of dependencies to install.</p>
    781. 

  781. <p>This is the inverse of <code>--omit=&lt;type&gt;</code>.</p>
    782. 

  782. <p>Dependency types specified in <code>--include</code> will not be omitted, regardless of
    783. 

  783. the order in which omit/include are specified on the command-line.</p>
    784. 

  784. <!-- raw HTML omitted -->
    785. 

  785. <!-- raw HTML omitted -->
    786. 

  786. <h4 id="include-staged"><code>include-staged</code></h4>
    787. 

  787. <ul>
    788. 

  788. <li>Default: false</li>
    789. 

  789. <li>Type: Boolean</li>
    790. 

  790. </ul>
    791. 

  791. <p>Allow installing “staged” published packages, as defined by <a href="https://github.com/npm/rfcs/pull/92">npm RFC PR
    792. 

  792. #92</a>.</p>
    793. 

  793. <p>This is experimental, and not implemented by the npm public registry.</p>
    794. 

  794. <!-- raw HTML omitted -->
    795. 

  795. <!-- raw HTML omitted -->
    796. 

  796. <h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
    797. 

  797. <ul>
    798. 

  798. <li>Default: false</li>
    799. 

  799. <li>Type: Boolean</li>
    800. 

  800. </ul>
    801. 

  801. <p>Include the workspace root when workspaces are enabled for a command.</p>
    802. 

  802. <p>When false, specifying individual workspaces via the <code>workspace</code> config, or
    803. 

  803. all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
    804. 

  804. the specified workspaces, and not on the root project.</p>
    805. 

  805. <!-- raw HTML omitted -->
    806. 

  806. <!-- raw HTML omitted -->
    807. 

  807. <h4 id="init-author-email"><code>init-author-email</code></h4>
    808. 

  808. <ul>
    809. 

  809. <li>Default: “”</li>
    810. 

  810. <li>Type: String</li>
    811. 

  811. </ul>
    812. 

  812. <p>The value <code>npm init</code> should use by default for the package author’s email.</p>
    813. 

  813. <!-- raw HTML omitted -->
    814. 

  814. <!-- raw HTML omitted -->
    815. 

  815. <h4 id="init-author-name"><code>init-author-name</code></h4>
    816. 

  816. <ul>
    817. 

  817. <li>Default: “”</li>
    818. 

  818. <li>Type: String</li>
    819. 

  819. </ul>
    820. 

  820. <p>The value <code>npm init</code> should use by default for the package author’s name.</p>
    821. 

  821. <!-- raw HTML omitted -->
    822. 

  822. <!-- raw HTML omitted -->
    823. 

  823. <h4 id="init-author-url"><code>init-author-url</code></h4>
    824. 

  824. <ul>
    825. 

  825. <li>Default: “”</li>
    826. 

  826. <li>Type: “” or URL</li>
    827. 

  827. </ul>
    828. 

  828. <p>The value <code>npm init</code> should use by default for the package author’s
    829. 

  829. homepage.</p>
    830. 

  830. <!-- raw HTML omitted -->
    831. 

  831. <!-- raw HTML omitted -->
    832. 

  832. <h4 id="init-license"><code>init-license</code></h4>
    833. 

  833. <ul>
    834. 

  834. <li>Default: “ISC”</li>
    835. 

  835. <li>Type: String</li>
    836. 

  836. </ul>
    837. 

  837. <p>The value <code>npm init</code> should use by default for the package license.</p>
    838. 

  838. <!-- raw HTML omitted -->
    839. 

  839. <!-- raw HTML omitted -->
    840. 

  840. <h4 id="init-module"><code>init-module</code></h4>
    841. 

  841. <ul>
    842. 

  842. <li>Default: “~/.npm-init.js”</li>
    843. 

  843. <li>Type: Path</li>
    844. 

  844. </ul>
    845. 

  845. <p>A module that will be loaded by the <code>npm init</code> command. See the
    846. 

  846. documentation for the
    847. 

  847. <a href="https://github.com/npm/init-package-json">init-package-json</a> module for
    848. 

  848. more information, or <a href="../commands/npm-init.html">npm init</a>.</p>
    849. 

  849. <!-- raw HTML omitted -->
    850. 

  850. <!-- raw HTML omitted -->
    851. 

  851. <h4 id="init-version"><code>init-version</code></h4>
    852. 

  852. <ul>
    853. 

  853. <li>Default: “1.0.0”</li>
    854. 

  854. <li>Type: SemVer string</li>
    855. 

  855. </ul>
    856. 

  856. <p>The value that <code>npm init</code> should use by default for the package version
    857. 

  857. number, if not already set in package.json.</p>
    858. 

  858. <!-- raw HTML omitted -->
    859. 

  859. <!-- raw HTML omitted -->
    860. 

  860. <h4 id="json"><code>json</code></h4>
    861. 

  861. <ul>
    862. 

  862. <li>Default: false</li>
    863. 

  863. <li>Type: Boolean</li>
    864. 

  864. </ul>
    865. 

  865. <p>Whether or not to output JSON data, rather than the normal output.</p>
    866. 

  866. <ul>
    867. 

  867. <li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before
    868. 

  868. saving them to your <code>package.json</code>.</li>
    869. 

  869. </ul>
    870. 

  870. <p>Not supported by all npm commands.</p>
    871. 

  871. <!-- raw HTML omitted -->
    872. 

  872. <!-- raw HTML omitted -->
    873. 

  873. <h4 id="key"><code>key</code></h4>
    874. 

  874. <ul>
    875. 

  875. <li>Default: null</li>
    876. 

  876. <li>Type: null or String</li>
    877. 

  877. </ul>
    878. 

  878. <p>A client key to pass when accessing the registry. Values should be in PEM
    879. 

  879. format with newlines replaced by the string “\n”. For example:</p>
    880. 

  880. <pre lang="ini"><code>key="-----BEGIN PRIVATE KEY-----\nXXXX\nXXXX\n-----END PRIVATE KEY-----"
    881. 

  881. </code></pre>
    882. 

  882. <p>It is <em>not</em> the path to a key file (and there is no “keyfile” option).</p>
    883. 

  883. <!-- raw HTML omitted -->
    884. 

  884. <!-- raw HTML omitted -->
    885. 

  885. <h4 id="legacy-bundling"><code>legacy-bundling</code></h4>
    886. 

  886. <ul>
    887. 

  887. <li>Default: false</li>
    888. 

  888. <li>Type: Boolean</li>
    889. 

  889. </ul>
    890. 

  890. <p>Causes npm to install the package such that versions of npm prior to 1.4,
    891. 

  891. such as the one included with node 0.8, can install the package. This
    892. 

  892. eliminates all automatic deduping. If used with <code>global-style</code> this option
    893. 

  893. will be preferred.</p>
    894. 

  894. <!-- raw HTML omitted -->
    895. 

  895. <!-- raw HTML omitted -->
    896. 

  896. <h4 id="legacy-peer-deps"><code>legacy-peer-deps</code></h4>
    897. 

  897. <ul>
    898. 

  898. <li>Default: false</li>
    899. 

  899. <li>Type: Boolean</li>
    900. 

  900. </ul>
    901. 

  901. <p>Causes npm to completely ignore <code>peerDependencies</code> when building a package
    902. 

  902. tree, as in npm versions 3 through 6.</p>
    903. 

  903. <p>If a package cannot be installed because of overly strict <code>peerDependencies</code>
    904. 

  904. that collide, it provides a way to move forward resolving the situation.</p>
    905. 

  905. <p>This differs from <code>--omit=peer</code>, in that <code>--omit=peer</code> will avoid unpacking
    906. 

  906. <code>peerDependencies</code> on disk, but will still design a tree such that
    907. 

  907. <code>peerDependencies</code> <em>could</em> be unpacked in a correct place.</p>
    908. 

  908. <p>Use of <code>legacy-peer-deps</code> is not recommended, as it will not enforce the
    909. 

  909. <code>peerDependencies</code> contract that meta-dependencies may rely on.</p>
    910. 

  910. <!-- raw HTML omitted -->
    911. 

  911. <!-- raw HTML omitted -->
    912. 

  912. <h4 id="link"><code>link</code></h4>
    913. 

  913. <ul>
    914. 

  914. <li>Default: false</li>
    915. 

  915. <li>Type: Boolean</li>
    916. 

  916. </ul>
    917. 

  917. <p>Used with <code>npm ls</code>, limiting output to only those packages that are linked.</p>
    918. 

  918. <!-- raw HTML omitted -->
    919. 

  919. <!-- raw HTML omitted -->
    920. 

  920. <h4 id="local-address"><code>local-address</code></h4>
    921. 

  921. <ul>
    922. 

  922. <li>Default: null</li>
    923. 

  923. <li>Type: IP Address</li>
    924. 

  924. </ul>
    925. 

  925. <p>The IP address of the local interface to use when making connections to the
    926. 

  926. npm registry. Must be IPv4 in versions of Node prior to 0.12.</p>
    927. 

  927. <!-- raw HTML omitted -->
    928. 

  928. <!-- raw HTML omitted -->
    929. 

  929. <h4 id="location"><code>location</code></h4>
    930. 

  930. <ul>
    931. 

  931. <li>Default: “user” unless <code>--global</code> is passed, which will also set this value
    932. 

  932. to “global”</li>
    933. 

  933. <li>Type: “global”, “user”, or “project”</li>
    934. 

  934. </ul>
    935. 

  935. <p>When passed to <code>npm config</code> this refers to which config file to use.</p>
    936. 

  936. <!-- raw HTML omitted -->
    937. 

  937. <!-- raw HTML omitted -->
    938. 

  938. <h4 id="lockfile-version"><code>lockfile-version</code></h4>
    939. 

  939. <ul>
    940. 

  940. <li>Default: Version 2 if no lockfile or current lockfile version less than or
    941. 

  941. equal to 2, otherwise maintain current lockfile version</li>
    942. 

  942. <li>Type: null, 1, 2, 3, “1”, “2”, or “3”</li>
    943. 

  943. </ul>
    944. 

  944. <p>Set the lockfile format version to be used in package-lock.json and
    945. 

  945. npm-shrinkwrap-json files. Possible options are:</p>
    946. 

  946. <p>1: The lockfile version used by npm versions 5 and 6. Lacks some data that
    947. 

  947. is used during the install, resulting in slower and possibly less
    948. 

  948. deterministic installs. Prevents lockfile churn when interoperating with
    949. 

  949. older npm versions.</p>
    950. 

  950. <p>2: The default lockfile version used by npm version 7. Includes both the
    951. 

  951. version 1 lockfile data and version 3 lockfile data, for maximum determinism
    952. 

  952. and interoperability, at the expense of more bytes on disk.</p>
    953. 

  953. <p>3: Only the new lockfile information introduced in npm version 7. Smaller on
    954. 

  954. disk than lockfile version 2, but not interoperable with older npm versions.
    955. 

  955. Ideal if all users are on npm version 7 and higher.</p>
    956. 

  956. <!-- raw HTML omitted -->
    957. 

  957. <!-- raw HTML omitted -->
    958. 

  958. <h4 id="loglevel"><code>loglevel</code></h4>
    959. 

  959. <ul>
    960. 

  960. <li>Default: “notice”</li>
    961. 

  961. <li>Type: “silent”, “error”, “warn”, “notice”, “http”, “timing”, “info”,
    962. 

  962. “verbose”, or “silly”</li>
    963. 

  963. </ul>
    964. 

  964. <p>What level of logs to report. On failure, <em>all</em> logs are written to
    965. 

  965. <code>npm-debug.log</code> in the current working directory.</p>
    966. 

  966. <p>Any logs of a higher level than the setting are shown. The default is
    967. 

  967. “notice”.</p>
    968. 

  968. <p>See also the <code>foreground-scripts</code> config.</p>
    969. 

  969. <!-- raw HTML omitted -->
    970. 

  970. <!-- raw HTML omitted -->
    971. 

  971. <h4 id="logs-max"><code>logs-max</code></h4>
    972. 

  972. <ul>
    973. 

  973. <li>Default: 10</li>
    974. 

  974. <li>Type: Number</li>
    975. 

  975. </ul>
    976. 

  976. <p>The maximum number of log files to store.</p>
    977. 

  977. <!-- raw HTML omitted -->
    978. 

  978. <!-- raw HTML omitted -->
    979. 

  979. <h4 id="long"><code>long</code></h4>
    980. 

  980. <ul>
    981. 

  981. <li>Default: false</li>
    982. 

  982. <li>Type: Boolean</li>
    983. 

  983. </ul>
    984. 

  984. <p>Show extended information in <code>ls</code>, <code>search</code>, and <code>help-search</code>.</p>
    985. 

  985. <!-- raw HTML omitted -->
    986. 

  986. <!-- raw HTML omitted -->
    987. 

  987. <h4 id="maxsockets"><code>maxsockets</code></h4>
    988. 

  988. <ul>
    989. 

  989. <li>Default: 15</li>
    990. 

  990. <li>Type: Number</li>
    991. 

  991. </ul>
    992. 

  992. <p>The maximum number of connections to use per origin (protocol/host/port
    993. 

  993. combination).</p>
    994. 

  994. <!-- raw HTML omitted -->
    995. 

  995. <!-- raw HTML omitted -->
    996. 

  996. <h4 id="message"><code>message</code></h4>
    997. 

  997. <ul>
    998. 

  998. <li>Default: “%s”</li>
    999. 

  999. <li>Type: String</li>
    1000. 

  1000. </ul>
    1001. 

  1001. <p>Commit message which is used by <code>npm version</code> when creating version commit.</p>
    1002. 

  1002. <p>Any “%s” in the message will be replaced with the version number.</p>
    1003. 

  1003. <!-- raw HTML omitted -->
    1004. 

  1004. <!-- raw HTML omitted -->
    1005. 

  1005. <h4 id="node-options"><code>node-options</code></h4>
    1006. 

  1006. <ul>
    1007. 

  1007. <li>Default: null</li>
    1008. 

  1008. <li>Type: null or String</li>
    1009. 

  1009. </ul>
    1010. 

  1010. <p>Options to pass through to Node.js via the <code>NODE_OPTIONS</code> environment
    1011. 

  1011. variable. This does not impact how npm itself is executed but it does impact
    1012. 

  1012. how lifecycle scripts are called.</p>
    1013. 

  1013. <!-- raw HTML omitted -->
    1014. 

  1014. <!-- raw HTML omitted -->
    1015. 

  1015. <h4 id="node-version"><code>node-version</code></h4>
    1016. 

  1016. <ul>
    1017. 

  1017. <li>Default: Node.js <code>process.version</code> value</li>
    1018. 

  1018. <li>Type: SemVer string</li>
    1019. 

  1019. </ul>
    1020. 

  1020. <p>The node version to use when checking a package’s <code>engines</code> setting.</p>
    1021. 

  1021. <!-- raw HTML omitted -->
    1022. 

  1022. <!-- raw HTML omitted -->
    1023. 

  1023. <h4 id="noproxy"><code>noproxy</code></h4>
    1024. 

  1024. <ul>
    1025. 

  1025. <li>Default: The value of the NO_PROXY environment variable</li>
    1026. 

  1026. <li>Type: String (can be set multiple times)</li>
    1027. 

  1027. </ul>
    1028. 

  1028. <p>Domain extensions that should bypass any proxies.</p>
    1029. 

  1029. <p>Also accepts a comma-delimited string.</p>
    1030. 

  1030. <!-- raw HTML omitted -->
    1031. 

  1031. <!-- raw HTML omitted -->
    1032. 

  1032. <h4 id="npm-version"><code>npm-version</code></h4>
    1033. 

  1033. <ul>
    1034. 

  1034. <li>Default: Output of <code>npm --version</code></li>
    1035. 

  1035. <li>Type: SemVer string</li>
    1036. 

  1036. </ul>
    1037. 

  1037. <p>The npm version to use when checking a package’s <code>engines</code> setting.</p>
    1038. 

  1038. <!-- raw HTML omitted -->
    1039. 

  1039. <!-- raw HTML omitted -->
    1040. 

  1040. <h4 id="offline"><code>offline</code></h4>
    1041. 

  1041. <ul>
    1042. 

  1042. <li>Default: false</li>
    1043. 

  1043. <li>Type: Boolean</li>
    1044. 

  1044. </ul>
    1045. 

  1045. <p>Force offline mode: no network requests will be done during install. To
    1046. 

  1046. allow the CLI to fill in missing cache data, see <code>--prefer-offline</code>.</p>
    1047. 

  1047. <!-- raw HTML omitted -->
    1048. 

  1048. <!-- raw HTML omitted -->
    1049. 

  1049. <h4 id="omit"><code>omit</code></h4>
    1050. 

  1050. <ul>
    1051. 

  1051. <li>Default: ‘dev’ if the <code>NODE_ENV</code> environment variable is set to
    1052. 

  1052. ‘production’, otherwise empty.</li>
    1053. 

  1053. <li>Type: “dev”, “optional”, or “peer” (can be set multiple times)</li>
    1054. 

  1054. </ul>
    1055. 

  1055. <p>Dependency types to omit from the installation tree on disk.</p>
    1056. 

  1056. <p>Note that these dependencies <em>are</em> still resolved and added to the
    1057. 

  1057. <code>package-lock.json</code> or <code>npm-shrinkwrap.json</code> file. They are just not
    1058. 

  1058. physically installed on disk.</p>
    1059. 

  1059. <p>If a package type appears in both the <code>--include</code> and <code>--omit</code> lists, then
    1060. 

  1060. it will be included.</p>
    1061. 

  1061. <p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment
    1062. 

  1062. variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
    1063. 

  1063. <!-- raw HTML omitted -->
    1064. 

  1064. <!-- raw HTML omitted -->
    1065. 

  1065. <h4 id="otp"><code>otp</code></h4>
    1066. 

  1066. <ul>
    1067. 

  1067. <li>Default: null</li>
    1068. 

  1068. <li>Type: null or String</li>
    1069. 

  1069. </ul>
    1070. 

  1070. <p>This is a one-time password from a two-factor authenticator. It’s needed
    1071. 

  1071. when publishing or changing package permissions with <code>npm access</code>.</p>
    1072. 

  1072. <p>If not set, and a registry response fails with a challenge for a one-time
    1073. 

  1073. password, npm will prompt on the command line for one.</p>
    1074. 

  1074. <!-- raw HTML omitted -->
    1075. 

  1075. <!-- raw HTML omitted -->
    1076. 

  1076. <h4 id="pack-destination"><code>pack-destination</code></h4>
    1077. 

  1077. <ul>
    1078. 

  1078. <li>Default: “.”</li>
    1079. 

  1079. <li>Type: String</li>
    1080. 

  1080. </ul>
    1081. 

  1081. <p>Directory in which <code>npm pack</code> will save tarballs.</p>
    1082. 

  1082. <!-- raw HTML omitted -->
    1083. 

  1083. <!-- raw HTML omitted -->
    1084. 

  1084. <h4 id="package"><code>package</code></h4>
    1085. 

  1085. <ul>
    1086. 

  1086. <li>Default:</li>
    1087. 

  1087. <li>Type: String (can be set multiple times)</li>
    1088. 

  1088. </ul>
    1089. 

  1089. <p>The package to install for <a href="../commands/npm-exec.html"><code>npm exec</code></a></p>
    1090. 

  1090. <!-- raw HTML omitted -->
    1091. 

  1091. <!-- raw HTML omitted -->
    1092. 

  1092. <h4 id="package-lock"><code>package-lock</code></h4>
    1093. 

  1093. <ul>
    1094. 

  1094. <li>Default: true</li>
    1095. 

  1095. <li>Type: Boolean</li>
    1096. 

  1096. </ul>
    1097. 

  1097. <p>If set to false, then ignore <code>package-lock.json</code> files when installing. This
    1098. 

  1098. will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save</code> is true.</p>
    1099. 

  1099. <p>When package package-locks are disabled, automatic pruning of extraneous
    1100. 

  1100. modules will also be disabled. To remove extraneous modules with
    1101. 

  1101. package-locks disabled use <code>npm prune</code>.</p>
    1102. 

  1102. <!-- raw HTML omitted -->
    1103. 

  1103. <!-- raw HTML omitted -->
    1104. 

  1104. <h4 id="package-lock-only"><code>package-lock-only</code></h4>
    1105. 

  1105. <ul>
    1106. 

  1106. <li>Default: false</li>
    1107. 

  1107. <li>Type: Boolean</li>
    1108. 

  1108. </ul>
    1109. 

  1109. <p>If set to true, the current operation will only use the <code>package-lock.json</code>,
    1110. 

  1110. ignoring <code>node_modules</code>.</p>
    1111. 

  1111. <p>For <code>update</code> this means only the <code>package-lock.json</code> will be updated,
    1112. 

  1112. instead of checking <code>node_modules</code> and downloading dependencies.</p>
    1113. 

  1113. <p>For <code>list</code> this means the output will be based on the tree described by the
    1114. 

  1114. <code>package-lock.json</code>, rather than the contents of <code>node_modules</code>.</p>
    1115. 

  1115. <!-- raw HTML omitted -->
    1116. 

  1116. <!-- raw HTML omitted -->
    1117. 

  1117. <h4 id="parseable"><code>parseable</code></h4>
    1118. 

  1118. <ul>
    1119. 

  1119. <li>Default: false</li>
    1120. 

  1120. <li>Type: Boolean</li>
    1121. 

  1121. </ul>
    1122. 

  1122. <p>Output parseable results from commands that write to standard output. For
    1123. 

  1123. <code>npm search</code>, this will be tab-separated table format.</p>
    1124. 

  1124. <!-- raw HTML omitted -->
    1125. 

  1125. <!-- raw HTML omitted -->
    1126. 

  1126. <h4 id="prefer-offline"><code>prefer-offline</code></h4>
    1127. 

  1127. <ul>
    1128. 

  1128. <li>Default: false</li>
    1129. 

  1129. <li>Type: Boolean</li>
    1130. 

  1130. </ul>
    1131. 

  1131. <p>If true, staleness checks for cached data will be bypassed, but missing data
    1132. 

  1132. will be requested from the server. To force full offline mode, use
    1133. 

  1133. <code>--offline</code>.</p>
    1134. 

  1134. <!-- raw HTML omitted -->
    1135. 

  1135. <!-- raw HTML omitted -->
    1136. 

  1136. <h4 id="prefer-online"><code>prefer-online</code></h4>
    1137. 

  1137. <ul>
    1138. 

  1138. <li>Default: false</li>
    1139. 

  1139. <li>Type: Boolean</li>
    1140. 

  1140. </ul>
    1141. 

  1141. <p>If true, staleness checks for cached data will be forced, making the CLI
    1142. 

  1142. look for updates immediately even for fresh package data.</p>
    1143. 

  1143. <!-- raw HTML omitted -->
    1144. 

  1144. <!-- raw HTML omitted -->
    1145. 

  1145. <h4 id="prefix"><code>prefix</code></h4>
    1146. 

  1146. <ul>
    1147. 

  1147. <li>Default: In global mode, the folder where the node executable is installed.
    1148. 

  1148. In local mode, the nearest parent folder containing either a package.json
    1149. 

  1149. file or a node_modules folder.</li>
    1150. 

  1150. <li>Type: Path</li>
    1151. 

  1151. </ul>
    1152. 

  1152. <p>The location to install global items. If set on the command line, then it
    1153. 

  1153. forces non-global commands to run in the specified folder.</p>
    1154. 

  1154. <!-- raw HTML omitted -->
    1155. 

  1155. <!-- raw HTML omitted -->
    1156. 

  1156. <h4 id="preid"><code>preid</code></h4>
    1157. 

  1157. <ul>
    1158. 

  1158. <li>Default: “”</li>
    1159. 

  1159. <li>Type: String</li>
    1160. 

  1160. </ul>
    1161. 

  1161. <p>The “prerelease identifier” to use as a prefix for the “prerelease” part of
    1162. 

  1162. a semver. Like the <code>rc</code> in <code>1.2.0-rc.8</code>.</p>
    1163. 

  1163. <!-- raw HTML omitted -->
    1164. 

  1164. <!-- raw HTML omitted -->
    1165. 

  1165. <h4 id="progress"><code>progress</code></h4>
    1166. 

  1166. <ul>
    1167. 

  1167. <li>Default: <code>true</code> unless running in a known CI system</li>
    1168. 

  1168. <li>Type: Boolean</li>
    1169. 

  1169. </ul>
    1170. 

  1170. <p>When set to <code>true</code>, npm will display a progress bar during time intensive
    1171. 

  1171. operations, if <code>process.stderr</code> is a TTY.</p>
    1172. 

  1172. <p>Set to <code>false</code> to suppress the progress bar.</p>
    1173. 

  1173. <!-- raw HTML omitted -->
    1174. 

  1174. <!-- raw HTML omitted -->
    1175. 

  1175. <h4 id="proxy"><code>proxy</code></h4>
    1176. 

  1176. <ul>
    1177. 

  1177. <li>Default: null</li>
    1178. 

  1178. <li>Type: null, false, or URL</li>
    1179. 

  1179. </ul>
    1180. 

  1180. <p>A proxy to use for outgoing http requests. If the <code>HTTP_PROXY</code> or
    1181. 

  1181. <code>http_proxy</code> environment variables are set, proxy settings will be honored
    1182. 

  1182. by the underlying <code>request</code> library.</p>
    1183. 

  1183. <!-- raw HTML omitted -->
    1184. 

  1184. <!-- raw HTML omitted -->
    1185. 

  1185. <h4 id="read-only"><code>read-only</code></h4>
    1186. 

  1186. <ul>
    1187. 

  1187. <li>Default: false</li>
    1188. 

  1188. <li>Type: Boolean</li>
    1189. 

  1189. </ul>
    1190. 

  1190. <p>This is used to mark a token as unable to publish when configuring limited
    1191. 

  1191. access tokens with the <code>npm token create</code> command.</p>
    1192. 

  1192. <!-- raw HTML omitted -->
    1193. 

  1193. <!-- raw HTML omitted -->
    1194. 

  1194. <h4 id="rebuild-bundle"><code>rebuild-bundle</code></h4>
    1195. 

  1195. <ul>
    1196. 

  1196. <li>Default: true</li>
    1197. 

  1197. <li>Type: Boolean</li>
    1198. 

  1198. </ul>
    1199. 

  1199. <p>Rebuild bundled dependencies after installation.</p>
    1200. 

  1200. <!-- raw HTML omitted -->
    1201. 

  1201. <!-- raw HTML omitted -->
    1202. 

  1202. <h4 id="registry"><code>registry</code></h4>
    1203. 

  1203. <ul>
    1204. 

  1204. <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li>
    1205. 

  1205. <li>Type: URL</li>
    1206. 

  1206. </ul>
    1207. 

  1207. <p>The base URL of the npm registry.</p>
    1208. 

  1208. <!-- raw HTML omitted -->
    1209. 

  1209. <!-- raw HTML omitted -->
    1210. 

  1210. <h4 id="save"><code>save</code></h4>
    1211. 

  1211. <ul>
    1212. 

  1212. <li>Default: true</li>
    1213. 

  1213. <li>Type: Boolean</li>
    1214. 

  1214. </ul>
    1215. 

  1215. <p>Save installed packages to a package.json file as dependencies.</p>
    1216. 

  1216. <p>When used with the <code>npm rm</code> command, removes the dependency from
    1217. 

  1217. package.json.</p>
    1218. 

  1218. <!-- raw HTML omitted -->
    1219. 

  1219. <!-- raw HTML omitted -->
    1220. 

  1220. <h4 id="save-bundle"><code>save-bundle</code></h4>
    1221. 

  1221. <ul>
    1222. 

  1222. <li>Default: false</li>
    1223. 

  1223. <li>Type: Boolean</li>
    1224. 

  1224. </ul>
    1225. 

  1225. <p>If a package would be saved at install time by the use of <code>--save</code>,
    1226. 

  1226. <code>--save-dev</code>, or <code>--save-optional</code>, then also put it in the
    1227. 

  1227. <code>bundleDependencies</code> list.</p>
    1228. 

  1228. <p>Ignore if <code>--save-peer</code> is set, since peerDependencies cannot be bundled.</p>
    1229. 

  1229. <!-- raw HTML omitted -->
    1230. 

  1230. <!-- raw HTML omitted -->
    1231. 

  1231. <h4 id="save-dev"><code>save-dev</code></h4>
    1232. 

  1232. <ul>
    1233. 

  1233. <li>Default: false</li>
    1234. 

  1234. <li>Type: Boolean</li>
    1235. 

  1235. </ul>
    1236. 

  1236. <p>Save installed packages to a package.json file as <code>devDependencies</code>.</p>
    1237. 

  1237. <!-- raw HTML omitted -->
    1238. 

  1238. <!-- raw HTML omitted -->
    1239. 

  1239. <h4 id="save-exact"><code>save-exact</code></h4>
    1240. 

  1240. <ul>
    1241. 

  1241. <li>Default: false</li>
    1242. 

  1242. <li>Type: Boolean</li>
    1243. 

  1243. </ul>
    1244. 

  1244. <p>Dependencies saved to package.json will be configured with an exact version
    1245. 

  1245. rather than using npm’s default semver range operator.</p>
    1246. 

  1246. <!-- raw HTML omitted -->
    1247. 

  1247. <!-- raw HTML omitted -->
    1248. 

  1248. <h4 id="save-optional"><code>save-optional</code></h4>
    1249. 

  1249. <ul>
    1250. 

  1250. <li>Default: false</li>
    1251. 

  1251. <li>Type: Boolean</li>
    1252. 

  1252. </ul>
    1253. 

  1253. <p>Save installed packages to a package.json file as <code>optionalDependencies</code>.</p>
    1254. 

  1254. <!-- raw HTML omitted -->
    1255. 

  1255. <!-- raw HTML omitted -->
    1256. 

  1256. <h4 id="save-peer"><code>save-peer</code></h4>
    1257. 

  1257. <ul>
    1258. 

  1258. <li>Default: false</li>
    1259. 

  1259. <li>Type: Boolean</li>
    1260. 

  1260. </ul>
    1261. 

  1261. <p>Save installed packages. to a package.json file as <code>peerDependencies</code></p>
    1262. 

  1262. <!-- raw HTML omitted -->
    1263. 

  1263. <!-- raw HTML omitted -->
    1264. 

  1264. <h4 id="save-prefix"><code>save-prefix</code></h4>
    1265. 

  1265. <ul>
    1266. 

  1266. <li>Default: “^”</li>
    1267. 

  1267. <li>Type: String</li>
    1268. 

  1268. </ul>
    1269. 

  1269. <p>Configure how versions of packages installed to a package.json file via
    1270. 

  1270. <code>--save</code> or <code>--save-dev</code> get prefixed.</p>
    1271. 

  1271. <p>For example if a package has version <code>1.2.3</code>, by default its version is set
    1272. 

  1272. to <code>^1.2.3</code> which allows minor upgrades for that package, but after <code>npm config set save-prefix='~'</code> it would be set to <code>~1.2.3</code> which only allows
    1273. 

  1273. patch upgrades.</p>
    1274. 

  1274. <!-- raw HTML omitted -->
    1275. 

  1275. <!-- raw HTML omitted -->
    1276. 

  1276. <h4 id="save-prod"><code>save-prod</code></h4>
    1277. 

  1277. <ul>
    1278. 

  1278. <li>Default: false</li>
    1279. 

  1279. <li>Type: Boolean</li>
    1280. 

  1280. </ul>
    1281. 

  1281. <p>Save installed packages into <code>dependencies</code> specifically. This is useful if
    1282. 

  1282. a package already exists in <code>devDependencies</code> or <code>optionalDependencies</code>, but
    1283. 

  1283. you want to move it to be a non-optional production dependency.</p>
    1284. 

  1284. <p>This is the default behavior if <code>--save</code> is true, and neither <code>--save-dev</code>
    1285. 

  1285. or <code>--save-optional</code> are true.</p>
    1286. 

  1286. <!-- raw HTML omitted -->
    1287. 

  1287. <!-- raw HTML omitted -->
    1288. 

  1288. <h4 id="scope"><code>scope</code></h4>
    1289. 

  1289. <ul>
    1290. 

  1290. <li>Default: the scope of the current project, if any, or “”</li>
    1291. 

  1291. <li>Type: String</li>
    1292. 

  1292. </ul>
    1293. 

  1293. <p>Associate an operation with a scope for a scoped registry.</p>
    1294. 

  1294. <p>Useful when logging in to or out of a private registry:</p>
    1295. 

  1295. <pre><code># log in, linking the scope to the custom registry
    1296. 

  1296. npm login --scope=@mycorp --registry=https://registry.mycorp.com
    1297. 

  1297. 

  1298. # log out, removing the link and the auth token
    1299. 

  1299. npm logout --scope=@mycorp
    1300. 

  1300. </code></pre>
    1301. 

  1301. <p>This will cause <code>@mycorp</code> to be mapped to the registry for future
    1302. 

  1302. installation of packages specified according to the pattern
    1303. 

  1303. <code>@mycorp/package</code>.</p>
    1304. 

  1304. <p>This will also cause <code>npm init</code> to create a scoped package.</p>
    1305. 

  1305. <pre><code># accept all defaults, and create a package named "@foo/whatever",
    1306. 

  1306. # instead of just named "whatever"
    1307. 

  1307. npm init --scope=@foo --yes
    1308. 

  1308. </code></pre>
    1309. 

  1309. <!-- raw HTML omitted -->
    1310. 

  1310. <!-- raw HTML omitted -->
    1311. 

  1311. <h4 id="script-shell"><code>script-shell</code></h4>
    1312. 

  1312. <ul>
    1313. 

  1313. <li>Default: ‘/bin/sh’ on POSIX systems, ‘cmd.exe’ on Windows</li>
    1314. 

  1314. <li>Type: null or String</li>
    1315. 

  1315. </ul>
    1316. 

  1316. <p>The shell to use for scripts run with the <code>npm exec</code>, <code>npm run</code> and <code>npm init &lt;pkg&gt;</code> commands.</p>
    1317. 

  1317. <!-- raw HTML omitted -->
    1318. 

  1318. <!-- raw HTML omitted -->
    1319. 

  1319. <h4 id="searchexclude"><code>searchexclude</code></h4>
    1320. 

  1320. <ul>
    1321. 

  1321. <li>Default: “”</li>
    1322. 

  1322. <li>Type: String</li>
    1323. 

  1323. </ul>
    1324. 

  1324. <p>Space-separated options that limit the results from search.</p>
    1325. 

  1325. <!-- raw HTML omitted -->
    1326. 

  1326. <!-- raw HTML omitted -->
    1327. 

  1327. <h4 id="searchlimit"><code>searchlimit</code></h4>
    1328. 

  1328. <ul>
    1329. 

  1329. <li>Default: 20</li>
    1330. 

  1330. <li>Type: Number</li>
    1331. 

  1331. </ul>
    1332. 

  1332. <p>Number of items to limit search results to. Will not apply at all to legacy
    1333. 

  1333. searches.</p>
    1334. 

  1334. <!-- raw HTML omitted -->
    1335. 

  1335. <!-- raw HTML omitted -->
    1336. 

  1336. <h4 id="searchopts"><code>searchopts</code></h4>
    1337. 

  1337. <ul>
    1338. 

  1338. <li>Default: “”</li>
    1339. 

  1339. <li>Type: String</li>
    1340. 

  1340. </ul>
    1341. 

  1341. <p>Space-separated options that are always passed to search.</p>
    1342. 

  1342. <!-- raw HTML omitted -->
    1343. 

  1343. <!-- raw HTML omitted -->
    1344. 

  1344. <h4 id="searchstaleness"><code>searchstaleness</code></h4>
    1345. 

  1345. <ul>
    1346. 

  1346. <li>Default: 900</li>
    1347. 

  1347. <li>Type: Number</li>
    1348. 

  1348. </ul>
    1349. 

  1349. <p>The age of the cache, in seconds, before another registry request is made if
    1350. 

  1350. using legacy search endpoint.</p>
    1351. 

  1351. <!-- raw HTML omitted -->
    1352. 

  1352. <!-- raw HTML omitted -->
    1353. 

  1353. <h4 id="shell"><code>shell</code></h4>
    1354. 

  1354. <ul>
    1355. 

  1355. <li>Default: SHELL environment variable, or “bash” on Posix, or “cmd.exe” on
    1356. 

  1356. Windows</li>
    1357. 

  1357. <li>Type: String</li>
    1358. 

  1358. </ul>
    1359. 

  1359. <p>The shell to run for the <code>npm explore</code> command.</p>
    1360. 

  1360. <!-- raw HTML omitted -->
    1361. 

  1361. <!-- raw HTML omitted -->
    1362. 

  1362. <h4 id="sign-git-commit"><code>sign-git-commit</code></h4>
    1363. 

  1363. <ul>
    1364. 

  1364. <li>Default: false</li>
    1365. 

  1365. <li>Type: Boolean</li>
    1366. 

  1366. </ul>
    1367. 

  1367. <p>If set to true, then the <code>npm version</code> command will commit the new package
    1368. 

  1368. version using <code>-S</code> to add a signature.</p>
    1369. 

  1369. <p>Note that git requires you to have set up GPG keys in your git configs for
    1370. 

  1370. this to work properly.</p>
    1371. 

  1371. <!-- raw HTML omitted -->
    1372. 

  1372. <!-- raw HTML omitted -->
    1373. 

  1373. <h4 id="sign-git-tag"><code>sign-git-tag</code></h4>
    1374. 

  1374. <ul>
    1375. 

  1375. <li>Default: false</li>
    1376. 

  1376. <li>Type: Boolean</li>
    1377. 

  1377. </ul>
    1378. 

  1378. <p>If set to true, then the <code>npm version</code> command will tag the version using
    1379. 

  1379. <code>-s</code> to add a signature.</p>
    1380. 

  1380. <p>Note that git requires you to have set up GPG keys in your git configs for
    1381. 

  1381. this to work properly.</p>
    1382. 

  1382. <!-- raw HTML omitted -->
    1383. 

  1383. <!-- raw HTML omitted -->
    1384. 

  1384. <h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4>
    1385. 

  1385. <ul>
    1386. 

  1386. <li>Default: false</li>
    1387. 

  1387. <li>Type: Boolean</li>
    1388. 

  1388. </ul>
    1389. 

  1389. <p>If set to <code>true</code>, and <code>--legacy-peer-deps</code> is not set, then <em>any</em>
    1390. 

  1390. conflicting <code>peerDependencies</code> will be treated as an install failure, even
    1391. 

  1391. if npm could reasonably guess the appropriate resolution based on non-peer
    1392. 

  1392. dependency relationships.</p>
    1393. 

  1393. <p>By default, conflicting <code>peerDependencies</code> deep in the dependency graph will
    1394. 

  1394. be resolved using the nearest non-peer dependency specification, even if
    1395. 

  1395. doing so will result in some packages receiving a peer dependency outside
    1396. 

  1396. the range set in their package’s <code>peerDependencies</code> object.</p>
    1397. 

  1397. <p>When such and override is performed, a warning is printed, explaining the
    1398. 

  1398. conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then
    1399. 

  1399. this warning is treated as a failure.</p>
    1400. 

  1400. <!-- raw HTML omitted -->
    1401. 

  1401. <!-- raw HTML omitted -->
    1402. 

  1402. <h4 id="strict-ssl"><code>strict-ssl</code></h4>
    1403. 

  1403. <ul>
    1404. 

  1404. <li>Default: true</li>
    1405. 

  1405. <li>Type: Boolean</li>
    1406. 

  1406. </ul>
    1407. 

  1407. <p>Whether or not to do SSL key validation when making requests to the registry
    1408. 

  1408. via https.</p>
    1409. 

  1409. <p>See also the <code>ca</code> config.</p>
    1410. 

  1410. <!-- raw HTML omitted -->
    1411. 

  1411. <!-- raw HTML omitted -->
    1412. 

  1412. <h4 id="tag"><code>tag</code></h4>
    1413. 

  1413. <ul>
    1414. 

  1414. <li>Default: “latest”</li>
    1415. 

  1415. <li>Type: String</li>
    1416. 

  1416. </ul>
    1417. 

  1417. <p>If you ask npm to install a package and don’t tell it a specific version,
    1418. 

  1418. then it will install the specified tag.</p>
    1419. 

  1419. <p>Also the tag that is added to the package@version specified by the <code>npm tag</code>
    1420. 

  1420. command, if no explicit tag is given.</p>
    1421. 

  1421. <p>When used by the <code>npm diff</code> command, this is the tag used to fetch the
    1422. 

  1422. tarball that will be compared with the local files by default.</p>
    1423. 

  1423. <!-- raw HTML omitted -->
    1424. 

  1424. <!-- raw HTML omitted -->
    1425. 

  1425. <h4 id="tag-version-prefix"><code>tag-version-prefix</code></h4>
    1426. 

  1426. <ul>
    1427. 

  1427. <li>Default: “v”</li>
    1428. 

  1428. <li>Type: String</li>
    1429. 

  1429. </ul>
    1430. 

  1430. <p>If set, alters the prefix used when tagging a new version when performing a
    1431. 

  1431. version increment using <code>npm-version</code>. To remove the prefix altogether, set
    1432. 

  1432. it to the empty string: <code>""</code>.</p>
    1433. 

  1433. <p>Because other tools may rely on the convention that npm version tags look
    1434. 

  1434. like <code>v1.0.0</code>, <em>only use this property if it is absolutely necessary</em>. In
    1435. 

  1435. particular, use care when overriding this setting for public packages.</p>
    1436. 

  1436. <!-- raw HTML omitted -->
    1437. 

  1437. <!-- raw HTML omitted -->
    1438. 

  1438. <h4 id="timing"><code>timing</code></h4>
    1439. 

  1439. <ul>
    1440. 

  1440. <li>Default: false</li>
    1441. 

  1441. <li>Type: Boolean</li>
    1442. 

  1442. </ul>
    1443. 

  1443. <p>If true, writes an <code>npm-debug</code> log to <code>_logs</code> and timing information to
    1444. 

  1444. <code>_timing.json</code>, both in your cache, even if the command completes
    1445. 

  1445. successfully. <code>_timing.json</code> is a newline delimited list of JSON objects.</p>
    1446. 

  1446. <p>You can quickly view it with this <a href="https://npm.im/json">json</a> command line:
    1447. 

  1447. <code>npm exec -- json -g &lt; ~/.npm/_timing.json</code>.</p>
    1448. 

  1448. <!-- raw HTML omitted -->
    1449. 

  1449. <!-- raw HTML omitted -->
    1450. 

  1450. <h4 id="umask"><code>umask</code></h4>
    1451. 

  1451. <ul>
    1452. 

  1452. <li>Default: 0</li>
    1453. 

  1453. <li>Type: Octal numeric string in range 0000..0777 (0..511)</li>
    1454. 

  1454. </ul>
    1455. 

  1455. <p>The “umask” value to use when setting the file creation mode on files and
    1456. 

  1456. folders.</p>
    1457. 

  1457. <p>Folders and executables are given a mode which is <code>0o777</code> masked against
    1458. 

  1458. this value. Other files are given a mode which is <code>0o666</code> masked against
    1459. 

  1459. this value.</p>
    1460. 

  1460. <p>Note that the underlying system will <em>also</em> apply its own umask value to
    1461. 

  1461. files and folders that are created, and npm does not circumvent this, but
    1462. 

  1462. rather adds the <code>--umask</code> config to it.</p>
    1463. 

  1463. <p>Thus, the effective default umask value on most POSIX systems is 0o22,
    1464. 

  1464. meaning that folders and executables are created with a mode of 0o755 and
    1465. 

  1465. other files are created with a mode of 0o644.</p>
    1466. 

  1466. <!-- raw HTML omitted -->
    1467. 

  1467. <!-- raw HTML omitted -->
    1468. 

  1468. <h4 id="unicode"><code>unicode</code></h4>
    1469. 

  1469. <ul>
    1470. 

  1470. <li>Default: false on windows, true on mac/unix systems with a unicode locale,
    1471. 

  1471. as defined by the <code>LC_ALL</code>, <code>LC_CTYPE</code>, or <code>LANG</code> environment variables.</li>
    1472. 

  1472. <li>Type: Boolean</li>
    1473. 

  1473. </ul>
    1474. 

  1474. <p>When set to true, npm uses unicode characters in the tree output. When
    1475. 

  1475. false, it uses ascii characters instead of unicode glyphs.</p>
    1476. 

  1476. <!-- raw HTML omitted -->
    1477. 

  1477. <!-- raw HTML omitted -->
    1478. 

  1478. <h4 id="update-notifier"><code>update-notifier</code></h4>
    1479. 

  1479. <ul>
    1480. 

  1480. <li>Default: true</li>
    1481. 

  1481. <li>Type: Boolean</li>
    1482. 

  1482. </ul>
    1483. 

  1483. <p>Set to false to suppress the update notification when using an older version
    1484. 

  1484. of npm than the latest.</p>
    1485. 

  1485. <!-- raw HTML omitted -->
    1486. 

  1486. <!-- raw HTML omitted -->
    1487. 

  1487. <h4 id="usage"><code>usage</code></h4>
    1488. 

  1488. <ul>
    1489. 

  1489. <li>Default: false</li>
    1490. 

  1490. <li>Type: Boolean</li>
    1491. 

  1491. </ul>
    1492. 

  1492. <p>Show short usage output about the command specified.</p>
    1493. 

  1493. <!-- raw HTML omitted -->
    1494. 

  1494. <!-- raw HTML omitted -->
    1495. 

  1495. <h4 id="user-agent"><code>user-agent</code></h4>
    1496. 

  1496. <ul>
    1497. 

  1497. <li>Default: “npm/{npm-version} node/{node-version} {platform} {arch}
    1498. 

  1498. workspaces/{workspaces} {ci}”</li>
    1499. 

  1499. <li>Type: String</li>
    1500. 

  1500. </ul>
    1501. 

  1501. <p>Sets the User-Agent request header. The following fields are replaced with
    1502. 

  1502. their actual counterparts:</p>
    1503. 

  1503. <ul>
    1504. 

  1504. <li><code>{npm-version}</code> - The npm version in use</li>
    1505. 

  1505. <li><code>{node-version}</code> - The Node.js version in use</li>
    1506. 

  1506. <li><code>{platform}</code> - The value of <code>process.platform</code></li>
    1507. 

  1507. <li><code>{arch}</code> - The value of <code>process.arch</code></li>
    1508. 

  1508. <li><code>{workspaces}</code> - Set to <code>true</code> if the <code>workspaces</code> or <code>workspace</code> options
    1509. 

  1509. are set.</li>
    1510. 

  1510. <li><code>{ci}</code> - The value of the <code>ci-name</code> config, if set, prefixed with <code>ci/</code>, or
    1511. 

  1511. an empty string if <code>ci-name</code> is empty.</li>
    1512. 

  1512. </ul>
    1513. 

  1513. <!-- raw HTML omitted -->
    1514. 

  1514. <!-- raw HTML omitted -->
    1515. 

  1515. <h4 id="userconfig"><code>userconfig</code></h4>
    1516. 

  1516. <ul>
    1517. 

  1517. <li>Default: “~/.npmrc”</li>
    1518. 

  1518. <li>Type: Path</li>
    1519. 

  1519. </ul>
    1520. 

  1520. <p>The location of user-level configuration settings.</p>
    1521. 

  1521. <p>This may be overridden by the <code>npm_config_userconfig</code> environment variable
    1522. 

  1522. or the <code>--userconfig</code> command line option, but may <em>not</em> be overridden by
    1523. 

  1523. settings in the <code>globalconfig</code> file.</p>
    1524. 

  1524. <!-- raw HTML omitted -->
    1525. 

  1525. <!-- raw HTML omitted -->
    1526. 

  1526. <h4 id="version"><code>version</code></h4>
    1527. 

  1527. <ul>
    1528. 

  1528. <li>Default: false</li>
    1529. 

  1529. <li>Type: Boolean</li>
    1530. 

  1530. </ul>
    1531. 

  1531. <p>If true, output the npm version and exit successfully.</p>
    1532. 

  1532. <p>Only relevant when specified explicitly on the command line.</p>
    1533. 

  1533. <!-- raw HTML omitted -->
    1534. 

  1534. <!-- raw HTML omitted -->
    1535. 

  1535. <h4 id="versions"><code>versions</code></h4>
    1536. 

  1536. <ul>
    1537. 

  1537. <li>Default: false</li>
    1538. 

  1538. <li>Type: Boolean</li>
    1539. 

  1539. </ul>
    1540. 

  1540. <p>If true, output the npm version as well as node’s <code>process.versions</code> map and
    1541. 

  1541. the version in the current working directory’s <code>package.json</code> file if one
    1542. 

  1542. exists, and exit successfully.</p>
    1543. 

  1543. <p>Only relevant when specified explicitly on the command line.</p>
    1544. 

  1544. <!-- raw HTML omitted -->
    1545. 

  1545. <!-- raw HTML omitted -->
    1546. 

  1546. <h4 id="viewer"><code>viewer</code></h4>
    1547. 

  1547. <ul>
    1548. 

  1548. <li>Default: “man” on Posix, “browser” on Windows</li>
    1549. 

  1549. <li>Type: String</li>
    1550. 

  1550. </ul>
    1551. 

  1551. <p>The program to use to view help content.</p>
    1552. 

  1552. <p>Set to <code>"browser"</code> to view html help content in the default web browser.</p>
    1553. 

  1553. <!-- raw HTML omitted -->
    1554. 

  1554. <!-- raw HTML omitted -->
    1555. 

  1555. <h4 id="which"><code>which</code></h4>
    1556. 

  1556. <ul>
    1557. 

  1557. <li>Default: null</li>
    1558. 

  1558. <li>Type: null or Number</li>
    1559. 

  1559. </ul>
    1560. 

  1560. <p>If there are multiple funding sources, which 1-indexed source URL to open.</p>
    1561. 

  1561. <!-- raw HTML omitted -->
    1562. 

  1562. <!-- raw HTML omitted -->
    1563. 

  1563. <h4 id="workspace"><code>workspace</code></h4>
    1564. 

  1564. <ul>
    1565. 

  1565. <li>Default:</li>
    1566. 

  1566. <li>Type: String (can be set multiple times)</li>
    1567. 

  1567. </ul>
    1568. 

  1568. <p>Enable running a command in the context of the configured workspaces of the
    1569. 

  1569. current project while filtering by running only the workspaces defined by
    1570. 

  1570. this configuration option.</p>
    1571. 

  1571. <p>Valid values for the <code>workspace</code> config are either:</p>
    1572. 

  1572. <ul>
    1573. 

  1573. <li>Workspace names</li>
    1574. 

  1574. <li>Path to a workspace directory</li>
    1575. 

  1575. <li>Path to a parent workspace directory (will result in selecting all
    1576. 

  1576. workspaces within that folder)</li>
    1577. 

  1577. </ul>
    1578. 

  1578. <p>When set for the <code>npm init</code> command, this may be set to the folder of a
    1579. 

  1579. workspace which does not yet exist, to create the folder and set it up as a
    1580. 

  1580. brand new workspace within the project.</p>
    1581. 

  1581. <p>This value is not exported to the environment for child processes.</p>
    1582. 

  1582. <!-- raw HTML omitted -->
    1583. 

  1583. <!-- raw HTML omitted -->
    1584. 

  1584. <h4 id="workspaces"><code>workspaces</code></h4>
    1585. 

  1585. <ul>
    1586. 

  1586. <li>Default: null</li>
    1587. 

  1587. <li>Type: null or Boolean</li>
    1588. 

  1588. </ul>
    1589. 

  1589. <p>Set to true to run the command in the context of <strong>all</strong> configured
    1590. 

  1590. workspaces.</p>
    1591. 

  1591. <p>Explicitly setting this to false will cause commands like <code>install</code> to
    1592. 

  1592. ignore workspaces altogether. When not set explicitly:</p>
    1593. 

  1593. <ul>
    1594. 

  1594. <li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
    1595. 

  1595. will link workspaces into the <code>node_modules</code> folder. - Commands that do
    1596. 

  1596. other things (test, exec, publish, etc.) will operate on the root project,
    1597. 

  1597. <em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
    1598. 

  1598. </ul>
    1599. 

  1599. <p>This value is not exported to the environment for child processes.</p>
    1600. 

  1600. <!-- raw HTML omitted -->
    1601. 

  1601. <!-- raw HTML omitted -->
    1602. 

  1602. <h4 id="yes"><code>yes</code></h4>
    1603. 

  1603. <ul>
    1604. 

  1604. <li>Default: null</li>
    1605. 

  1605. <li>Type: null or Boolean</li>
    1606. 

  1606. </ul>
    1607. 

  1607. <p>Automatically answer “yes” to any prompts that npm might print on the
    1608. 

  1608. command line.</p>
    1609. 

  1609. <!-- raw HTML omitted -->
    1610. 

  1610. <!-- raw HTML omitted -->
    1611. 

  1611. <h4 id="also"><code>also</code></h4>
    1612. 

  1612. <ul>
    1613. 

  1613. <li>Default: null</li>
    1614. 

  1614. <li>Type: null, “dev”, or “development”</li>
    1615. 

  1615. <li>DEPRECATED: Please use –include=dev instead.</li>
    1616. 

  1616. </ul>
    1617. 

  1617. <p>When set to <code>dev</code> or <code>development</code>, this is an alias for <code>--include=dev</code>.</p>
    1618. 

  1618. <!-- raw HTML omitted -->
    1619. 

  1619. <!-- raw HTML omitted -->
    1620. 

  1620. <h4 id="auth-type"><code>auth-type</code></h4>
    1621. 

  1621. <ul>
    1622. 

  1622. <li>Default: “legacy”</li>
    1623. 

  1623. <li>Type: “legacy”, “sso”, “saml”, or “oauth”</li>
    1624. 

  1624. <li>DEPRECATED: This method of SSO/SAML/OAuth is deprecated and will be removed
    1625. 

  1625. in a future version of npm in favor of web-based login.</li>
    1626. 

  1626. </ul>
    1627. 

  1627. <p>What authentication strategy to use with <code>adduser</code>/<code>login</code>.</p>
    1628. 

  1628. <!-- raw HTML omitted -->
    1629. 

  1629. <!-- raw HTML omitted -->
    1630. 

  1630. <h4 id="cache-max"><code>cache-max</code></h4>
    1631. 

  1631. <ul>
    1632. 

  1632. <li>Default: Infinity</li>
    1633. 

  1633. <li>Type: Number</li>
    1634. 

  1634. <li>DEPRECATED: This option has been deprecated in favor of <code>--prefer-online</code></li>
    1635. 

  1635. </ul>
    1636. 

  1636. <p><code>--cache-max=0</code> is an alias for <code>--prefer-online</code></p>
    1637. 

  1637. <!-- raw HTML omitted -->
    1638. 

  1638. <!-- raw HTML omitted -->
    1639. 

  1639. <h4 id="cache-min"><code>cache-min</code></h4>
    1640. 

  1640. <ul>
    1641. 

  1641. <li>Default: 0</li>
    1642. 

  1642. <li>Type: Number</li>
    1643. 

  1643. <li>DEPRECATED: This option has been deprecated in favor of <code>--prefer-offline</code>.</li>
    1644. 

  1644. </ul>
    1645. 

  1645. <p><code>--cache-min=9999 (or bigger)</code> is an alias for <code>--prefer-offline</code>.</p>
    1646. 

  1646. <!-- raw HTML omitted -->
    1647. 

  1647. <!-- raw HTML omitted -->
    1648. 

  1648. <h4 id="dev"><code>dev</code></h4>
    1649. 

  1649. <ul>
    1650. 

  1650. <li>Default: false</li>
    1651. 

  1651. <li>Type: Boolean</li>
    1652. 

  1652. <li>DEPRECATED: Please use –include=dev instead.</li>
    1653. 

  1653. </ul>
    1654. 

  1654. <p>Alias for <code>--include=dev</code>.</p>
    1655. 

  1655. <!-- raw HTML omitted -->
    1656. 

  1656. <!-- raw HTML omitted -->
    1657. 

  1657. <h4 id="initauthoremail"><code>init.author.email</code></h4>
    1658. 

  1658. <ul>
    1659. 

  1659. <li>Default: “”</li>
    1660. 

  1660. <li>Type: String</li>
    1661. 

  1661. <li>DEPRECATED: Use <code>--init-author-email</code> instead.</li>
    1662. 

  1662. </ul>
    1663. 

  1663. <p>Alias for <code>--init-author-email</code></p>
    1664. 

  1664. <!-- raw HTML omitted -->
    1665. 

  1665. <!-- raw HTML omitted -->
    1666. 

  1666. <h4 id="initauthorname"><code>init.author.name</code></h4>
    1667. 

  1667. <ul>
    1668. 

  1668. <li>Default: “”</li>
    1669. 

  1669. <li>Type: String</li>
    1670. 

  1670. <li>DEPRECATED: Use <code>--init-author-name</code> instead.</li>
    1671. 

  1671. </ul>
    1672. 

  1672. <p>Alias for <code>--init-author-name</code></p>
    1673. 

  1673. <!-- raw HTML omitted -->
    1674. 

  1674. <!-- raw HTML omitted -->
    1675. 

  1675. <h4 id="initauthorurl"><code>init.author.url</code></h4>
    1676. 

  1676. <ul>
    1677. 

  1677. <li>Default: “”</li>
    1678. 

  1678. <li>Type: “” or URL</li>
    1679. 

  1679. <li>DEPRECATED: Use <code>--init-author-url</code> instead.</li>
    1680. 

  1680. </ul>
    1681. 

  1681. <p>Alias for <code>--init-author-url</code></p>
    1682. 

  1682. <!-- raw HTML omitted -->
    1683. 

  1683. <!-- raw HTML omitted -->
    1684. 

  1684. <h4 id="initlicense"><code>init.license</code></h4>
    1685. 

  1685. <ul>
    1686. 

  1686. <li>Default: “ISC”</li>
    1687. 

  1687. <li>Type: String</li>
    1688. 

  1688. <li>DEPRECATED: Use <code>--init-license</code> instead.</li>
    1689. 

  1689. </ul>
    1690. 

  1690. <p>Alias for <code>--init-license</code></p>
    1691. 

  1691. <!-- raw HTML omitted -->
    1692. 

  1692. <!-- raw HTML omitted -->
    1693. 

  1693. <h4 id="initmodule"><code>init.module</code></h4>
    1694. 

  1694. <ul>
    1695. 

  1695. <li>Default: “~/.npm-init.js”</li>
    1696. 

  1696. <li>Type: Path</li>
    1697. 

  1697. <li>DEPRECATED: Use <code>--init-module</code> instead.</li>
    1698. 

  1698. </ul>
    1699. 

  1699. <p>Alias for <code>--init-module</code></p>
    1700. 

  1700. <!-- raw HTML omitted -->
    1701. 

  1701. <!-- raw HTML omitted -->
    1702. 

  1702. <h4 id="initversion"><code>init.version</code></h4>
    1703. 

  1703. <ul>
    1704. 

  1704. <li>Default: “1.0.0”</li>
    1705. 

  1705. <li>Type: SemVer string</li>
    1706. 

  1706. <li>DEPRECATED: Use <code>--init-version</code> instead.</li>
    1707. 

  1707. </ul>
    1708. 

  1708. <p>Alias for <code>--init-version</code></p>
    1709. 

  1709. <!-- raw HTML omitted -->
    1710. 

  1710. <!-- raw HTML omitted -->
    1711. 

  1711. <h4 id="only"><code>only</code></h4>
    1712. 

  1712. <ul>
    1713. 

  1713. <li>Default: null</li>
    1714. 

  1714. <li>Type: null, “prod”, or “production”</li>
    1715. 

  1715. <li>DEPRECATED: Use <code>--omit=dev</code> to omit dev dependencies from the install.</li>
    1716. 

  1716. </ul>
    1717. 

  1717. <p>When set to <code>prod</code> or <code>production</code>, this is an alias for <code>--omit=dev</code>.</p>
    1718. 

  1718. <!-- raw HTML omitted -->
    1719. 

  1719. <!-- raw HTML omitted -->
    1720. 

  1720. <h4 id="optional"><code>optional</code></h4>
    1721. 

  1721. <ul>
    1722. 

  1722. <li>Default: null</li>
    1723. 

  1723. <li>Type: null or Boolean</li>
    1724. 

  1724. <li>DEPRECATED: Use <code>--omit=optional</code> to exclude optional dependencies, or
    1725. 

  1725. <code>--include=optional</code> to include them.</li>
    1726. 

  1726. </ul>
    1727. 

  1727. <p>Default value does install optional deps unless otherwise omitted.</p>
    1728. 

  1728. <p>Alias for –include=optional or –omit=optional</p>
    1729. 

  1729. <!-- raw HTML omitted -->
    1730. 

  1730. <!-- raw HTML omitted -->
    1731. 

  1731. <h4 id="production"><code>production</code></h4>
    1732. 

  1732. <ul>
    1733. 

  1733. <li>Default: null</li>
    1734. 

  1734. <li>Type: null or Boolean</li>
    1735. 

  1735. <li>DEPRECATED: Use <code>--omit=dev</code> instead.</li>
    1736. 

  1736. </ul>
    1737. 

  1737. <p>Alias for <code>--omit=dev</code></p>
    1738. 

  1738. <!-- raw HTML omitted -->
    1739. 

  1739. <!-- raw HTML omitted -->
    1740. 

  1740. <h4 id="shrinkwrap"><code>shrinkwrap</code></h4>
    1741. 

  1741. <ul>
    1742. 

  1742. <li>Default: true</li>
    1743. 

  1743. <li>Type: Boolean</li>
    1744. 

  1744. <li>DEPRECATED: Use the –package-lock setting instead.</li>
    1745. 

  1745. </ul>
    1746. 

  1746. <p>Alias for –package-lock</p>
    1747. 

  1747. <!-- raw HTML omitted -->
    1748. 

  1748. <!-- raw HTML omitted -->
    1749. 

  1749. <h4 id="sso-poll-frequency"><code>sso-poll-frequency</code></h4>
    1750. 

  1750. <ul>
    1751. 

  1751. <li>Default: 500</li>
    1752. 

  1752. <li>Type: Number</li>
    1753. 

  1753. <li>DEPRECATED: The –auth-type method of SSO/SAML/OAuth will be removed in a
    1754. 

  1754. future version of npm in favor of web-based login.</li>
    1755. 

  1755. </ul>
    1756. 

  1756. <p>When used with SSO-enabled <code>auth-type</code>s, configures how regularly the
    1757. 

  1757. registry should be polled while the user is completing authentication.</p>
    1758. 

  1758. <!-- raw HTML omitted -->
    1759. 

  1759. <!-- raw HTML omitted -->
    1760. 

  1760. <h4 id="sso-type"><code>sso-type</code></h4>
    1761. 

  1761. <ul>
    1762. 

  1762. <li>Default: “oauth”</li>
    1763. 

  1763. <li>Type: null, “oauth”, or “saml”</li>
    1764. 

  1764. <li>DEPRECATED: The –auth-type method of SSO/SAML/OAuth will be removed in a
    1765. 

  1765. future version of npm in favor of web-based login.</li>
    1766. 

  1766. </ul>
    1767. 

  1767. <p>If <code>--auth-type=sso</code>, the type of SSO type to use.</p>
    1768. 

  1768. <!-- raw HTML omitted -->
    1769. 

  1769. <!-- raw HTML omitted -->
    1770. 

  1770. <h4 id="tmp"><code>tmp</code></h4>
    1771. 

  1771. <ul>
    1772. 

  1772. <li>Default: The value returned by the Node.js <code>os.tmpdir()</code> method
    1773. 

  1773. <a href="https://nodejs.org/api/os.html#os_os_tmpdir">https://nodejs.org/api/os.html#os_os_tmpdir</a></li>
    1774. 

  1774. <li>Type: Path</li>
    1775. 

  1775. <li>DEPRECATED: This setting is no longer used. npm stores temporary files in a
    1776. 

  1776. special location in the cache, and they are managed by
    1777. 

  1777. <a href="http://npm.im/cacache"><code>cacache</code></a>.</li>
    1778. 

  1778. </ul>
    1779. 

  1779. <p>Historically, the location where temporary files were stored. No longer
    1780. 

  1780. relevant.</p>
    1781. 

  1781. <!-- raw HTML omitted -->
    1782. 

  1782. <!-- raw HTML omitted -->
    1783. 

  1783. <!-- raw HTML omitted -->
    1784. 

  1784. <h3 id="see-also">See also</h3>
    1785. 

  1785. <ul>
    1786. 

  1786. <li><a href="../commands/npm-config.html">npm config</a></li>
    1787. 

  1787. <li><a href="../configuring-npm/npmrc.html">npmrc</a></li>
    1788. 

  1788. <li><a href="../using-npm/scripts.html">npm scripts</a></li>
    1789. 

  1789. <li><a href="../configuring-npm/folders.html">npm folders</a></li>
    1790. 

  1790. <li><a href="../commands/npm.html">npm</a></li>
    1791. 

  1791. </ul>
    1792. 

  1792. </div>
    1793. 

  1793. 

  1794. <footer id="edit">
    1795. 

  1795. <a href="https://github.com/npm/cli/edit/latest/docs/content/using-npm/config.md">
    1796. 

  1796. <svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
    1797. 

  1797. <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>
    1798. 

  1798. </svg>
    1799. 

  1799. Edit this page on GitHub
    1800. 

  1800. </a>
    1801. 

  1801. </footer>
    1802. 

  1802. </section>
    1803. 

  1803. 

  1804. 

  1805. 

  1806. </body></html>
    1807.