Skip to content

docs: updates the token create documentation #8785

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wraithgar merged 4 commits into from
Nov 26, 2025
Merged

docs: updates the token create documentation #8785

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cb8d9e8
docs: updates the token create documentation
owlstronaut Nov 26, 2025
7b8885a
fixup: update description copy
wraithgar Nov 26, 2025
bf33f95
fixup: copy
wraithgar Nov 26, 2025
6a21efb
fixup: copy
wraithgar Nov 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions docs/lib/content/commands/npm-token.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,24 @@ Publish token npm_… with id e0cf92 created 2017-10-02

```

* `npm token create [--read-only] [--cidr=<cidr-ranges>]`:
Create a new authentication token.
It can be `--read-only`, or accept a list of [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) ranges with which to limit use of this token.
* `npm token create --name=<name> [--token-description=<desc>] [--packages=<pkg1,pkg2>] [--packages-all] [--scopes=<scope1,scope2>] [--orgs=<org1,org2>] [--packages-and-scopes-permission=<read-only|read-write|no-access>] [--orgs-permission=<read-only|read-write|no-access>] [--expires=<days>] [--cidr=<ip-range>] [--bypass-2fa] [--password=<pass>]`:
Create a new token.
You can customize the token with various options:
- `--name=<name>`: Set the token name/description (required)
- `--token-description=<desc>`: Additional description text
- `--packages=<pkg1,pkg2>`: Limit token access to specific packages
- `--packages-all`: Grant access to all packages
- `--scopes=<scope1,scope2>`: Limit token access to specific scopes
- `--orgs=<org1,org2>`: Limit token access to specific organizations
- `--packages-and-scopes-permission=<read-only|read-write|no-access>`: Set permission level for packages and scopes
- `--orgs-permission=<read-only|read-write|no-access>`: Set permission level for organizations
- `--expires=<days>`: Set token expiration in days (default: 7, maximum: 90)
- `--cidr=<ip-range>`: Limit token use to specific [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) IP ranges
- `--bypass-2fa`: Allow token to bypass two-factor authentication (useful for automation)
- `--password=<pass>`: Provide password via command line (safer to be prompted)

This will prompt you for your password, and, if you have two-factor authentication enabled, an otp.

Currently, the cli cannot generate automation tokens.
Please refer to the [docs website](https://docs.npmjs.com/creating-and-viewing-access-tokens) for more information on generating automation tokens.

```
Created publish token a73c9572-f1b9-8983-983d-ba3ac3cc913d
```
Expand Down
Loading