Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

npm-access (1)

Name

npm-access - 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 ls-packages [<user>|<scope>|<scope:team>]
npm access ls-collaborators [<package> [<user>]]
npm access edit [<package>]

Description

NPM-ACCESS(1)                                                    NPM-ACCESS(1)



NAME
       npm-access - 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 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.

       o public  /  restricted: Set a package to be either publicly accessible
         or restricted.

       o grant / revoke: Add or remove the ability of users and teams to  have
         read-only or read-write access to a package.

       o 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)

       o 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.

       o edit: Set the access privileges for a package at once using $EDITOR.


DETAILS
       npm access always operates directly on the  current  registry,  config-
       urable 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:

       o You are an owner of an unscoped or scoped package.

       o You are a member of the team that owns a scope.

       o 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 com-
       mand.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-------------------------+
       |ATTRIBUTE TYPE |    ATTRIBUTE VALUE      |
       +---------------+-------------------------+
       |Availability   | runtime/nodejs/nodejs-8 |
       +---------------+-------------------------+
       |Stability      | Pass-thru volatile      |
       +---------------+-------------------------+
SEE ALSO
       o npm help team

       o npm help publish

       o npm help 7 config

       o npm help 7 registry





NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was   downloaded   from     https://github.com/nodejs/node/ar-
       chive/v8.15.1.zip

       Further information about this software can be found on the open source
       community website at https://github.com/nodejs/node.



                                  August 2018                    NPM-ACCESS(1)