--- section: cli-commands title: npm-access description: Set access level on published packages --- # npm-access(1) ## 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)
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
npm-access.md | File | 2.87 KB | 0644 |
|
npm-adduser.md | File | 2.93 KB | 0644 |
|
npm-audit.md | File | 4.08 KB | 0644 |
|
npm-bin.md | File | 452 B | 0644 |
|
npm-bugs.md | File | 1.08 KB | 0644 |
|
npm-build.md | File | 645 B | 0644 |
|
npm-bundle.md | File | 416 B | 0644 |
|
npm-cache.md | File | 2.73 KB | 0644 |
|
npm-ci.md | File | 1.92 KB | 0644 |
|
npm-completion.md | File | 936 B | 0644 |
|
npm-config.md | File | 1.62 KB | 0644 |
|
npm-dedupe.md | File | 1.44 KB | 0644 |
|
npm-deprecate.md | File | 953 B | 0644 |
|
npm-dist-tag.md | File | 2.95 KB | 0644 |
|
npm-docs.md | File | 1.14 KB | 0644 |
|
npm-doctor.md | File | 4.65 KB | 0644 |
|
npm-edit.md | File | 1.07 KB | 0644 |
|
npm-explore.md | File | 1.04 KB | 0644 |
|
npm-fund.md | File | 1.59 KB | 0644 |
|
npm-help-search.md | File | 910 B | 0644 |
|
npm-help.md | File | 989 B | 0644 |
|
npm-hook.md | File | 1.88 KB | 0644 |
|
npm-init.md | File | 2.17 KB | 0644 |
|
npm-install-ci-test.md | File | 438 B | 0644 |
|
npm-install-test.md | File | 832 B | 0644 |
|
npm-install.md | File | 19.03 KB | 0644 |
|
npm-link.md | File | 2.75 KB | 0644 |
|
npm-logout.md | File | 1.28 KB | 0644 |
|
npm-ls.md | File | 2.57 KB | 0644 |
|
npm-org.md | File | 1.01 KB | 0644 |
|
npm-outdated.md | File | 3.86 KB | 0644 |
|
npm-owner.md | File | 1.22 KB | 0644 |
|
npm-pack.md | File | 1.01 KB | 0644 |
|
npm-ping.md | File | 519 B | 0644 |
|
npm-prefix.md | File | 678 B | 0644 |
|
npm-profile.md | File | 2.89 KB | 0644 |
|
npm-prune.md | File | 1.38 KB | 0644 |
|
npm-publish.md | File | 3.12 KB | 0644 |
|
npm-rebuild.md | File | 495 B | 0644 |
|
npm-repo.md | File | 774 B | 0644 |
|
npm-restart.md | File | 962 B | 0644 |
|
npm-root.md | File | 438 B | 0644 |
|
npm-run-script.md | File | 3.49 KB | 0644 |
|
npm-search.md | File | 2.85 KB | 0644 |
|
npm-shrinkwrap.md | File | 1004 B | 0644 |
|
npm-star.md | File | 591 B | 0644 |
|
npm-stars.md | File | 614 B | 0644 |
|
npm-start.md | File | 798 B | 0644 |
|
npm-stop.md | File | 452 B | 0644 |
|
npm-team.md | File | 2.2 KB | 0644 |
|
npm-test.md | File | 469 B | 0644 |
|
npm-token.md | File | 2.8 KB | 0644 |
|
npm-uninstall.md | File | 1.53 KB | 0644 |
|
npm-unpublish.md | File | 1.45 KB | 0644 |
|
npm-update.md | File | 3.39 KB | 0644 |
|
npm-version.md | File | 4.47 KB | 0644 |
|
npm-view.md | File | 3.19 KB | 0644 |
|
npm-whoami.md | File | 385 B | 0644 |
|
npm.md | File | 5.31 KB | 0644 |
|