FM / commands

/snap/node/11782/lib/node_modules/npm/docs/content/commands/

/snap/node/11782/lib/node_modules/npm/docs/content/commands

Name	Size	Mode	Actions
npm-access.md	3664	0644	edit dl rm
npm-adduser.md	1847	0644	edit dl rm
npm-audit.md	15656	0644	edit dl rm
npm-bugs.md	2996	0644	edit dl rm
npm-cache.md	2962	0644	edit dl rm
npm-ci.md	9125	0644	edit dl rm
npm-completion.md	909	0644	edit dl rm
npm-config.md	4093	0644	edit dl rm
npm-dedupe.md	8895	0644	edit dl rm
npm-deprecate.md	1741	0644	edit dl rm
npm-diff.md	9109	0644	edit dl rm
npm-dist-tag.md	5181	0644	edit dl rm
npm-docs.md	2974	0644	edit dl rm
npm-doctor.md	5057	0644	edit dl rm
npm-edit.md	1091	0644	edit dl rm
npm-exec.md	11401	0644	edit dl rm
npm-explain.md	2795	0644	edit dl rm
npm-explore.md	1006	0644	edit dl rm
npm-find-dupes.md	6797	0644	edit dl rm
npm-fund.md	3673	0644	edit dl rm
npm-help-search.md	756	0644	edit dl rm
npm-help.md	1004	0644	edit dl rm
npm-hook.md	2394	0644	edit dl rm
npm-init.md	9855	0644	edit dl rm
npm-install-ci-test.md	7434	0644	edit dl rm
npm-install-test.md	9814	0644	edit dl rm
npm-install.md	24984	0644	edit dl rm
npm-link.md	11742	0644	edit dl rm
npm-login.md	2171	0644	edit dl rm
npm-logout.md	1749	0644	edit dl rm
npm-ls.md	8547	0644	edit dl rm
npm-org.md	1975	0644	edit dl rm
npm-outdated.md	5779	0644	edit dl rm
npm-owner.md	3093	0644	edit dl rm
npm-pack.md	3448	0644	edit dl rm
npm-ping.md	769	0644	edit dl rm
npm-pkg.md	8129	0644	edit dl rm
npm-prefix.md	1211	0644	edit dl rm
npm-profile.md	3102	0644	edit dl rm
npm-prune.md	5745	0644	edit dl rm
npm-publish.md	7622	0644	edit dl rm
npm-query.md	6958	0644	edit dl rm
npm-rebuild.md	5001	0644	edit dl rm
npm-repo.md	2754	0644	edit dl rm
npm-restart.md	1473	0644	edit dl rm
npm-root.md	1097	0644	edit dl rm
npm-run-script.md	7561	0644	edit dl rm
npm-sbom.md	8337	0644	edit dl rm
npm-search.md	3464	0644	edit dl rm
npm-shrinkwrap.md	923	0644	edit dl rm
npm-star.md	1713	0644	edit dl rm
npm-stars.md	743	0644	edit dl rm
npm-start.md	1667	0644	edit dl rm
npm-stop.md	1341	0644	edit dl rm
npm-team.md	4090	0644	edit dl rm
npm-test.md	1234	0644	edit dl rm
npm-token.md	2893	0644	edit dl rm
npm-uninstall.md	4447	0644	edit dl rm
npm-unpublish.md	4491	0644	edit dl rm
npm-unstar.md	1574	0644	edit dl rm
npm-update.md	11871	0644	edit dl rm
npm-version.md	6902	0644	edit dl rm
npm-view.md	5612	0644	edit dl rm
npm-whoami.md	800	0644	edit dl rm
npm.md	5670	0644	edit dl rm
npx.md	5895	0644	edit dl rm

Edit: /snap/node/11782/lib/node_modules/npm/docs/content/commands/npm-access.md (3664B)

---
title: npm-access
section: 1
description: Set access level on published packages
---

### Synopsis

```bash
npm access list packages [<user>|<scope>|<scope:team>] [<package>]
npm access list collaborators [<package> [<user>]]
npm access get status [<package>]
npm access set status=public|private [<package>]
npm access set mfa=none|publish|automation [<package>]
npm access grant <read-only|read-write> <scope:team> [<package>]
npm access revoke <scope:team> [<package>]
```

Note: This command is unaware of workspaces.

### 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 (deprecated):
  Set a package to be either publicly accessible or restricted.

* grant / revoke (deprecated):
  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 (deprecated):
  Configure whether a package requires that anyone publishing it have two-factor
  authentication enabled on their account.

* ls-packages (deprecated):
  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 (deprecated):
  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 (not implemented)

### 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 be prompted to provide a second factor, or may use the `--otp=...` option to specify it on
the command line.

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.

### Configuration

#### `json`

* Default: false
* Type: Boolean

Whether or not to output JSON data, rather than the normal output.

* In `npm pkg set` it enables parsing set values with JSON.parse() before
  saving them to your `package.json`.

Not supported by all npm commands.

#### `otp`

* Default: null
* Type: null or String

This is a one-time password from a two-factor authenticator. It's needed
when publishing or changing package permissions with `npm access`.

If not set, and a registry response fails with a challenge for a one-time
password, npm will prompt on the command line for one.

#### `registry`

* Default: "https://registry.npmjs.org/"
* Type: URL

The base URL of the npm registry.

### See Also

* [`libnpmaccess`](https://npm.im/libnpmaccess)
* [npm team](/commands/npm-team)
* [npm publish](/commands/npm-publish)
* [npm config](/commands/npm-config)
* [npm registry](/using-npm/registry)

cmd: