Simple email application for Android. Original source code: https://framagit.org/dystopia-project/simple-email
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1691 lines
37 KiB

  1. .TH "NPM\-CONFIG" "7" "August 2018" "" ""
  2. .SH "NAME"
  3. \fBnpm-config\fR \- More than you probably want to know about npm configuration
  4. .SH DESCRIPTION
  5. .P
  6. npm gets its configuration values from the following sources, sorted by priority:
  7. .SS Command Line Flags
  8. .P
  9. Putting \fB\-\-foo bar\fP on the command line sets the \fBfoo\fP configuration
  10. parameter to \fB"bar"\fP\|\. A \fB\-\-\fP argument tells the cli parser to stop
  11. reading flags\. Using \fB\-\-flag\fP without specifying any value will set
  12. the value to \fBtrue\fP\|\.
  13. .P
  14. Example: \fB\-\-flag1 \-\-flag2\fP will set both configuration parameters
  15. to \fBtrue\fP, while \fB\-\-flag1 \-\-flag2 bar\fP will set \fBflag1\fP to \fBtrue\fP,
  16. and \fBflag2\fP to \fBbar\fP\|\. Finally, \fB\-\-flag1 \-\-flag2 \-\- bar\fP will set
  17. both configuration parameters to \fBtrue\fP, and the \fBbar\fP is taken
  18. as a command argument\.
  19. .SS Environment Variables
  20. .P
  21. Any environment variables that start with \fBnpm_config_\fP will be
  22. interpreted as a configuration parameter\. For example, putting
  23. \fBnpm_config_foo=bar\fP in your environment will set the \fBfoo\fP
  24. configuration parameter to \fBbar\fP\|\. Any environment configurations that
  25. are not given a value will be given the value of \fBtrue\fP\|\. Config
  26. values are case\-insensitive, so \fBNPM_CONFIG_FOO=bar\fP will work the
  27. same\. However, please note that inside npm\-scripts \fI/misc/scripts\fR
  28. npm will set its own environment variables and Node will prefer
  29. those lowercase versions over any uppercase ones that you might set\.
  30. For details see this issue \fIhttps://github\.com/npm/npm/issues/14528\fR\|\.
  31. .P
  32. Notice that you need to use underscores instead of dashes, so \fB\-\-allow\-same\-version\fP
  33. would become \fBnpm_config_allow_same_version=true\fP\|\.
  34. .SS npmrc Files
  35. .P
  36. The four relevant files are:
  37. .RS 0
  38. .IP \(bu 2
  39. per\-project configuration file (\fB/path/to/my/project/\.npmrc\fP)
  40. .IP \(bu 2
  41. per\-user configuration file (defaults to \fB$HOME/\.npmrc\fP; configurable via CLI
  42. option \fB\-\-userconfig\fP or environment variable \fB$NPM_CONFIG_USERCONFIG\fP)
  43. .IP \(bu 2
  44. global configuration file (defaults to \fB$PREFIX/etc/npmrc\fP; configurable via
  45. CLI option \fB\-\-globalconfig\fP or environment variable \fB$NPM_CONFIG_GLOBALCONFIG\fP)
  46. .IP \(bu 2
  47. npm's built\-in configuration file (\fB/path/to/npm/npmrc\fP)
  48. .RE
  49. .P
  50. See npm help 5 npmrc for more details\.
  51. .SS Default Configs
  52. .P
  53. Run \fBnpm config ls \-l\fP to see a set of configuration parameters that are
  54. internal to npm, and are defaults if nothing else is specified\.
  55. .SH Shorthands and Other CLI Niceties
  56. .P
  57. The following shorthands are parsed on the command\-line:
  58. .RS 0
  59. .IP \(bu 2
  60. \fB\-v\fP: \fB\-\-version\fP
  61. .IP \(bu 2
  62. \fB\-h\fP, \fB\-?\fP, \fB\-\-help\fP, \fB\-H\fP: \fB\-\-usage\fP
  63. .IP \(bu 2
  64. \fB\-s\fP, \fB\-\-silent\fP: \fB\-\-loglevel silent\fP
  65. .IP \(bu 2
  66. \fB\-q\fP, \fB\-\-quiet\fP: \fB\-\-loglevel warn\fP
  67. .IP \(bu 2
  68. \fB\-d\fP: \fB\-\-loglevel info\fP
  69. .IP \(bu 2
  70. \fB\-dd\fP, \fB\-\-verbose\fP: \fB\-\-loglevel verbose\fP
  71. .IP \(bu 2
  72. \fB\-ddd\fP: \fB\-\-loglevel silly\fP
  73. .IP \(bu 2
  74. \fB\-g\fP: \fB\-\-global\fP
  75. .IP \(bu 2
  76. \fB\-C\fP: \fB\-\-prefix\fP
  77. .IP \(bu 2
  78. \fB\-l\fP: \fB\-\-long\fP
  79. .IP \(bu 2
  80. \fB\-m\fP: \fB\-\-message\fP
  81. .IP \(bu 2
  82. \fB\-p\fP, \fB\-\-porcelain\fP: \fB\-\-parseable\fP
  83. .IP \(bu 2
  84. \fB\-reg\fP: \fB\-\-registry\fP
  85. .IP \(bu 2
  86. \fB\-f\fP: \fB\-\-force\fP
  87. .IP \(bu 2
  88. \fB\-desc\fP: \fB\-\-description\fP
  89. .IP \(bu 2
  90. \fB\-S\fP: \fB\-\-save\fP
  91. .IP \(bu 2
  92. \fB\-P\fP: \fB\-\-save\-prod\fP
  93. .IP \(bu 2
  94. \fB\-D\fP: \fB\-\-save\-dev\fP
  95. .IP \(bu 2
  96. \fB\-O\fP: \fB\-\-save\-optional\fP
  97. .IP \(bu 2
  98. \fB\-B\fP: \fB\-\-save\-bundle\fP
  99. .IP \(bu 2
  100. \fB\-E\fP: \fB\-\-save\-exact\fP
  101. .IP \(bu 2
  102. \fB\-y\fP: \fB\-\-yes\fP
  103. .IP \(bu 2
  104. \fB\-n\fP: \fB\-\-yes false\fP
  105. .IP \(bu 2
  106. \fBll\fP and \fBla\fP commands: \fBls \-\-long\fP
  107. .RE
  108. .P
  109. If the specified configuration param resolves unambiguously to a known
  110. configuration parameter, then it is expanded to that configuration
  111. parameter\. For example:
  112. .P
  113. .RS 2
  114. .nf
  115. npm ls \-\-par
  116. # same as:
  117. npm ls \-\-parseable
  118. .fi
  119. .RE
  120. .P
  121. If multiple single\-character shorthands are strung together, and the
  122. resulting combination is unambiguously not some other configuration
  123. param, then it is expanded to its various component pieces\. For
  124. example:
  125. .P
  126. .RS 2
  127. .nf
  128. npm ls \-gpld
  129. # same as:
  130. npm ls \-\-global \-\-parseable \-\-long \-\-loglevel info
  131. .fi
  132. .RE
  133. .SH Per\-Package Config Settings
  134. .P
  135. When running scripts (see npm help 7 \fBnpm\-scripts\fP) the package\.json "config"
  136. keys are overwritten in the environment if there is a config param of
  137. \fB<name>[@<version>]:<key>\fP\|\. For example, if the package\.json has
  138. this:
  139. .P
  140. .RS 2
  141. .nf
  142. { "name" : "foo"
  143. , "config" : { "port" : "8080" }
  144. , "scripts" : { "start" : "node server\.js" } }
  145. .fi
  146. .RE
  147. .P
  148. and the server\.js is this:
  149. .P
  150. .RS 2
  151. .nf
  152. http\.createServer(\.\.\.)\.listen(process\.env\.npm_package_config_port)
  153. .fi
  154. .RE
  155. .P
  156. then the user could change the behavior by doing:
  157. .P
  158. .RS 2
  159. .nf
  160. npm config set foo:port 80
  161. .fi
  162. .RE
  163. .P
  164. See npm help 5 package\.json for more information\.
  165. .SH Config Settings
  166. .SS access
  167. .RS 0
  168. .IP \(bu 2
  169. Default: \fBrestricted\fP
  170. .IP \(bu 2
  171. Type: Access
  172. .RE
  173. .P
  174. When publishing scoped packages, the access level defaults to \fBrestricted\fP\|\. If
  175. you want your scoped package to be publicly viewable (and installable) set
  176. \fB\-\-access=public\fP\|\. The only valid values for \fBaccess\fP are \fBpublic\fP and
  177. \fBrestricted\fP\|\. Unscoped packages \fIalways\fR have an access level of \fBpublic\fP\|\.
  178. .SS allow\-same\-version
  179. .RS 0
  180. .IP \(bu 2
  181. Default: false
  182. .IP \(bu 2
  183. Type: Boolean
  184. .RE
  185. .P
  186. Prevents throwing an error when \fBnpm version\fP is used to set the new version
  187. to the same value as the current version\.
  188. .SS always\-auth
  189. .RS 0
  190. .IP \(bu 2
  191. Default: false
  192. .IP \(bu 2
  193. Type: Boolean
  194. .RE
  195. .P
  196. Force npm to always require authentication when accessing the registry,
  197. even for \fBGET\fP requests\.
  198. .SS also
  199. .RS 0
  200. .IP \(bu 2
  201. Default: null
  202. .IP \(bu 2
  203. Type: String
  204. .RE
  205. .P
  206. When "dev" or "development" and running local \fBnpm shrinkwrap\fP,
  207. \fBnpm outdated\fP, or \fBnpm update\fP, is an alias for \fB\-\-dev\fP\|\.
  208. .SS audit
  209. .RS 0
  210. .IP \(bu 2
  211. Default: true
  212. .IP \(bu 2
  213. Type: Boolean
  214. .RE
  215. .P
  216. When "true" submit audit reports alongside \fBnpm install\fP runs to the default
  217. registry and all registries configured for scopes\. See the documentation
  218. for npm help audit for details on what is submitted\.
  219. .SS audit\-level
  220. .RS 0
  221. .IP \(bu 2
  222. Default: \fB"low"\fP
  223. .IP \(bu 2
  224. Type: \fB\|'low'\fP, \fB\|'moderate'\fP, \fB\|'high'\fP, \fB\|'critical'\fP
  225. .RE
  226. .P
  227. The minimum level of vulnerability for \fBnpm audit\fP to exit with
  228. a non\-zero exit code\.
  229. .SS auth\-type
  230. .RS 0
  231. .IP \(bu 2
  232. Default: \fB\|'legacy'\fP
  233. .IP \(bu 2
  234. Type: \fB\|'legacy'\fP, \fB\|'sso'\fP, \fB\|'saml'\fP, \fB\|'oauth'\fP
  235. .RE
  236. .P
  237. What authentication strategy to use with \fBadduser\fP/\fBlogin\fP\|\.
  238. .SS bin\-links
  239. .RS 0
  240. .IP \(bu 2
  241. Default: \fBtrue\fP
  242. .IP \(bu 2
  243. Type: Boolean
  244. .RE
  245. .P
  246. Tells npm to create symlinks (or \fB\|\.cmd\fP shims on Windows) for package
  247. executables\.
  248. .P
  249. Set to false to have it not do this\. This can be used to work around
  250. the fact that some file systems don't support symlinks, even on
  251. ostensibly Unix systems\.
  252. .SS browser
  253. .RS 0
  254. .IP \(bu 2
  255. Default: OS X: \fB"open"\fP, Windows: \fB"start"\fP, Others: \fB"xdg\-open"\fP
  256. .IP \(bu 2
  257. Type: String
  258. .RE
  259. .P
  260. The browser that is called by the \fBnpm docs\fP command to open websites\.
  261. .SS ca
  262. .RS 0
  263. .IP \(bu 2
  264. Default: The npm CA certificate
  265. .IP \(bu 2
  266. Type: String, Array or null
  267. .RE
  268. .P
  269. The Certificate Authority signing certificate that is trusted for SSL
  270. connections to the registry\. Values should be in PEM format (Windows calls it "Base\-64 encoded X\.509 (\.CER)") with newlines
  271. replaced by the string "\\n"\. For example:
  272. .P
  273. .RS 2
  274. .nf
  275. ca="\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-\\nXXXX\\nXXXX\\n\-\-\-\-\-END CERTIFICATE\-\-\-\-\-"
  276. .fi
  277. .RE
  278. .P
  279. Set to \fBnull\fP to only allow "known" registrars, or to a specific CA cert
  280. to trust only that specific signing authority\.
  281. .P
  282. Multiple CAs can be trusted by specifying an array of certificates:
  283. .P
  284. .RS 2
  285. .nf
  286. ca[]="\.\.\."
  287. ca[]="\.\.\."
  288. .fi
  289. .RE
  290. .P
  291. See also the \fBstrict\-ssl\fP config\.
  292. .SS cafile
  293. .RS 0
  294. .IP \(bu 2
  295. Default: \fBnull\fP
  296. .IP \(bu 2
  297. Type: path
  298. .RE
  299. .P
  300. A path to a file containing one or multiple Certificate Authority signing
  301. certificates\. Similar to the \fBca\fP setting, but allows for multiple CA's, as
  302. well as for the CA information to be stored in a file on disk\.
  303. .SS cache
  304. .RS 0
  305. .IP \(bu 2
  306. Default: Windows: \fB%AppData%\\npm\-cache\fP, Posix: \fB~/\.npm\fP
  307. .IP \(bu 2
  308. Type: path
  309. .RE
  310. .P
  311. The location of npm's cache directory\. See npm help \fBnpm\-cache\fP
  312. .SS cache\-lock\-stale
  313. .RS 0
  314. .IP \(bu 2
  315. Default: 60000 (1 minute)
  316. .IP \(bu 2
  317. Type: Number
  318. .RE
  319. .P
  320. The number of ms before cache folder lockfiles are considered stale\.
  321. .SS cache\-lock\-retries
  322. .RS 0
  323. .IP \(bu 2
  324. Default: 10
  325. .IP \(bu 2
  326. Type: Number
  327. .RE
  328. .P
  329. Number of times to retry to acquire a lock on cache folder lockfiles\.
  330. .SS cache\-lock\-wait
  331. .RS 0
  332. .IP \(bu 2
  333. Default: 10000 (10 seconds)
  334. .IP \(bu 2
  335. Type: Number
  336. .RE
  337. .P
  338. Number of ms to wait for cache lock files to expire\.
  339. .SS cache\-max
  340. .RS 0
  341. .IP \(bu 2
  342. Default: Infinity
  343. .IP \(bu 2
  344. Type: Number
  345. .RE
  346. .P
  347. \fBDEPRECATED\fR: This option has been deprecated in favor of \fB\-\-prefer\-online\fP\|\.
  348. .P
  349. \fB\-\-cache\-max=0\fP is an alias for \fB\-\-prefer\-online\fP\|\.
  350. .SS cache\-min
  351. .RS 0
  352. .IP \(bu 2
  353. Default: 10
  354. .IP \(bu 2
  355. Type: Number
  356. .RE
  357. .P
  358. \fBDEPRECATED\fR: This option has been deprecated in favor of \fB\-\-prefer\-offline\fP\|\.
  359. .P
  360. \fB\-\-cache\-min=9999 (or bigger)\fP is an alias for \fB\-\-prefer\-offline\fP\|\.
  361. .SS cert
  362. .RS 0
  363. .IP \(bu 2
  364. Default: \fBnull\fP
  365. .IP \(bu 2
  366. Type: String
  367. .RE
  368. .P
  369. A client certificate to pass when accessing the registry\. Values should be in
  370. PEM format (Windows calls it "Base\-64 encoded X\.509 (\.CER)") with newlines replaced by the string "\\n"\. For example:
  371. .P
  372. .RS 2
  373. .nf
  374. cert="\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-\\nXXXX\\nXXXX\\n\-\-\-\-\-END CERTIFICATE\-\-\-\-\-"
  375. .fi
  376. .RE
  377. .P
  378. It is \fInot\fR the path to a certificate file (and there is no "certfile" option)\.
  379. .SS cidr
  380. .RS 0
  381. .IP \(bu 2
  382. Default: \fBnull\fP
  383. .IP \(bu 2
  384. Type: String, Array, null
  385. .RE
  386. .P
  387. This is a list of CIDR address to be used when configuring limited access tokens with the \fBnpm token create\fP command\.
  388. .SS color
  389. .RS 0
  390. .IP \(bu 2
  391. Default: true
  392. .IP \(bu 2
  393. Type: Boolean or \fB"always"\fP
  394. .RE
  395. .P
  396. If false, never shows colors\. If \fB"always"\fP then always shows colors\.
  397. If true, then only prints color codes for tty file descriptors\.
  398. .P
  399. This option can also be changed using the environment: colors are
  400. disabled when the environment variable \fBNO_COLOR\fP is set to any value\.
  401. .SS depth
  402. .RS 0
  403. .IP \(bu 2
  404. Default: Infinity
  405. .IP \(bu 2
  406. Type: Number
  407. .RE
  408. .P
  409. The depth to go when recursing directories for \fBnpm ls\fP,
  410. \fBnpm cache ls\fP, and \fBnpm outdated\fP\|\.
  411. .P
  412. For \fBnpm outdated\fP, a setting of \fBInfinity\fP will be treated as \fB0\fP
  413. since that gives more useful information\. To show the outdated status
  414. of all packages and dependents, use a large integer value,
  415. e\.g\., \fBnpm outdated \-\-depth 9999\fP
  416. .SS description
  417. .RS 0
  418. .IP \(bu 2
  419. Default: true
  420. .IP \(bu 2
  421. Type: Boolean
  422. .RE
  423. .P
  424. Show the description in \fBnpm search\fP
  425. .SS dev
  426. .RS 0
  427. .IP \(bu 2
  428. Default: false
  429. .IP \(bu 2
  430. Type: Boolean
  431. .RE
  432. .P
  433. Install \fBdev\-dependencies\fP along with packages\.
  434. .SS dry\-run
  435. .RS 0
  436. .IP \(bu 2
  437. Default: false
  438. .IP \(bu 2
  439. Type: Boolean
  440. .RE
  441. .P
  442. Indicates that you don't want npm to make any changes and that it should
  443. only report what it would have done\. This can be passed into any of the
  444. commands that modify your local installation, eg, \fBinstall\fP, \fBupdate\fP,
  445. \fBdedupe\fP, \fBuninstall\fP\|\. This is NOT currently honored by some network related
  446. commands, eg \fBdist\-tags\fP, \fBowner\fP, etc\.
  447. .SS editor
  448. .RS 0
  449. .IP \(bu 2
  450. Default: \fBEDITOR\fP environment variable if set, or \fB"vi"\fP on Posix,
  451. or \fB"notepad"\fP on Windows\.
  452. .IP \(bu 2
  453. Type: path
  454. .RE
  455. .P
  456. The command to run for \fBnpm edit\fP or \fBnpm config edit\fP\|\.
  457. .SS engine\-strict
  458. .RS 0
  459. .IP \(bu 2
  460. Default: false
  461. .IP \(bu 2
  462. Type: Boolean
  463. .RE
  464. .P
  465. If set to true, then npm will stubbornly refuse to install (or even
  466. consider installing) any package that claims to not be compatible with
  467. the current Node\.js version\.
  468. .SS force
  469. .RS 0
  470. .IP \(bu 2
  471. Default: false
  472. .IP \(bu 2
  473. Type: Boolean
  474. .RE
  475. .P
  476. Makes various commands more forceful\.
  477. .RS 0
  478. .IP \(bu 2
  479. lifecycle script failure does not block progress\.
  480. .IP \(bu 2
  481. publishing clobbers previously published versions\.
  482. .IP \(bu 2
  483. skips cache when requesting from the registry\.
  484. .IP \(bu 2
  485. prevents checks against clobbering non\-npm files\.
  486. .RE
  487. .SS fetch\-retries
  488. .RS 0
  489. .IP \(bu 2
  490. Default: 2
  491. .IP \(bu 2
  492. Type: Number
  493. .RE
  494. .P
  495. The "retries" config for the \fBretry\fP module to use when fetching
  496. packages from the registry\.
  497. .SS fetch\-retry\-factor
  498. .RS 0
  499. .IP \(bu 2
  500. Default: 10
  501. .IP \(bu 2
  502. Type: Number
  503. .RE
  504. .P
  505. The "factor" config for the \fBretry\fP module to use when fetching
  506. packages\.
  507. .SS fetch\-retry\-mintimeout
  508. .RS 0
  509. .IP \(bu 2
  510. Default: 10000 (10 seconds)
  511. .IP \(bu 2
  512. Type: Number
  513. .RE
  514. .P
  515. The "minTimeout" config for the \fBretry\fP module to use when fetching
  516. packages\.
  517. .SS fetch\-retry\-maxtimeout
  518. .RS 0
  519. .IP \(bu 2
  520. Default: 60000 (1 minute)
  521. .IP \(bu 2
  522. Type: Number
  523. .RE
  524. .P
  525. The "maxTimeout" config for the \fBretry\fP module to use when fetching
  526. packages\.
  527. .SS git
  528. .RS 0
  529. .IP \(bu 2
  530. Default: \fB"git"\fP
  531. .IP \(bu 2
  532. Type: String
  533. .RE
  534. .P
  535. The command to use for git commands\. If git is installed on the
  536. computer, but is not in the \fBPATH\fP, then set this to the full path to
  537. the git binary\.
  538. .SS git\-tag\-version
  539. .RS 0
  540. .IP \(bu 2
  541. Default: \fBtrue\fP
  542. .IP \(bu 2
  543. Type: Boolean
  544. .RE
  545. .P
  546. Tag the commit when using the \fBnpm version\fP command\.
  547. .SS commit\-hooks
  548. .RS 0
  549. .IP \(bu 2
  550. Default: \fBtrue\fP
  551. .IP \(bu 2
  552. Type: Boolean
  553. .RE
  554. .P
  555. Run git commit hooks when using the \fBnpm version\fP command\.
  556. .SS global
  557. .RS 0
  558. .IP \(bu 2
  559. Default: false
  560. .IP \(bu 2
  561. Type: Boolean
  562. .RE
  563. .P
  564. Operates in "global" mode, so that packages are installed into the
  565. \fBprefix\fP folder instead of the current working directory\. See
  566. npm help 5 \fBnpm\-folders\fP for more on the differences in behavior\.
  567. .RS 0
  568. .IP \(bu 2
  569. packages are installed into the \fB{prefix}/lib/node_modules\fP folder, instead of the
  570. current working directory\.
  571. .IP \(bu 2
  572. bin files are linked to \fB{prefix}/bin\fP
  573. .IP \(bu 2
  574. man pages are linked to \fB{prefix}/share/man\fP
  575. .RE
  576. .SS globalconfig
  577. .RS 0
  578. .IP \(bu 2
  579. Default: {prefix}/etc/npmrc
  580. .IP \(bu 2
  581. Type: path
  582. .RE
  583. .P
  584. The config file to read for global config options\.
  585. .SS global\-style
  586. .RS 0
  587. .IP \(bu 2
  588. Default: false
  589. .IP \(bu 2
  590. Type: Boolean
  591. .RE
  592. .P
  593. Causes npm to install the package into your local \fBnode_modules\fP folder with
  594. the same layout it uses with the global \fBnode_modules\fP folder\. Only your
  595. direct dependencies will show in \fBnode_modules\fP and everything they depend
  596. on will be flattened in their \fBnode_modules\fP folders\. This obviously will
  597. eliminate some deduping\. If used with \fBlegacy\-bundling\fP, \fBlegacy\-bundling\fP will be
  598. preferred\.
  599. .SS group
  600. .RS 0
  601. .IP \(bu 2
  602. Default: GID of the current process
  603. .IP \(bu 2
  604. Type: String or Number
  605. .RE
  606. .P
  607. The group to use when running package scripts in global mode as the root
  608. user\.
  609. .SS heading
  610. .RS 0
  611. .IP \(bu 2
  612. Default: \fB"npm"\fP
  613. .IP \(bu 2
  614. Type: String
  615. .RE
  616. .P
  617. The string that starts all the debugging log output\.
  618. .SS https\-proxy
  619. .RS 0
  620. .IP \(bu 2
  621. Default: null
  622. .IP \(bu 2
  623. Type: url
  624. .RE
  625. .P
  626. A proxy to use for outgoing https requests\. If the \fBHTTPS_PROXY\fP or
  627. \fBhttps_proxy\fP or \fBHTTP_PROXY\fP or \fBhttp_proxy\fP environment variables are set,
  628. proxy settings will be honored by the underlying \fBrequest\fP library\.
  629. .SS if\-present
  630. .RS 0
  631. .IP \(bu 2
  632. Default: false
  633. .IP \(bu 2
  634. Type: Boolean
  635. .RE
  636. .P
  637. If true, npm will not exit with an error code when \fBrun\-script\fP is invoked for
  638. a script that isn't defined in the \fBscripts\fP section of \fBpackage\.json\fP\|\. This
  639. option can be used when it's desirable to optionally run a script when it's
  640. present and fail if the script fails\. This is useful, for example, when running
  641. scripts that may only apply for some builds in an otherwise generic CI setup\.
  642. .SS ignore\-prepublish
  643. .RS 0
  644. .IP \(bu 2
  645. Default: false
  646. .IP \(bu 2
  647. Type: Boolean
  648. .RE
  649. .P
  650. If true, npm will not run \fBprepublish\fP scripts\.
  651. .SS ignore\-scripts
  652. .RS 0
  653. .IP \(bu 2
  654. Default: false
  655. .IP \(bu 2
  656. Type: Boolean
  657. .RE
  658. .P
  659. If true, npm does not run scripts specified in package\.json files\.
  660. .SS init\-module
  661. .RS 0
  662. .IP \(bu 2
  663. Default: ~/\.npm\-init\.js
  664. .IP \(bu 2
  665. Type: path
  666. .RE
  667. .P
  668. A module that will be loaded by the \fBnpm init\fP command\. See the
  669. documentation for the
  670. init\-package\-json \fIhttps://github\.com/isaacs/init\-package\-json\fR module
  671. for more information, or npm help init\.
  672. .SS init\-author\-name
  673. .RS 0
  674. .IP \(bu 2
  675. Default: ""
  676. .IP \(bu 2
  677. Type: String
  678. .RE
  679. .P
  680. The value \fBnpm init\fP should use by default for the package author's name\.
  681. .SS init\-author\-email
  682. .RS 0
  683. .IP \(bu 2
  684. Default: ""
  685. .IP \(bu 2
  686. Type: String
  687. .RE
  688. .P
  689. The value \fBnpm init\fP should use by default for the package author's email\.
  690. .SS init\-author\-url
  691. .RS 0
  692. .IP \(bu 2
  693. Default: ""
  694. .IP \(bu 2
  695. Type: String
  696. .RE
  697. .P
  698. The value \fBnpm init\fP should use by default for the package author's homepage\.
  699. .SS init\-license
  700. .RS 0
  701. .IP \(bu 2
  702. Default: "ISC"
  703. .IP \(bu 2
  704. Type: String
  705. .RE
  706. .P
  707. The value \fBnpm init\fP should use by default for the package license\.
  708. .SS init\-version
  709. .RS 0
  710. .IP \(bu 2
  711. Default: "1\.0\.0"
  712. .IP \(bu 2
  713. Type: semver
  714. .RE
  715. .P
  716. The value that \fBnpm init\fP should use by default for the package
  717. version number, if not already set in package\.json\.
  718. .SS json
  719. .RS 0
  720. .IP \(bu 2
  721. Default: false
  722. .IP \(bu 2
  723. Type: Boolean
  724. .RE
  725. .P
  726. Whether or not to output JSON data, rather than the normal output\.
  727. .P
  728. This feature is currently experimental, and the output data structures for many
  729. commands is either not implemented in JSON yet, or subject to change\. Only the
  730. output from \fBnpm ls \-\-json\fP and \fBnpm search \-\-json\fP are currently valid\.
  731. .SS key
  732. .RS 0
  733. .IP \(bu 2
  734. Default: \fBnull\fP
  735. .IP \(bu 2
  736. Type: String
  737. .RE
  738. .P
  739. A client key to pass when accessing the registry\. Values should be in PEM
  740. format with newlines replaced by the string "\\n"\. For example:
  741. .P
  742. .RS 2
  743. .nf
  744. key="\-\-\-\-\-BEGIN PRIVATE KEY\-\-\-\-\-\\nXXXX\\nXXXX\\n\-\-\-\-\-END PRIVATE KEY\-\-\-\-\-"
  745. .fi
  746. .RE
  747. .P
  748. It is \fInot\fR the path to a key file (and there is no "keyfile" option)\.
  749. .SS legacy\-bundling
  750. .RS 0
  751. .IP \(bu 2
  752. Default: false
  753. .IP \(bu 2
  754. Type: Boolean
  755. .RE
  756. .P
  757. Causes npm to install the package such that versions of npm prior to 1\.4,
  758. such as the one included with node 0\.8, can install the package\. This
  759. eliminates all automatic deduping\. If used with \fBglobal\-style\fP this option
  760. will be preferred\.
  761. .SS link
  762. .RS 0
  763. .IP \(bu 2
  764. Default: false
  765. .IP \(bu 2
  766. Type: Boolean
  767. .RE
  768. .P
  769. If true, then local installs will link if there is a suitable globally
  770. installed package\.
  771. .P
  772. Note that this means that local installs can cause things to be
  773. installed into the global space at the same time\. The link is only done
  774. if one of the two conditions are met:
  775. .RS 0
  776. .IP \(bu 2
  777. The package is not already installed globally, or
  778. .IP \(bu 2
  779. the globally installed version is identical to the version that is
  780. being installed locally\.
  781. .RE
  782. .SS local\-address
  783. .RS 0
  784. .IP \(bu 2
  785. Default: undefined
  786. .IP \(bu 2
  787. Type: IP Address
  788. .RE
  789. .P
  790. The IP address of the local interface to use when making connections
  791. to the npm registry\. Must be IPv4 in versions of Node prior to 0\.12\.
  792. .SS loglevel
  793. .RS 0
  794. .IP \(bu 2
  795. Default: "notice"
  796. .IP \(bu 2
  797. Type: String
  798. .IP \(bu 2
  799. Values: "silent", "error", "warn", "notice", "http", "timing", "info",
  800. "verbose", "silly"
  801. .RE
  802. .P
  803. What level of logs to report\. On failure, \fIall\fR logs are written to
  804. \fBnpm\-debug\.log\fP in the current working directory\.
  805. .P
  806. Any logs of a higher level than the setting are shown\. The default is "notice"\.
  807. .SS logstream
  808. .RS 0
  809. .IP \(bu 2
  810. Default: process\.stderr
  811. .IP \(bu 2
  812. Type: Stream
  813. .RE
  814. .P
  815. This is the stream that is passed to the
  816. npmlog \fIhttps://github\.com/npm/npmlog\fR module at run time\.
  817. .P
  818. It cannot be set from the command line, but if you are using npm
  819. programmatically, you may wish to send logs to somewhere other than
  820. stderr\.
  821. .P
  822. If the \fBcolor\fP config is set to true, then this stream will receive
  823. colored output if it is a TTY\.
  824. .SS logs\-max
  825. .RS 0
  826. .IP \(bu 2
  827. Default: 10
  828. .IP \(bu 2
  829. Type: Number
  830. .RE
  831. .P
  832. The maximum number of log files to store\.
  833. .SS long
  834. .RS 0
  835. .IP \(bu 2
  836. Default: false
  837. .IP \(bu 2
  838. Type: Boolean
  839. .RE
  840. .P
  841. Show extended information in \fBnpm ls\fP and \fBnpm search\fP\|\.
  842. .SS maxsockets
  843. .RS 0
  844. .IP \(bu 2
  845. Default: 50
  846. .IP \(bu 2
  847. Type: Number
  848. .RE
  849. .P
  850. The maximum number of connections to use per origin (protocol/host/port
  851. combination)\. Passed to the \fBhttp\fP \fBAgent\fP used to make the request\.
  852. .SS message
  853. .RS 0
  854. .IP \(bu 2
  855. Default: "%s"
  856. .IP \(bu 2
  857. Type: String
  858. .RE
  859. .P
  860. Commit message which is used by \fBnpm version\fP when creating version commit\.
  861. .P
  862. Any "%s" in the message will be replaced with the version number\.
  863. .SS metrics\-registry
  864. .RS 0
  865. .IP \(bu 2
  866. Default: The value of \fBregistry\fP (which defaults to "https://
  867. .IP \(bu 2
  868. Type: String
  869. .RE
  870. .P
  871. The registry you want to send cli metrics to if \fBsend\-metrics\fP is true\.
  872. .SS node\-options
  873. .RS 0
  874. .IP \(bu 2
  875. Default: null
  876. .IP \(bu 2
  877. Type: String
  878. .RE
  879. .P
  880. Options to pass through to Node\.js via the \fBNODE_OPTIONS\fP environment
  881. variable\. This does not impact how npm itself is executed but it does
  882. impact how lifecycle scripts are called\.
  883. .SS node\-version
  884. .RS 0
  885. .IP \(bu 2
  886. Default: process\.version
  887. .IP \(bu 2
  888. Type: semver or false
  889. .RE
  890. .P
  891. The node version to use when checking a package's \fBengines\fP map\.
  892. .SS noproxy
  893. .RS 0
  894. .IP \(bu 2
  895. Default: null
  896. .IP \(bu 2
  897. Type: String or Array
  898. .RE
  899. .P
  900. A comma\-separated string or an array of domain extensions that a proxy should not be used for\.
  901. .SS offline
  902. .RS 0
  903. .IP \(bu 2
  904. Default: false
  905. .IP \(bu 2
  906. Type: Boolean
  907. .RE
  908. .P
  909. Force offline mode: no network requests will be done during install\. To allow
  910. the CLI to fill in missing cache data, see \fB\-\-prefer\-offline\fP\|\.
  911. .SS onload\-script
  912. .RS 0
  913. .IP \(bu 2
  914. Default: false
  915. .IP \(bu 2
  916. Type: path
  917. .RE
  918. .P
  919. A node module to \fBrequire()\fP when npm loads\. Useful for programmatic
  920. usage\.
  921. .SS only
  922. .RS 0
  923. .IP \(bu 2
  924. Default: null
  925. .IP \(bu 2
  926. Type: String
  927. .RE
  928. .P
  929. When "dev" or "development" and running local \fBnpm install\fP without any
  930. arguments, only devDependencies (and their dependencies) are installed\.
  931. .P
  932. When "dev" or "development" and running local \fBnpm ls\fP, \fBnpm outdated\fP, or
  933. \fBnpm update\fP, is an alias for \fB\-\-dev\fP\|\.
  934. .P
  935. When "prod" or "production" and running local \fBnpm install\fP without any
  936. arguments, only non\-devDependencies (and their dependencies) are
  937. installed\.
  938. .P
  939. When "prod" or "production" and running local \fBnpm ls\fP, \fBnpm outdated\fP, or
  940. \fBnpm update\fP, is an alias for \fB\-\-production\fP\|\.
  941. .SS optional
  942. .RS 0
  943. .IP \(bu 2
  944. Default: true
  945. .IP \(bu 2
  946. Type: Boolean
  947. .RE
  948. .P
  949. Attempt to install packages in the \fBoptionalDependencies\fP object\. Note
  950. that if these packages fail to install, the overall installation
  951. process is not aborted\.
  952. .SS otp
  953. .RS 0
  954. .IP \(bu 2
  955. Default: null
  956. .IP \(bu 2
  957. Type: Number
  958. .RE
  959. .P
  960. This is a one\-time password from a two\-factor authenticator\. It's needed
  961. when publishing or changing package permissions with \fBnpm access\fP\|\.
  962. .SS package\-lock
  963. .RS 0
  964. .IP \(bu 2
  965. Default: true
  966. .IP \(bu 2
  967. Type: Boolean
  968. .RE
  969. .P
  970. If set to false, then ignore \fBpackage\-lock\.json\fP files when installing\. This
  971. will also prevent \fIwriting\fR \fBpackage\-lock\.json\fP if \fBsave\fP is true\.
  972. .P
  973. When package package\-locks are disabled, automatic pruning of extraneous
  974. modules will also be disabled\. To remove extraneous modules with
  975. package\-locks disabled use \fBnpm prune\fP\|\.
  976. .P
  977. This option is an alias for \fB\-\-shrinkwrap\fP\|\.
  978. .SS package\-lock\-only
  979. .RS 0
  980. .IP \(bu 2
  981. Default: false
  982. .IP \(bu 2
  983. Type: Boolean
  984. .RE
  985. .P
  986. If set to true, it will update only the \fBpackage\-lock\.json\fP,
  987. instead of checking \fBnode_modules\fP and downloading dependencies\.
  988. .SS parseable
  989. .RS 0
  990. .IP \(bu 2
  991. Default: false
  992. .IP \(bu 2
  993. Type: Boolean
  994. .RE
  995. .P
  996. Output parseable results from commands that write to
  997. standard output\. For \fBnpm search\fP, this will be tab\-separated table format\.
  998. .SS prefer\-offline
  999. .RS 0
  1000. .IP \(bu 2
  1001. Default: false
  1002. .IP \(bu 2
  1003. Type: Boolean
  1004. .RE
  1005. .P
  1006. If true, staleness checks for cached data will be bypassed, but missing data
  1007. will be requested from the server\. To force full offline mode, use \fB\-\-offline\fP\|\.
  1008. .P
  1009. This option is effectively equivalent to \fB\-\-cache\-min=9999999\fP\|\.
  1010. .SS prefer\-online
  1011. .RS 0
  1012. .IP \(bu 2
  1013. Default: false
  1014. .IP \(bu 2
  1015. Type: Boolean
  1016. .RE
  1017. .P
  1018. If true, staleness checks for cached data will be forced, making the CLI look
  1019. for updates immediately even for fresh package data\.
  1020. .SS prefix
  1021. .RS 0
  1022. .IP \(bu 2
  1023. Default: see npm help 5 folders
  1024. .IP \(bu 2
  1025. Type: path
  1026. .RE
  1027. .P
  1028. The location to install global items\. If set on the command line, then
  1029. it forces non\-global commands to run in the specified folder\.
  1030. .SS preid
  1031. .RS 0
  1032. .IP \(bu 2
  1033. Default: ""
  1034. .IP \(bu 2
  1035. Type: String
  1036. .RE
  1037. .P
  1038. The "prerelease identifier" to use as a prefix for the "prerelease" part of a
  1039. semver\. Like the \fBrc\fP in \fB1\.2\.0\-rc\.8\fP\|\.
  1040. .SS production
  1041. .RS 0
  1042. .IP \(bu 2
  1043. Default: false
  1044. .IP \(bu 2
  1045. Type: Boolean
  1046. .RE
  1047. .P
  1048. Set to true to run in "production" mode\.
  1049. .RS 0
  1050. .IP 1. 3
  1051. devDependencies are not installed at the topmost level when running
  1052. local \fBnpm install\fP without any arguments\.
  1053. .IP 2. 3
  1054. Set the NODE_ENV="production" for lifecycle scripts\.
  1055. .RE
  1056. .SS progress
  1057. .RS 0
  1058. .IP \(bu 2
  1059. Default: true, unless TRAVIS or CI env vars set\.
  1060. .IP \(bu 2
  1061. Type: Boolean
  1062. .RE
  1063. .P
  1064. When set to \fBtrue\fP, npm will display a progress bar during time intensive
  1065. operations, if \fBprocess\.stderr\fP is a TTY\.
  1066. .P
  1067. Set to \fBfalse\fP to suppress the progress bar\.
  1068. .SS proxy
  1069. .RS 0
  1070. .IP \(bu 2
  1071. Default: null
  1072. .IP \(bu 2
  1073. Type: url
  1074. .RE
  1075. .P
  1076. A proxy to use for outgoing http requests\. If the \fBHTTP_PROXY\fP or
  1077. \fBhttp_proxy\fP environment variables are set, proxy settings will be
  1078. honored by the underlying \fBrequest\fP library\.
  1079. .SS read\-only
  1080. .RS 0
  1081. .IP \(bu 2
  1082. Default: false
  1083. .IP \(bu 2
  1084. Type: Boolean
  1085. .RE
  1086. .P
  1087. This is used to mark a token as unable to publish when configuring limited access tokens with the \fBnpm token create\fP command\.
  1088. .SS rebuild\-bundle
  1089. .RS 0
  1090. .IP \(bu 2
  1091. Default: true
  1092. .IP \(bu 2
  1093. Type: Boolean
  1094. .RE
  1095. .P
  1096. Rebuild bundled dependencies after installation\.
  1097. .SS registry
  1098. .RS 0
  1099. .IP \(bu 2
  1100. Default: https://
  1101. .IP \(bu 2
  1102. Type: url
  1103. .RE
  1104. .P
  1105. The base URL of the npm package registry\.
  1106. .SS rollback
  1107. .RS 0
  1108. .IP \(bu 2
  1109. Default: true
  1110. .IP \(bu 2
  1111. Type: Boolean
  1112. .RE
  1113. .P
  1114. Remove failed installs\.
  1115. .SS save
  1116. .RS 0
  1117. .IP \(bu 2
  1118. Default: true
  1119. .IP \(bu 2
  1120. Type: Boolean
  1121. .RE
  1122. .P
  1123. Save installed packages to a package\.json file as dependencies\.
  1124. .P
  1125. When used with the \fBnpm rm\fP command, it removes it from the \fBdependencies\fP
  1126. object\.
  1127. .P
  1128. Only works if there is already a package\.json file present\.
  1129. .SS save\-bundle
  1130. .RS 0
  1131. .IP \(bu 2
  1132. Default: false
  1133. .IP \(bu 2
  1134. Type: Boolean
  1135. .RE
  1136. .P
  1137. If a package would be saved at install time by the use of \fB\-\-save\fP,
  1138. \fB\-\-save\-dev\fP, or \fB\-\-save\-optional\fP, then also put it in the
  1139. \fBbundleDependencies\fP list\.
  1140. .P
  1141. When used with the \fBnpm rm\fP command, it removes it from the
  1142. bundledDependencies list\.
  1143. .SS save\-prod
  1144. .RS 0
  1145. .IP \(bu 2
  1146. Default: false
  1147. .IP \(bu 2
  1148. Type: Boolean
  1149. .RE
  1150. .P
  1151. Makes sure that a package will be saved into \fBdependencies\fP specifically\. This
  1152. is useful if a package already exists in \fBdevDependencies\fP or
  1153. \fBoptionalDependencies\fP, but you want to move it to be a production dep\. This is
  1154. also the default behavior if \fB\-\-save\fP is true, and neither \fB\-\-save\-dev\fP or
  1155. \fB\-\-save\-optional\fP are true\.
  1156. .SS save\-dev
  1157. .RS 0
  1158. .IP \(bu 2
  1159. Default: false
  1160. .IP \(bu 2
  1161. Type: Boolean
  1162. .RE
  1163. .P
  1164. Save installed packages to a package\.json file as \fBdevDependencies\fP\|\.
  1165. .P
  1166. When used with the \fBnpm rm\fP command, it removes it from the
  1167. \fBdevDependencies\fP object\.
  1168. .P
  1169. Only works if there is already a package\.json file present\.
  1170. .SS save\-exact
  1171. .RS 0
  1172. .IP \(bu 2
  1173. Default: false
  1174. .IP \(bu 2
  1175. Type: Boolean
  1176. .RE
  1177. .P
  1178. Dependencies saved to package\.json using \fB\-\-save\fP, \fB\-\-save\-dev\fP or
  1179. \fB\-\-save\-optional\fP will be configured with an exact version rather than
  1180. using npm's default semver range operator\.
  1181. .SS save\-optional
  1182. .RS 0
  1183. .IP \(bu 2
  1184. Default: false
  1185. .IP \(bu 2
  1186. Type: Boolean
  1187. .RE
  1188. .P
  1189. Save installed packages to a package\.json file as
  1190. optionalDependencies\.
  1191. .P
  1192. When used with the \fBnpm rm\fP command, it removes it from the
  1193. \fBdevDependencies\fP object\.
  1194. .P
  1195. Only works if there is already a package\.json file present\.
  1196. .SS save\-prefix
  1197. .RS 0
  1198. .IP \(bu 2
  1199. Default: '^'
  1200. .IP \(bu 2
  1201. Type: String
  1202. .RE
  1203. .P
  1204. Configure how versions of packages installed to a package\.json file via
  1205. \fB\-\-save\fP or \fB\-\-save\-dev\fP get prefixed\.
  1206. .P
  1207. For example if a package has version \fB1\.2\.3\fP, by default its version is
  1208. set to \fB^1\.2\.3\fP which allows minor upgrades for that package, but after
  1209. \fBnpm config set save\-prefix='~'\fP it would be set to \fB~1\.2\.3\fP which only allows
  1210. patch upgrades\.
  1211. .SS scope
  1212. .RS 0
  1213. .IP \(bu 2
  1214. Default: the scope of the current project, if any, or ""
  1215. .IP \(bu 2
  1216. Type: String
  1217. .RE
  1218. .P
  1219. Associate an operation with a scope for a scoped registry\. Useful when logging
  1220. in to a private registry for the first time:
  1221. \fBnpm login \-\-scope=@organization \-\-registry=registry\.organization\.com\fP, which
  1222. will cause \fB@organization\fP to be mapped to the registry for future installation
  1223. of packages specified according to the pattern \fB@organization/package\fP\|\.
  1224. .SS script\-shell
  1225. .RS 0
  1226. .IP \(bu 2
  1227. Default: \fBnull\fP
  1228. .IP \(bu 2
  1229. Type: path
  1230. .RE
  1231. .P
  1232. The shell to use for scripts run with the \fBnpm run\fP command\.
  1233. .SS scripts\-prepend\-node\-path
  1234. .RS 0
  1235. .IP \(bu 2
  1236. Default: "warn\-only"
  1237. .IP \(bu 2
  1238. Type: Boolean, \fB"auto"\fP or \fB"warn\-only"\fP
  1239. .RE
  1240. .P
  1241. If set to \fBtrue\fP, add the directory in which the current \fBnode\fP executable
  1242. resides to the \fBPATH\fP environment variable when running scripts,
  1243. even if that means that \fBnpm\fP will invoke a different \fBnode\fP executable than
  1244. the one which it is running\.
  1245. .P
  1246. If set to \fBfalse\fP, never modify \fBPATH\fP with that\.
  1247. .P
  1248. If set to \fB"warn\-only"\fP, never modify \fBPATH\fP but print a warning if \fBnpm\fP thinks
  1249. that you may want to run it with \fBtrue\fP, e\.g\. because the \fBnode\fP executable
  1250. in the \fBPATH\fP is not the one \fBnpm\fP was invoked with\.
  1251. .P
  1252. If set to \fBauto\fP, only add that directory to the \fBPATH\fP environment variable
  1253. if the \fBnode\fP executable with which \fBnpm\fP was invoked and the one that is found
  1254. first on the \fBPATH\fP are different\.
  1255. .SS searchexclude
  1256. .RS 0
  1257. .IP \(bu 2
  1258. Default: ""
  1259. .IP \(bu 2
  1260. Type: String
  1261. .RE
  1262. .P
  1263. Space\-separated options that limit the results from search\.
  1264. .SS searchopts
  1265. .RS 0
  1266. .IP \(bu 2
  1267. Default: ""
  1268. .IP \(bu 2
  1269. Type: String
  1270. .RE
  1271. .P
  1272. Space\-separated options that are always passed to search\.
  1273. .SS searchlimit
  1274. .RS 0
  1275. .IP \(bu 2
  1276. Default: 20
  1277. .IP \(bu 2
  1278. Type: Number
  1279. .RE
  1280. .P
  1281. Number of items to limit search results to\. Will not apply at all to legacy
  1282. searches\.
  1283. .SS searchstaleness
  1284. .RS 0
  1285. .IP \(bu 2
  1286. Default: 900 (15 minutes)
  1287. .IP \(bu 2
  1288. Type: Number
  1289. .RE
  1290. .P
  1291. The age of the cache, in seconds, before another registry request is made if
  1292. using legacy search endpoint\.
  1293. .SS send\-metrics
  1294. .RS 0
  1295. .IP \(bu 2
  1296. Default: false
  1297. .IP \(bu 2
  1298. Type: Boolean
  1299. .RE
  1300. .P
  1301. If true, success/failure metrics will be reported to the registry stored in
  1302. \fBmetrics\-registry\fP\|\. These requests contain the number of successful and
  1303. failing runs of the npm CLI and the time period overwhich those counts were
  1304. gathered\. No identifying information is included in these requests\.
  1305. .SS shell
  1306. .RS 0
  1307. .IP \(bu 2
  1308. Default: SHELL environment variable, or "bash" on Posix, or "cmd" on
  1309. Windows
  1310. .IP \(bu 2
  1311. Type: path
  1312. .RE
  1313. .P
  1314. The shell to run for the \fBnpm explore\fP command\.
  1315. .SS shrinkwrap
  1316. .RS 0
  1317. .IP \(bu 2
  1318. Default: true
  1319. .IP \(bu 2
  1320. Type: Boolean
  1321. .RE
  1322. .P
  1323. If set to false, then ignore \fBnpm\-shrinkwrap\.json\fP files when installing\. This
  1324. will also prevent \fIwriting\fR \fBnpm\-shrinkwrap\.json\fP if \fBsave\fP is true\.
  1325. .P
  1326. This option is an alias for \fB\-\-package\-lock\fP\|\.
  1327. .SS sign\-git\-commit
  1328. .RS 0
  1329. .IP \(bu 2
  1330. Default: false
  1331. .IP \(bu 2
  1332. Type: Boolean
  1333. .RE
  1334. .P
  1335. If set to true, then the \fBnpm version\fP command will commit the new package
  1336. version using \fB\-S\fP to add a signature\.
  1337. .P
  1338. Note that git requires you to have set up GPG keys in your git configs
  1339. for this to work properly\.
  1340. .SS sign\-git\-tag
  1341. .RS 0
  1342. .IP \(bu 2
  1343. Default: false
  1344. .IP \(bu 2
  1345. Type: Boolean
  1346. .RE
  1347. .P
  1348. If set to true, then the \fBnpm version\fP command will tag the version
  1349. using \fB\-s\fP to add a signature\.
  1350. .P
  1351. Note that git requires you to have set up GPG keys in your git configs
  1352. for this to work properly\.
  1353. .SS sso\-poll\-frequency
  1354. .RS 0
  1355. .IP \(bu 2
  1356. Default: 500
  1357. .IP \(bu 2
  1358. Type: Number
  1359. .RE
  1360. .P
  1361. When used with SSO\-enabled \fBauth\-type\fPs, configures how regularly the registry
  1362. should be polled while the user is completing authentication\.
  1363. .SS sso\-type
  1364. .RS 0
  1365. .IP \(bu 2
  1366. Default: 'oauth'
  1367. .IP \(bu 2
  1368. Type: 'oauth', 'saml', or null
  1369. .RE
  1370. .P
  1371. If \fB\-\-auth\-type=sso\fP, the type of SSO type to use\.
  1372. .SS strict\-ssl
  1373. .RS 0
  1374. .IP \(bu 2
  1375. Default: true
  1376. .IP \(bu 2
  1377. Type: Boolean
  1378. .RE
  1379. .P
  1380. Whether or not to do SSL key validation when making requests to the
  1381. registry via https\.
  1382. .P
  1383. See also the \fBca\fP config\.
  1384. .SS tag
  1385. .RS 0
  1386. .IP \(bu 2
  1387. Default: latest
  1388. .IP \(bu 2
  1389. Type: String
  1390. .RE
  1391. .P
  1392. If you ask npm to install a package and don't tell it a specific version, then
  1393. it will install the specified tag\.
  1394. .P
  1395. Also the tag that is added to the package@version specified by the \fBnpm
  1396. tag\fP command, if no explicit tag is given\.
  1397. .SS tag\-version\-prefix
  1398. .RS 0
  1399. .IP \(bu 2
  1400. Default: \fB"v"\fP
  1401. .IP \(bu 2
  1402. Type: String
  1403. .RE
  1404. .P
  1405. If set, alters the prefix used when tagging a new version when performing a
  1406. version increment using \fBnpm\-version\fP\|\. To remove the prefix altogether, set it
  1407. to the empty string: \fB""\fP\|\.
  1408. .P
  1409. Because other tools may rely on the convention that npm version tags look like
  1410. \fBv1\.0\.0\fP, \fIonly use this property if it is absolutely necessary\fR\|\. In
  1411. particular, use care when overriding this setting for public packages\.
  1412. .SS timing
  1413. .RS 0
  1414. .IP \(bu 2
  1415. Default: \fBfalse\fP
  1416. .IP \(bu 2
  1417. Type: Boolean
  1418. .RE
  1419. .P
  1420. If true, writes an \fBnpm\-debug\fP log to \fB_logs\fP and timing information to
  1421. \fB_timing\.json\fP, both in your cache\. \fB_timing\.json\fP is a newline delimited
  1422. list of JSON objects\. You can quickly view it with this
  1423. json \fIhttps://www\.npmjs\.com/package/json\fR command line:
  1424. \fBjson \-g < ~/\.npm/_timing\.json\fP\|\.
  1425. .SS tmp
  1426. .RS 0
  1427. .IP \(bu 2
  1428. Default: TMPDIR environment variable, or "/tmp"
  1429. .IP \(bu 2
  1430. Type: path
  1431. .RE
  1432. .P
  1433. Where to store temporary files and folders\. All temp files are deleted
  1434. on success, but left behind on failure for forensic purposes\.
  1435. .SS unicode
  1436. .RS 0
  1437. .IP \(bu 2
  1438. Default: false on windows, true on mac/unix systems with a unicode locale
  1439. .IP \(bu 2
  1440. Type: Boolean
  1441. .RE
  1442. .P
  1443. When set to true, npm uses unicode characters in the tree output\. When
  1444. false, it uses ascii characters to draw trees\.
  1445. .SS unsafe\-perm
  1446. .RS 0
  1447. .IP \(bu 2
  1448. Default: false if running as root, true otherwise
  1449. .IP \(bu 2
  1450. Type: Boolean
  1451. .RE
  1452. .P
  1453. Set to true to suppress the UID/GID switching when running package
  1454. scripts\. If set explicitly to false, then installing as a non\-root user
  1455. will fail\.
  1456. .SS update\-notifier
  1457. .RS 0
  1458. .IP \(bu 2
  1459. Default: true
  1460. .IP \(bu 2
  1461. Type: Boolean
  1462. .RE
  1463. .P
  1464. Set to false to suppress the update notification when using an older
  1465. version of npm than the latest\.
  1466. .SS usage
  1467. .RS 0
  1468. .IP \(bu 2
  1469. Default: false
  1470. .IP \(bu 2
  1471. Type: Boolean
  1472. .RE
  1473. .P
  1474. Set to show short usage output (like the \-H output)
  1475. instead of complete help when doing npm help \fBnpm\-help\fP\|\.
  1476. .SS user
  1477. .RS 0
  1478. .IP \(bu 2
  1479. Default: "nobody"
  1480. .IP \(bu 2
  1481. Type: String or Number
  1482. .RE
  1483. .P
  1484. The UID to set to when running package scripts as root\.
  1485. .SS userconfig
  1486. .RS 0
  1487. .IP \(bu 2
  1488. Default: ~/\.npmrc
  1489. .IP \(bu 2
  1490. Type: path
  1491. .RE
  1492. .P
  1493. The location of user\-level configuration settings\.
  1494. .SS umask
  1495. .RS 0
  1496. .IP \(bu 2
  1497. Default: 022
  1498. .IP \(bu 2
  1499. Type: Octal numeric string in range 0000\.\.0777 (0\.\.511)
  1500. .RE
  1501. .P
  1502. The "umask" value to use when setting the file creation mode on files
  1503. and folders\.
  1504. .P
  1505. Folders and executables are given a mode which is \fB0777\fP masked against
  1506. this value\. Other files are given a mode which is \fB0666\fP masked against
  1507. this value\. Thus, the defaults are \fB0755\fP and \fB0644\fP respectively\.
  1508. .SS user\-agent
  1509. .RS 0
  1510. .IP \(bu 2
  1511. Default: node/{process\.version} {process\.platform} {process\.arch}
  1512. .IP \(bu 2
  1513. Type: String
  1514. .RE
  1515. .P
  1516. Sets a User\-Agent to the request header
  1517. .SS version
  1518. .RS 0
  1519. .IP \(bu 2
  1520. Default: false
  1521. .IP \(bu 2
  1522. Type: boolean
  1523. .RE
  1524. .P
  1525. If true, output the npm version and exit successfully\.
  1526. .P
  1527. Only relevant when specified explicitly on the command line\.
  1528. .SS versions
  1529. .RS 0
  1530. .IP \(bu 2
  1531. Default: false
  1532. .IP \(bu 2
  1533. Type: boolean
  1534. .RE
  1535. .P
  1536. If true, output the npm version as well as node's \fBprocess\.versions\fP map, and
  1537. exit successfully\.
  1538. .P
  1539. Only relevant when specified explicitly on the command line\.
  1540. .SS viewer
  1541. .RS 0
  1542. .IP \(bu 2
  1543. Default: "man" on Posix, "browser" on Windows
  1544. .IP \(bu 2
  1545. Type: path
  1546. .RE
  1547. .P
  1548. The program to use to view help content\.
  1549. .P
  1550. Set to \fB"browser"\fP to view html help content in the default web browser\.
  1551. .SH SEE ALSO
  1552. .RS 0
  1553. .IP \(bu 2
  1554. npm help config
  1555. .IP \(bu 2
  1556. npm help 5 npmrc
  1557. .IP \(bu 2
  1558. npm help 7 scripts
  1559. .IP \(bu 2
  1560. npm help 5 folders
  1561. .IP \(bu 2
  1562. npm help npm
  1563. .RE