diff options
author | Gar <gar+gh@danger.computer> | 2022-08-31 18:37:26 +0300 |
---|---|---|
committer | Nathan Fritz <fritzy@github.com> | 2022-09-15 02:08:53 +0300 |
commit | 9c32c6c8d6fc5bdfd6af685731fe26920d7e5446 (patch) | |
tree | ae380e4350d71ce22d54e11f993c13727be3f408 /docs | |
parent | 854521baa49ef88ff9586ec2cc5f1fbaee7fa364 (diff) |
feat(rewrite): rewrite `npm access`
BREAKING CHANGE: renames most of the `npm access` subcommands
- `edit`, having never been implemented, is removed
- `public` is now `set status=public`
- `restricted` is now `set status=private`
- `ls-packages` is now `list packages`
- `ls-collaborators` is now `list collaborators`
- `2fa-required` is now `set mfa=publish`
- `2fa-not-required` is now `set mfa=none`
- `set mfa=automation` is added
- output is no longer in json by default
Usage:
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=false|publish|automation [<package>]
npm access grant <read-only|read-write> <scope:team> [<package>]
npm access revoke <scope:team> [<package>]
Options:
[--json] [--otp <otp>] [--registry <registry>]
Diffstat (limited to 'docs')
-rw-r--r-- | docs/content/commands/npm-access.md | 35 |
1 files changed, 24 insertions, 11 deletions
diff --git a/docs/content/commands/npm-access.md b/docs/content/commands/npm-access.md index f7a98af65..bc481eac1 100644 --- a/docs/content/commands/npm-access.md +++ b/docs/content/commands/npm-access.md @@ -11,15 +11,13 @@ description: Set access level on published packages <!-- see lib/commands/access.js --> ```bash -npm access public [<package>] -npm access restricted [<package>] +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>] -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>] ``` <!-- automatically generated, do not edit manually --> @@ -91,12 +89,17 @@ Management of teams and team memberships is done with the `npm team` command. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js --> -#### `registry` +#### `json` -* Default: "https://registry.npmjs.org/" -* Type: URL +* Default: false +* Type: Boolean -The base URL of the npm registry. +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. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js --> @@ -115,6 +118,16 @@ password, npm will prompt on the command line for one. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js --> +#### `registry` + +* Default: "https://registry.npmjs.org/" +* Type: URL + +The base URL of the npm registry. + +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also |