FM / commands

/usr/local/lib/node_modules/npm/docs/content/commands/

/usr/local/lib/node_modules/npm/docs/content/commands

Name	Size	Mode	Actions
npm-access.md	2888	0644	edit dl rm
npm-adduser.md	2033	0644	edit dl rm
npm-audit.md	16252	0644	edit dl rm
npm-bugs.md	2997	0644	edit dl rm
npm-cache.md	3450	0644	edit dl rm
npm-ci.md	9770	0644	edit dl rm
npm-completion.md	908	0644	edit dl rm
npm-config.md	4091	0644	edit dl rm
npm-dedupe.md	9543	0644	edit dl rm
npm-deprecate.md	2156	0644	edit dl rm
npm-diff.md	8985	0644	edit dl rm
npm-dist-tag.md	5170	0644	edit dl rm
npm-docs.md	2975	0644	edit dl rm
npm-doctor.md	5047	0644	edit dl rm
npm-edit.md	1091	0644	edit dl rm
npm-exec.md	11357	0644	edit dl rm
npm-explain.md	2794	0644	edit dl rm
npm-explore.md	1006	0644	edit dl rm
npm-find-dupes.md	6791	0644	edit dl rm
npm-fund.md	3674	0644	edit dl rm
npm-get.md	445	0644	edit dl rm
npm-help-search.md	755	0644	edit dl rm
npm-help.md	1003	0644	edit dl rm
npm-init.md	10213	0644	edit dl rm
npm-install-ci-test.md	8083	0644	edit dl rm
npm-install-test.md	11573	0644	edit dl rm
npm-install.md	29306	0644	edit dl rm
npm-link.md	12386	0644	edit dl rm
npm-ll.md	5686	0644	edit dl rm
npm-login.md	2354	0644	edit dl rm
npm-logout.md	1749	0644	edit dl rm
npm-ls.md	7148	0644	edit dl rm
npm-org.md	1974	0644	edit dl rm
npm-outdated.md	6978	0644	edit dl rm
npm-owner.md	3082	0644	edit dl rm
npm-pack.md	3832	0644	edit dl rm
npm-ping.md	769	0644	edit dl rm
npm-pkg.md	8056	0644	edit dl rm
npm-prefix.md	1206	0644	edit dl rm
npm-profile.md	3067	0644	edit dl rm
npm-prune.md	5737	0644	edit dl rm
npm-publish.md	8028	0644	edit dl rm
npm-query.md	6954	0644	edit dl rm
npm-rebuild.md	4994	0644	edit dl rm
npm-repo.md	2755	0644	edit dl rm
npm-restart.md	1444	0644	edit dl rm
npm-root.md	1096	0644	edit dl rm
npm-run.md	7538	0644	edit dl rm
npm-sbom.md	8338	0644	edit dl rm
npm-search.md	3560	0644	edit dl rm
npm-set.md	1433	0644	edit dl rm
npm-shrinkwrap.md	909	0644	edit dl rm
npm-star.md	1712	0644	edit dl rm
npm-stars.md	743	0644	edit dl rm
npm-start.md	1632	0644	edit dl rm
npm-stop.md	1320	0644	edit dl rm
npm-team.md	4084	0644	edit dl rm
npm-test.md	1213	0644	edit dl rm
npm-token.md	4905	0644	edit dl rm
npm-trust.md	10073	0644	edit dl rm
npm-undeprecate.md	1406	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	12972	0644	edit dl rm
npm-version.md	8011	0644	edit dl rm
npm-view.md	7425	0644	edit dl rm
npm-whoami.md	800	0644	edit dl rm
npm.md	5638	0644	edit dl rm
npx.md	6287	0644	edit dl rm

Edit: /usr/local/lib/node_modules/npm/docs/content/commands/npm-token.md (4905B)

---
title: npm-token
section: 1
description: Manage your authentication tokens
---

### Synopsis

```bash
npm token list
npm token revoke <id|token>
npm token create
```

Note: This command is unaware of workspaces.

### Description

This lets you list, create and revoke authentication tokens.

#### Listing tokens

When listing tokens, an abbreviated token will be displayed.  For security purposes the full token is not displayed.

#### Generating tokens

When generating tokens, you will be prompted you for your password and, if you have two-factor authentication enabled, an otp.

