You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

78 lines
2.0 KiB

.TH "NPM\-ACCESS" "1" "April 2015" "" ""
.SH "NAME"
\fBnpm-access\fR \- Set access level on published packages
.SH SYNOPSIS
.P
.RS 2
.nf
npm access public [<package>]
npm access restricted [<package>]
npm access add <read\-only|read\-write> <entity> [<package>]
npm access rm <entity> [<package>]
npm access ls [<package>]
npm access edit [<package>]
.fi
.RE
.SH DESCRIPTION
.P
Used to set access controls on private packages\.
.P
For all of the subcommands, \fBnpm access\fR will perform actions on the packages
in the current working directory if no package name is passed to the
subcommand\.
.RS 0
.IP \(bu 2
public / restricted:
Set a package to be either publicly accessible or restricted\.
.IP \(bu 2
add / rm:
Add or remove the ability of users and teams to have read\-only or read\-write
access to a package\.
.IP \(bu 2
ls:
Show all of the access privileges for a package\. Will only show permissions
for packages to which you have at least read access\.
.IP \(bu 2
edit:
Set the access privileges for a package at once using \fB$EDITOR\fR\|\.
.RE
.SH DETAILS
.P
\fBnpm access\fR always operates directly on the current registry, configurable
from the command line using \fB\-\-registry=<registry url>\fR\|\.
.P
Unscoped packages are \fIalways public\fR\|\.
.P
Scoped packages \fIdefault to restricted\fR, but you can either publish them as
public using \fBnpm publish \-\-access=public\fR, or set their access as public using
\fBnpm access public\fR after the initial publish\.
.P
You must have privileges to set the access of a package:
.RS 0
.IP \(bu 2
You are an owner of an unscoped or scoped package\.
.IP \(bu 2
You are a member of the team that owns a scope\.
.IP \(bu 2
You have been given read\-write privileges for a package, either as a member
of a team or directly as an owner\.
.RE
.P
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
\fB\-\-access=public\fR\|\.
.SH SEE ALSO
.RS 0
.IP \(bu 2
npm help publish
.IP \(bu 2
npm help 7 config
.IP \(bu 2
npm help 7 registry
.RE