npm-profile.1 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. .TH "NPM\-PROFILE" "1" "October 2021" "" ""
  2. .SH "NAME"
  3. \fBnpm-profile\fR \- Change settings on your registry profile
  4. .SS Synopsis
  5. .P
  6. .RS 2
  7. .nf
  8. npm profile get [\-\-json|\-\-parseable] [<property>]
  9. npm profile set [\-\-json|\-\-parseable] <property> <value>
  10. npm profile set password
  11. npm profile enable\-2fa [auth\-and\-writes|auth\-only]
  12. npm profile disable\-2fa
  13. .fi
  14. .RE
  15. .P
  16. Note: This command is unaware of workspaces\.
  17. .SS Description
  18. .P
  19. Change your profile information on the registry\. Note that this command
  20. depends on the registry implementation, so third\-party registries may not
  21. support this interface\.
  22. .RS 0
  23. .IP \(bu 2
  24. \fBnpm profile get [<property>]\fP: Display all of the properties of your
  25. profile, or one or more specific properties\. It looks like:
  26. .RE
  27. .P
  28. .RS 2
  29. .nf
  30. +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
  31. | name | example |
  32. +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
  33. | email | me@example\.com (verified) |
  34. +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
  35. | two factor auth | auth\-and\-writes |
  36. +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
  37. | fullname | Example User |
  38. +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
  39. | homepage | |
  40. +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
  41. | freenode | |
  42. +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
  43. | twitter | |
  44. +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
  45. | github | |
  46. +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
  47. | created | 2015\-02\-26T01:38:35\.892Z |
  48. +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
  49. | updated | 2017\-10\-02T21:29:45\.922Z |
  50. +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
  51. .fi
  52. .RE
  53. .RS 0
  54. .IP \(bu 2
  55. \fBnpm profile set <property> <value>\fP: Set the value of a profile
  56. property\. You can set the following properties this way: email, fullname,
  57. homepage, freenode, twitter, github
  58. .IP \(bu 2
  59. \fBnpm profile set password\fP: Change your password\. This is interactive,
  60. you'll be prompted for your current password and a new password\. You'll
  61. also be prompted for an OTP if you have two\-factor authentication
  62. enabled\.
  63. .IP \(bu 2
  64. \fBnpm profile enable\-2fa [auth\-and\-writes|auth\-only]\fP: Enables two\-factor
  65. authentication\. Defaults to \fBauth\-and\-writes\fP mode\. Modes are:
  66. .RS
  67. .IP \(bu 2
  68. \fBauth\-only\fP: Require an OTP when logging in or making changes to your
  69. account's authentication\. The OTP will be required on both the website
  70. and the command line\.
  71. .IP \(bu 2
  72. \fBauth\-and\-writes\fP: Requires an OTP at all the times \fBauth\-only\fP does,
  73. and also requires one when publishing a module, setting the \fBlatest\fP
  74. dist\-tag, or changing access via \fBnpm access\fP and \fBnpm owner\fP\|\.
  75. .RE
  76. .IP \(bu 2
  77. \fBnpm profile disable\-2fa\fP: Disables two\-factor authentication\.
  78. .RE
  79. .SS Details
  80. .P
  81. Some of these commands may not be available on non npmjs\.com registries\.
  82. .SS Configuration
  83. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS START \-\->
  84. <!\-\- automatically generated, do not edit manually \-\->
  85. <!\-\- see lib/utils/config/definitions\.js \-\->
  86. .SS \fBregistry\fP
  87. .RS 0
  88. .IP \(bu 2
  89. Default: "https://registry\.npmjs\.org/"
  90. .IP \(bu 2
  91. Type: URL
  92. .RE
  93. .P
  94. The base URL of the npm registry\.
  95. <!\-\- automatically generated, do not edit manually \-\->
  96. <!\-\- see lib/utils/config/definitions\.js \-\->
  97. .SS \fBjson\fP
  98. .RS 0
  99. .IP \(bu 2
  100. Default: false
  101. .IP \(bu 2
  102. Type: Boolean
  103. .RE
  104. .P
  105. Whether or not to output JSON data, rather than the normal output\.
  106. .RS 0
  107. .IP \(bu 2
  108. In \fBnpm pkg set\fP it enables parsing set values with JSON\.parse() before
  109. saving them to your \fBpackage\.json\fP\|\.
  110. .RE
  111. .P
  112. Not supported by all npm commands\.
  113. <!\-\- automatically generated, do not edit manually \-\->
  114. <!\-\- see lib/utils/config/definitions\.js \-\->
  115. .SS \fBparseable\fP
  116. .RS 0
  117. .IP \(bu 2
  118. Default: false
  119. .IP \(bu 2
  120. Type: Boolean
  121. .RE
  122. .P
  123. Output parseable results from commands that write to standard output\. For
  124. \fBnpm search\fP, this will be tab\-separated table format\.
  125. <!\-\- automatically generated, do not edit manually \-\->
  126. <!\-\- see lib/utils/config/definitions\.js \-\->
  127. .SS \fBotp\fP
  128. .RS 0
  129. .IP \(bu 2
  130. Default: null
  131. .IP \(bu 2
  132. Type: null or String
  133. .RE
  134. .P
  135. This is a one\-time password from a two\-factor authenticator\. It's needed
  136. when publishing or changing package permissions with \fBnpm access\fP\|\.
  137. .P
  138. If not set, and a registry response fails with a challenge for a one\-time
  139. password, npm will prompt on the command line for one\.
  140. <!\-\- automatically generated, do not edit manually \-\->
  141. <!\-\- see lib/utils/config/definitions\.js \-\->
  142. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS END \-\->
  143. .SS See Also
  144. .RS 0
  145. .IP \(bu 2
  146. npm help adduser
  147. .IP \(bu 2
  148. npm help registry
  149. .IP \(bu 2
  150. npm help config
  151. .IP \(bu 2
  152. npm help npmrc
  153. .IP \(bu 2
  154. npm help owner
  155. .IP \(bu 2
  156. npm help whoami
  157. .IP \(bu 2
  158. npm help token
  159. .RE