File Explorer

1.TH "NPM-PKG" "1" "February 2026" "NPM@11.11.0" ""2.SH "NAME"3\fBnpm-pkg\fR - Manages your package.json4.SS "Synopsis"5.P6.RS 27.nf8npm pkg set <key>=<value> \[lB]<key>=<value> ...\[rB]9npm pkg get \[lB]<key> \[lB]<key> ...\[rB]\[rB]10npm pkg delete <key> \[lB]<key> ...\[rB]11npm pkg set \[lB]<array>\[lB]<index>\[rB].<key>=<value> ...\[rB]12npm pkg set \[lB]<array>\[lB]\[rB].<key>=<value> ...\[rB]13npm pkg fix14.fi15.RE16.SS "Description"17.P18A command that automates the management of \fBpackage.json\fR files. \fBnpm pkg\fR provide 3 different sub commands that allow you to modify or retrieve values for given object keys in your \fBpackage.json\fR.19.P20The syntax to retrieve and set fields is a dot separated representation of the nested object properties to be found within your \fBpackage.json\fR, it's the same notation used in npm help view to retrieve information from the registry manifest, below you can find more examples on how to use it.21.P22Returned values are always in \fBjson\fR format.23.RS 024.IP \(bu 425\fBnpm pkg get <field>\fR26.P27Retrieves a value \fBkey\fR, defined in your \fBpackage.json\fR file.28.P29For example, in order to retrieve the name of the current package, you can run:30.P31.RS 232.nf33npm pkg get name34.fi35.RE36.P37It's also possible to retrieve multiple values at once:38.P39.RS 240.nf41npm pkg get name version42.fi43.RE44.P45You can view child fields by separating them with a period. To retrieve the value of a test \fBscript\fR value, you would run the following command:46.P47.RS 248.nf49npm pkg get scripts.test50.fi51.RE52.P53For 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:54.P55.RS 256.nf57npm pkg get contributors.email58.fi59.RE60.P61You 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:62.P63.RS 264.nf65npm pkg get contributors\[lB]0\[rB].email66.fi67.RE68.P69For 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:70.P71.RS 272.nf73npm pkg get "exports\[lB].\[rB].require"74.fi75.RE76.IP \(bu 477\fBnpm pkg set <field>=<value>\fR78.P79Sets a \fBvalue\fR in your \fBpackage.json\fR based on the \fBfield\fR value. When saving to your \fBpackage.json\fR file the same set of rules used during \fBnpm install\fR and other cli commands that touches the \fBpackage.json\fR file are used, making sure to respect the existing indentation and possibly applying some validation prior to saving values to the file.80.P81The 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 your \fBpackage.json\fR file.82.P83Defining a new bin named \fBmynewcommand\fR in your \fBpackage.json\fR that points to a file \fBcli.js\fR:84.P85.RS 286.nf87npm pkg set bin.mynewcommand=cli.js88.fi89.RE90.P91Setting multiple fields at once is also possible:92.P93.RS 294.nf95npm pkg set description='Awesome package' engines.node='>=10'96.fi97.RE98.P99It's also possible to add to array values, for example to add a new contributor entry:100.P101.RS 2102.nf103npm pkg set contributors\[lB]0\[rB].name='Foo' contributors\[lB]0\[rB].email='foo@bar.ca'104.fi105.RE106.P107You may also append items to the end of an array using the special empty bracket notation:108.P109.RS 2110.nf111npm pkg set contributors\[lB]\[rB].name='Foo' contributors\[lB]\[rB].name='Bar'112.fi113.RE114.P115It's also possible to parse values as json prior to saving them to your \fBpackage.json\fR file, for example in order to set a \fB"private": true\fR property:116.P117.RS 2118.nf119npm pkg set private=true --json120.fi121.RE122.P123It also enables saving values as numbers:124.P125.RS 2126.nf127npm pkg set tap.timeout=60 --json128.fi129.RE130.IP \(bu 4131\fBnpm pkg delete <key>\fR132.P133Deletes a \fBkey\fR from your \fBpackage.json\fR134.P135The 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:136.P137.RS 2138.nf139npm pkg delete scripts.build140.fi141.RE142.IP \(bu 4143\fBnpm pkg fix\fR144.P145Auto corrects common errors in your \fBpackage.json\fR. npm already does this during \fBpublish\fR, which leads to subtle (mostly harmless) differences between the contents of your \fBpackage.json\fR file and the manifest that npm uses during installation.146.RE 0147 148.SS "Workspaces support"149.P150You can set/get/delete items across your configured workspaces by using the \fB\[rs]fBworkspace\[rs]fR\fR \fI\(la/using-npm/config#workspace\(ra\fR or \fB\[rs]fBworkspaces\[rs]fR\fR \fI\(la/using-npm/config#workspaces\(ra\fR config options.151.P152For example, setting a \fBfunding\fR value across all configured workspaces of a project:153.P154.RS 2155.nf156npm pkg set funding=https://example.com --ws157.fi158.RE159.P160When using \fBnpm pkg get\fR 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:161.P162.RS 2163.nf164npm pkg get name version --ws165{166  "a": {167    "name": "a",168    "version": "1.0.0"169  },170  "b": {171    "name": "b",172    "version": "1.0.0"173  }174}175.fi176.RE177.SS "Configuration"178.SS "\fBforce\fR"179.RS 0180.IP \(bu 4181Default: false182.IP \(bu 4183Type: Boolean184.RE 0185 186.P187Removes various protections against unfortunate side effects, common mistakes, unnecessary performance degradation, and malicious input.188.RS 0189.IP \(bu 4190Allow clobbering non-npm files in global installs.191.IP \(bu 4192Allow the \fBnpm version\fR command to work on an unclean git repository.193.IP \(bu 4194Allow deleting the cache folder with \fBnpm cache clean\fR.195.IP \(bu 4196Allow installing packages that have an \fBengines\fR declaration requiring a different version of npm.197.IP \(bu 4198Allow installing packages that have an \fBengines\fR declaration requiring a different version of \fBnode\fR, even if \fB--engine-strict\fR is enabled.199.IP \(bu 4200Allow \fBnpm audit fix\fR to install modules outside your stated dependency range (including SemVer-major changes).201.IP \(bu 4202Allow unpublishing all versions of a published package.203.IP \(bu 4204Allow conflicting peerDependencies to be installed in the root project.205.IP \(bu 4206Implicitly set \fB--yes\fR during \fBnpm init\fR.207.IP \(bu 4208Allow clobbering existing values in \fBnpm pkg\fR209.IP \(bu 4210Allow unpublishing of entire packages (not just a single version).211.RE 0212 213.P214If you don't have a clear idea of what you want to do, it is strongly recommended that you do not use this option!215.SS "\fBjson\fR"216.RS 0217.IP \(bu 4218Default: false219.IP \(bu 4220Type: Boolean221.RE 0222 223.P224Whether or not to output JSON data, rather than the normal output.225.RS 0226.IP \(bu 4227In \fBnpm pkg set\fR it enables parsing set values with JSON.parse() before saving them to your \fBpackage.json\fR.228.RE 0229 230.P231Not supported by all npm commands.232.SS "\fBworkspace\fR"233.RS 0234.IP \(bu 4235Default:236.IP \(bu 4237Type: String (can be set multiple times)238.RE 0239 240.P241Enable 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.242.P243Valid values for the \fBworkspace\fR config are either:244.RS 0245.IP \(bu 4246Workspace names247.IP \(bu 4248Path to a workspace directory249.IP \(bu 4250Path to a parent workspace directory (will result in selecting all workspaces within that folder)251.RE 0252 253.P254When set for the \fBnpm init\fR 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.255.P256This value is not exported to the environment for child processes.257.SS "\fBworkspaces\fR"258.RS 0259.IP \(bu 4260Default: null261.IP \(bu 4262Type: null or Boolean263.RE 0264 265.P266Set to true to run the command in the context of \fBall\fR configured workspaces.267.P268Explicitly setting this to false will cause commands like \fBinstall\fR to ignore workspaces altogether. When not set explicitly:269.RS 0270.IP \(bu 4271Commands that operate on the \fBnode_modules\fR tree (install, update, etc.) will link workspaces into the \fBnode_modules\fR folder. - Commands that do other things (test, exec, publish, etc.) will operate on the root project, \fIunless\fR one or more workspaces are specified in the \fBworkspace\fR config.272.RE 0273 274.P275This value is not exported to the environment for child processes.276.SH "SEE ALSO"277.RS 0278.IP \(bu 4279npm help install280.IP \(bu 4281npm help init282.IP \(bu 4283npm help config284.IP \(bu 4285npm help workspaces286.RE 0287