summaryrefslogtreecommitdiff
path: root/deps/npm/docs/content/cli-commands/npm-access.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/docs/content/cli-commands/npm-access.md')
-rwxr-xr-xdeps/npm/docs/content/cli-commands/npm-access.md93
1 files changed, 93 insertions, 0 deletions
diff --git a/deps/npm/docs/content/cli-commands/npm-access.md b/deps/npm/docs/content/cli-commands/npm-access.md
new file mode 100755
index 0000000000..370ea5fa3b
--- /dev/null
+++ b/deps/npm/docs/content/cli-commands/npm-access.md
@@ -0,0 +1,93 @@
+---
+section: cli-commands
+title: npm-access
+description: Set access level on published packages
+---
+
+# npm-access
+
+## Set access level on published packages
+
+### Synopsis
+
+```bash
+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](/cli-commands/npm-team)
+* [npm publish](/cli-commands/npm-publish)
+* [npm config](/cli-commands/npm-config)
+* [npm registry](/using-npm/registry)