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.

92 lines
2.7 KiB

  1. .TH "NPM\-ACCESS" "1" "August 2018" "" ""
  2. .SH "NAME"
  3. \fBnpm-access\fR \- Set access level on published packages
  4. .SH SYNOPSIS
  5. .P
  6. .RS 2
  7. .nf
  8. npm access public [<package>]
  9. npm access restricted [<package>]
  10. npm access grant <read\-only|read\-write> <scope:team> [<package>]
  11. npm access revoke <scope:team> [<package>]
  12. npm access ls\-packages [<user>|<scope>|<scope:team>]
  13. npm access ls\-collaborators [<package> [<user>]]
  14. npm access edit [<package>]
  15. .fi
  16. .RE
  17. .SH DESCRIPTION
  18. .P
  19. Used to set access controls on private packages\.
  20. .P
  21. For all of the subcommands, \fBnpm access\fP will perform actions on the packages
  22. in the current working directory if no package name is passed to the
  23. subcommand\.
  24. .RS 0
  25. .IP \(bu 2
  26. public / restricted:
  27. Set a package to be either publicly accessible or restricted\.
  28. .IP \(bu 2
  29. grant / revoke:
  30. Add or remove the ability of users and teams to have read\-only or read\-write
  31. access to a package\.
  32. .IP \(bu 2
  33. ls\-packages:
  34. Show all of the packages a user or a team is able to access, along with the
  35. access level, except for read\-only public packages (it won't print the whole
  36. registry listing)
  37. .IP \(bu 2
  38. ls\-collaborators:
  39. Show all of the access privileges for a package\. Will only show permissions
  40. for packages to which you have at least read access\. If \fB<user>\fP is passed in,
  41. the list is filtered only to teams \fIthat\fR user happens to belong to\.
  42. .IP \(bu 2
  43. edit:
  44. Set the access privileges for a package at once using \fB$EDITOR\fP\|\.
  45. .RE
  46. .SH DETAILS
  47. .P
  48. \fBnpm access\fP always operates directly on the current registry, configurable
  49. from the command line using \fB\-\-registry=<registry url>\fP\|\.
  50. .P
  51. Unscoped packages are \fIalways public\fR\|\.
  52. .P
  53. Scoped packages \fIdefault to restricted\fR, but you can either publish them as
  54. public using \fBnpm publish \-\-access=public\fP, or set their access as public using
  55. \fBnpm access public\fP after the initial publish\.
  56. .P
  57. You must have privileges to set the access of a package:
  58. .RS 0
  59. .IP \(bu 2
  60. You are an owner of an unscoped or scoped package\.
  61. .IP \(bu 2
  62. You are a member of the team that owns a scope\.
  63. .IP \(bu 2
  64. You have been given read\-write privileges for a package, either as a member
  65. of a team or directly as an owner\.
  66. .RE
  67. .P
  68. If you have two\-factor authentication enabled then you'll have to pass in an
  69. otp with \fB\-\-otp\fP when making access changes\.
  70. .P
  71. If your account is not paid, then attempts to publish scoped packages will fail
  72. with an HTTP 402 status code (logically enough), unless you use
  73. \fB\-\-access=public\fP\|\.
  74. .P
  75. Management of teams and team memberships is done with the \fBnpm team\fP command\.
  76. .SH SEE ALSO
  77. .RS 0
  78. .IP \(bu 2
  79. npm help team
  80. .IP \(bu 2
  81. npm help publish
  82. .IP \(bu 2
  83. npm help 7 config
  84. .IP \(bu 2
  85. npm help 7 registry
  86. .RE