aboutsummaryrefslogtreecommitdiff
path: root/deps/node/deps/npm/doc/cli/npm-access.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2019-04-03 15:43:32 +0200
committerFlorian Dold <florian.dold@gmail.com>2019-04-03 15:45:57 +0200
commit71e285b94c7edaa43aa8115965cf5a36b8e0f80a (patch)
tree7d4aa9d0d5aff686b106cd5da72ba77960c4af43 /deps/node/deps/npm/doc/cli/npm-access.md
parent7dadf9356b4f3f4137ce982ea5bb960283116e9a (diff)
downloadakono-71e285b94c7edaa43aa8115965cf5a36b8e0f80a.tar.gz
akono-71e285b94c7edaa43aa8115965cf5a36b8e0f80a.tar.bz2
akono-71e285b94c7edaa43aa8115965cf5a36b8e0f80a.zip
Node.js v11.13.0
Diffstat (limited to 'deps/node/deps/npm/doc/cli/npm-access.md')
-rw-r--r--deps/node/deps/npm/doc/cli/npm-access.md84
1 files changed, 84 insertions, 0 deletions
diff --git a/deps/node/deps/npm/doc/cli/npm-access.md b/deps/node/deps/npm/doc/cli/npm-access.md
new file mode 100644
index 00000000..aeea0178
--- /dev/null
+++ b/deps/node/deps/npm/doc/cli/npm-access.md
@@ -0,0 +1,84 @@
+npm-access(1) -- Set access level on published packages
+=======================================================
+
+## SYNOPSIS
+
+ npm access public [<package>]
+ npm access restricted [<package>]
+
+ npm access grant <read-only|read-write> <scope:team> [<package>]
+ npm access revoke <scope:team> [<package>]
+
+ npm access 2fa-required [<package>]
+ npm access 2fa-not-required [<package>]
+
+ npm access ls-packages [<user>|<scope>|<scope:team>]
+ npm access ls-collaborators [<package> [<user>]]
+ npm access edit [<package>]
+
+## DESCRIPTION
+
+Used to set access controls on private packages.
+
+For all of the subcommands, `npm access` will perform actions on the packages
+in the current working directory if no package name is passed to the
+subcommand.
+
+* public / restricted:
+ Set a package to be either publicly accessible or restricted.
+
+* grant / revoke:
+ Add or remove the ability of users and teams to have read-only or read-write
+ access to a package.
+
+* 2fa-required / 2fa-not-required:
+ Configure whether a package requires that anyone publishing it have two-factor
+ authentication enabled on their account.
+
+* ls-packages:
+ Show all of the packages a user or a team is able to access, along with the
+ access level, except for read-only public packages (it won't print the whole
+ registry listing)
+
+* ls-collaborators:
+ Show all of the access privileges for a package. Will only show permissions
+ for packages to which you have at least read access. If `<user>` is passed in,
+ the list is filtered only to teams _that_ user happens to belong to.
+
+* edit:
+ Set the access privileges for a package at once using `$EDITOR`.
+
+## DETAILS
+
+`npm access` always operates directly on the current registry, configurable
+from the command line using `--registry=<registry url>`.
+
+Unscoped packages are *always public*.
+
+Scoped packages *default to restricted*, but you can either publish them as
+public using `npm publish --access=public`, or set their access as public using
+`npm access public` after the initial publish.
+
+You must have privileges to set the access of a package:
+
+* You are an owner of an unscoped or scoped package.
+* You are a member of the team that owns a scope.
+* You have been given read-write privileges for a package, either as a member
+ of a team or directly as an owner.
+
+If you have two-factor authentication enabled then you'll have to pass in an
+otp with `--otp` when making access changes.
+
+If your account is not paid, then attempts to publish scoped packages will fail
+with an HTTP 402 status code (logically enough), unless you use
+`--access=public`.
+
+Management of teams and team memberships is done with the `npm team` command.
+
+## SEE ALSO
+
+* [`libnpmaccess`](https://npm.im/libnpmaccess)
+* npm-team(1)
+* npm-publish(1)
+* npm-config(7)
+* npm-registry(7)