npm-pkg

Manages your package.json

Select CLI Version:

See Details

Table of contents

Synopsis

npm pkgset<key>=<value>[<key>=<value>...]
npm pkg get[<key>[<key>...]]
npm pkg delete<key>[<key>...]
npm pkgset[<array>[<index>].<key>=<value>...]
npm pkgset[<array>[].<key>=<value>...]
npm pkg fix

Description

A command that automates the management ofpackage.json files.npm pkg provide 3 different sub commands that allow you to modify or retrieve values for given object keys in yourpackage.json.

The syntax to retrieve and set fields is a dot separated representation of the nested object properties to be found within yourpackage.json, it's the same notation used innpm view to retrieve information from the registry manifest, below you can find more examples on how to use it.

Returned values are always injson format.

npm pkg get <field>
Retrieves a valuekey, defined in yourpackage.json file.
For example, in order to retrieve the name of the current package, you can run:
```
npm pkg get name
```
It's also possible to retrieve multiple values at once:
```
npm pkg get name version
```
You can view child fields by separating them with a period. To retrieve the value of a testscript value, you would run the following command:
```
npm pkg get scripts.test
```
For fields that are arrays, requesting a non-numeric field will return all of the values from the objects in the list. For example, to get all the contributor emails for a package, you would run:
```
npm pkg get contributors.email
```
You may also use numeric indices in square braces to specifically select an item in an array field. To just get the email address of the first contributor in the list, you can run:
```
npm pkg get contributors[0].email
```
For complex fields you can also name a property in square brackets to specifically select a child field. This is especially helpful with the exports object:
```
npm pkg get"exports[.].require"
```
npm pkg set <field>=<value>
Sets avalue in yourpackage.json based on thefield value. When saving to yourpackage.json file the same set of rules used duringnpm install and other cli commands that touches thepackage.json file are used, making sure to respect the existing indentation and possibly applying some validation prior to saving values to the file.
The same syntax used to retrieve values from your package can also be used to define new properties or overriding existing ones, below are some examples of how the dot separated syntax can be used to edit yourpackage.json file.
Defining a new bin namedmynewcommand in yourpackage.json that points to a filecli.js:
```
npm pkgsetbin.mynewcommand=cli.js
```
Setting multiple fields at once is also possible:
```
npm pkgsetdescription='Awesome package'engines.node='>=10'
```
It's also possible to add to array values, for example to add a new contributor entry:
```
npm pkgset contributors[0].name='Foo' contributors[0].email='foo@bar.ca'
```
You may also append items to the end of an array using the special empty bracket notation:
```
npm pkgset contributors[].name='Foo' contributors[].name='Bar'
```
It's also possible to parse values as json prior to saving them to yourpackage.json file, for example in order to set a"private": true property:
```
npm pkgsetprivate=true--json
```
It also enables saving values as numbers:
```
npm pkgsettap.timeout=60--json
```
npm pkg delete <key>
Deletes akey from yourpackage.json
The same syntax used to set values from your package can also be used to remove existing ones. For example, in order to remove a script named build:
```
npm pkg delete scripts.build
```
npm pkg fix
Auto corrects common errors in yourpackage.json. npm already does this duringpublish, which leads to subtle (mostly harmless) differences between the contents of yourpackage.json file and the manifest that npm uses during installation.

Workspaces support

You can set/get/delete items across your configured workspaces by using theworkspace orworkspaces config options.

For example, setting afunding value across all configured workspaces of a project:

npm pkgsetfunding=https://example.com--ws

When usingnpm pkg get to retrieve info from your configured workspaces, the returned result will be in a json format in which top level keys are the names of each workspace, the values of these keys will be the result values returned from each of the configured workspaces, e.g:

npm pkg get name version--ws
{
"a":{
"name":"a",
"version":"1.0.0"
},
"b":{
"name":"b",
"version":"1.0.0"
}
}

Configuration

`force`

Default: false
Type: Boolean

Removes various protections against unfortunate side effects, common mistakes, unnecessary performance degradation, and malicious input.

Allow clobbering non-npm files in global installs.
Allow thenpm version command to work on an unclean git repository.
Allow deleting the cache folder withnpm cache clean.
Allow installing packages that have anengines declaration requiring a different version of npm.
Allow installing packages that have anengines declaration requiring a different version ofnode, even if--engine-strict is enabled.
Allownpm audit fix to install modules outside your stated dependency range (including SemVer-major changes).
Allow unpublishing all versions of a published package.
Allow conflicting peerDependencies to be installed in the root project.
Implicitly set--yes duringnpm init.
Allow clobbering existing values innpm pkg
Allow unpublishing of entire packages (not just a single version).

If you don't have a clear idea of what you want to do, it is strongly recommended that you do not use this option!

`json`

Default: false
Type: Boolean

Whether or not to output JSON data, rather than the normal output.

Innpm pkg set it enables parsing set values with JSON.parse() before saving them to yourpackage.json.

Not supported by all npm commands.

`workspace`

Default:
Type: String (can be set multiple times)

Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option.

Valid values for theworkspace config are either:

Workspace names
Path to a workspace directory
Path to a parent workspace directory (will result in selecting all workspaces within that folder)

When set for thenpm init command, this may be set to the folder of a workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.

This value is not exported to the environment for child processes.

`workspaces`

Default: null
Type: null or Boolean

Set to true to run the command in the context ofall configured workspaces.

Explicitly setting this to false will cause commands likeinstall to ignore workspaces altogether. When not set explicitly:

Commands that operate on thenode_modules tree (install, update, etc.) will link workspaces into thenode_modules folder. - Commands that do other things (test, exec, publish, etc.) will operate on the root project,unless one or more workspaces are specified in theworkspace config.

This value is not exported to the environment for child processes.