Please refer to the [docs website](https://docs.npmjs.com/creating-and-viewing-access-tokens) for more information on generating tokens for CI/CD.

#### Revoking tokens

When revoking a token, you can use the full token (e.g. what you get back from `npm token create`, or as can be found in an `.npmrc` file), or a truncated id.  If the given truncated id is not distinct enough to differentiate between multiple existing tokens, you will need to use enough of the id to allow npm to distinguish between them.  Full token ids can be found on the [npm website](https://www.npmjs.com), or in the `--parseable` or `--json` output of `npm token list`.  This command will NOT accept the truncated token found in the normal `npm token list` output.

A revoked token will immediately be removed from the registry and you will no longer be able to use it.

### Configuration

#### `name`

* Default: null
* Type: null or String

When creating a Granular Access Token with `npm token create`, this sets the
name/description for the token.

#### `token-description`

* Default: null
* Type: null or String

Description text for the token when using `npm token create`.

#### `expires`

* Default: null
* Type: null or Number

When creating a Granular Access Token with `npm token create`, this sets the
expiration in days. If not specified, the server will determine the default
expiration.

#### `packages`

* Default:
* Type: null or String (can be set multiple times)

When creating a Granular Access Token with `npm token create`, this limits
the token access to specific packages.

#### `packages-all`

* Default: false
* Type: Boolean

When creating a Granular Access Token with `npm token create`, grants the
token access to all packages instead of limiting to specific packages.

#### `scopes`

* Default: null
* Type: null or String (can be set multiple times)

When creating a Granular Access Token with `npm token create`, this limits
the token access to specific scopes. Provide a scope name (with or without @
prefix).

#### `orgs`

* Default: null
* Type: null or String (can be set multiple times)

When creating a Granular Access Token with `npm token create`, this limits
the token access to specific organizations.

#### `packages-and-scopes-permission`

* Default: null
* Type: null, "read-only", "read-write", or "no-access"

When creating a Granular Access Token with `npm token create`, sets the
permission level for packages and scopes. Options are "read-only",
"read-write", or "no-access".

#### `orgs-permission`

* Default: null
* Type: null, "read-only", "read-write", or "no-access"

When creating a Granular Access Token with `npm token create`, sets the
permission level for organizations. Options are "read-only", "read-write",
or "no-access".

#### `cidr`

* Default: null
* Type: null or String (can be set multiple times)

This is a list of CIDR address to be used when configuring limited access
tokens with the `npm token create` command.

#### `bypass-2fa`

* Default: false
* Type: Boolean

When creating a Granular Access Token with `npm token create`, setting this
to true will allow the token to bypass two-factor authentication. This is
useful for automation and CI/CD workflows.

#### `password`

* Default: null
* Type: null or String

Password for authentication. Can be provided via command line when creating
tokens, though it's generally safer to be prompted for it.

#### `registry`

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

The base URL of the npm registry.

#### `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.

#### `read-only`

* Default: false
* Type: Boolean

This is used to mark a token as unable to publish when configuring limited
access tokens with the `npm token create` command.

### See Also

* [npm adduser](/commands/npm-adduser)
* [npm registry](/using-npm/registry)
* [npm config](/commands/npm-config)
* [npmrc](/configuring-npm/npmrc)
* [npm owner](/commands/npm-owner)
* [npm whoami](/commands/npm-whoami)
* [npm profile](/commands/npm-profile)

--- title: npm-token section: 1 description: Manage your authentication tokens --- ### Synopsis ```bash npm token list npm token revoke npm token create ``` Note: This command is unaware of workspaces. ### Description This lets you list, create and revoke authentication tokens. #### Listing tokens When listing tokens, an abbreviated token will be displayed. For security purposes the full token is not displayed. #### Generating tokens When generating tokens, you will be prompted you for your password and, if you have two-factor authentication enabled, an otp. Please refer to the [docs website](https://docs.npmjs.com/creating-and-viewing-access-tokens) for more information on generating tokens for CI/CD. #### Revoking tokens When revoking a token, you can use the full token (e.g. what you get back from `npm token create`, or as can be found in an `.npmrc` file), or a truncated id. If the given truncated id is not distinct enough to differentiate between multiple existing tokens, you will need to use enough of the id to allow npm to distinguish between them. Full token ids can be found on the [npm website](https://www.npmjs.com), or in the `--parseable` or `--json` output of `npm token list`. This command will NOT accept the truncated token found in the normal `npm token list` output. A revoked token will immediately be removed from the registry and you will no longer be able to use it. ### Configuration #### `name` * Default: null * Type: null or String When creating a Granular Access Token with `npm token create`, this sets the name/description for the token. #### `token-description` * Default: null * Type: null or String Description text for the token when using `npm token create`. #### `expires` * Default: null * Type: null or Number When creating a Granular Access Token with `npm token create`, this sets the expiration in days. If not specified, the server will determine the default expiration. #### `packages` * Default: * Type: null or String (can be set multiple times) When creating a Granular Access Token with `npm token create`, this limits the token access to specific packages. #### `packages-all` * Default: false * Type: Boolean When creating a Granular Access Token with `npm token create`, grants the token access to all packages instead of limiting to specific packages. #### `scopes` * Default: null * Type: null or String (can be set multiple times) When creating a Granular Access Token with `npm token create`, this limits the token access to specific scopes. Provide a scope name (with or without @ prefix). #### `orgs` * Default: null * Type: null or String (can be set multiple times) When creating a Granular Access Token with `npm token create`, this limits the token access to specific organizations. #### `packages-and-scopes-permission` * Default: null * Type: null, "read-only", "read-write", or "no-access" When creating a Granular Access Token with `npm token create`, sets the permission level for packages and scopes. Options are "read-only", "read-write", or "no-access". #### `orgs-permission` * Default: null * Type: null, "read-only", "read-write", or "no-access" When creating a Granular Access Token with `npm token create`, sets the permission level for organizations. Options are "read-only", "read-write", or "no-access". #### `cidr` * Default: null * Type: null or String (can be set multiple times) This is a list of CIDR address to be used when configuring limited access tokens with the `npm token create` command. #### `bypass-2fa` * Default: false * Type: Boolean When creating a Granular Access Token with `npm token create`, setting this to true will allow the token to bypass two-factor authentication. This is useful for automation and CI/CD workflows. #### `password` * Default: null * Type: null or String Password for authentication. Can be provided via command line when creating tokens, though it's generally safer to be prompted for it. #### `registry` * Default: "https://registry.npmjs.org/" * Type: URL The base URL of the npm registry. #### `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. #### `read-only` * Default: false * Type: Boolean This is used to mark a token as unable to publish when configuring limited access tokens with the `npm token create` command. ### See Also * [npm adduser](/commands/npm-adduser) * [npm registry](/using-npm/registry) * [npm config](/commands/npm-config) * [npmrc](/configuring-npm/npmrc) * [npm owner](/commands/npm-owner) * [npm whoami](/commands/npm-whoami) * [npm profile](/commands/npm-profile)