1NPM-PKG(1) NPM-PKG(1)
2
6 npm-pkg - Manages your package.json
7 Synopsis
9 npm pkg get [<field> [.<subfield> ...]]
10 npm pkg set <field>=<value> [.<subfield>=<value> ...]
11 npm pkg delete <field> [.<subfield> ...]
12 Description
14 A command that automates the management of package.json files. npm pkg
15 provide 3 different sub commands that allow you to modify or retrieve
16 values for given object keys in your package.json.
17 The syntax to retrieve and set fields is a dot separated representation
19 of the nested object properties to be found within your package.json,
20 it's the same notation used in npm help view to retrieve information
21 from the registry manifest, below you can find more examples on how to
22 use it.
23 Returned values are always in json format.
25 • npm pkg get <field>
27 Retrieves a value key, defined in your package.json file.
28 For example, in order to retrieve the name of the current package,
29 you
30 can run:
31 npm pkg get name
33 It's also possible to retrieve multiple values at once:
34 npm pkg get name version
36 You can view child fields by separating them with a period. To re‐
37 trieve
38 the value of a test script value, you would run the following com‐
39 mand:
40 npm pkg get scripts.test
42 For fields that are arrays, requesting a non-numeric field will re‐
43 turn
44 all of the values from the objects in the list. For example, to get
45 all
46 the contributor emails for a package, you would run:
47 npm pkg get contributors.email
49 You may also use numeric indices in square braces to specifically se‐
50 lect
51 an item in an array field. To just get the email address of the first
52 contributor in the list, you can run:
53 npm pkg get contributors[0].email
55 • npm pkg set <field>=<value>
57 Sets a value in your package.json based on the field value. When
58 saving to your package.json file the same set of rules used during
59 npm install and other cli commands that touches the package.json
60 file
61 are used, making sure to respect the existing indentation and pos‐
62 sibly
63 applying some validation prior to saving values to the file.
64 The same syntax used to retrieve values from your package can also
65 be used
66 to define new properties or overriding existing ones, below are
67 some
68 examples of how the dot separated syntax can be used to edit your
69 package.json file.
70 Defining a new bin named mynewcommand in your package.json that
71 points
72 to a file cli.js:
73 npm pkg set bin.mynewcommand=cli.js
75 Setting multiple fields at once is also possible:
76 npm pkg set description='Awesome package' engines.node='>=10'
78 It's also possible to add to array values, for example to add a new
79 contributor entry:
80 npm pkg set contributors[0].name='Foo' contributors[0].email='foo@bar.ca'
82 You may also append items to the end of an array using the special
83 empty bracket notation:
84 npm pkg set contributors[].name='Foo' contributors[].name='Bar'
86 It's also possible to parse values as json prior to saving them to
87 your
88 package.json file, for example in order to set a "private": true
89 property:
90 npm pkg set private=true --json
92 It also enables saving values as numbers:
93 npm pkg set tap.timeout=60 --json
95 • npm pkg delete <key>
97 Deletes a key from your package.json
98 The same syntax used to set values from your package can also be
99 used
100 to remove existing ones. For example, in order to remove a script
101 named
102 build:
103 npm pkg delete scripts.build
105 Workspaces support
108 You can set/get/delete items across your configured workspaces by using
109 the workspace or workspaces config options.
110 For example, setting a funding value across all configured workspaces
112 of a project:
113 npm pkg set funding=https://example.com --ws
115 When using npm pkg get to retrieve info from your configured
117 workspaces, the returned result will be in a json format in which top
118 level keys are the names of each workspace, the values of these keys
119 will be the result values returned from each of the configured
120 workspaces, e.g:
121 npm pkg get name version --ws
123 {
124 "a": {
125 "name": "a",
126 "version": "1.0.0"
127 },
128 "b": {
129 "name": "b",
130 "version": "1.0.0"
131 }
132 }
133 Configuration
135 <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically
136 generated, do not edit manually --> <!-- see lib/utils/config/defini‐
137 tions.js -->
138 force
140 • Default: false
141 • Type: Boolean
143 Removes various protections against unfortunate side effects, common
146 mistakes, unnecessary performance degradation, and malicious input.
147 • Allow clobbering non-npm files in global installs.
149 • Allow the npm version command to work on an unclean git repository.
151 • Allow deleting the cache folder with npm cache clean.
153 • Allow installing packages that have an engines declaration requiring
155 a different version of npm.
156 • Allow installing packages that have an engines declaration requiring
158 a different version of node, even if --engine-strict is enabled.
159 • Allow npm audit fix to install modules outside your stated dependency
161 range (including SemVer-major changes).
162 • Allow unpublishing all versions of a published package.
164 • Allow conflicting peerDependencies to be installed in the root
166 project.
167 • Implicitly set --yes during npm init.
169 • Allow clobbering existing values in npm pkg
171 If you don't have a clear idea of what you want to do, it is strongly
174 recommended that you do not use this option! <!-- automatically gener‐
175 ated, do not edit manually --> <!-- see lib/utils/config/definitions.js
176 -->
177 json
180 • Default: false
181 • Type: Boolean
183 Whether or not to output JSON data, rather than the normal output.
186 • In npm pkg set it enables parsing set values with JSON.parse() before
188 saving them to your package.json.
189 Not supported by all npm commands. <!-- automatically generated, do
192 not edit manually --> <!-- see lib/utils/config/definitions.js -->
193 workspace
196 • Default:
197 • Type: String (can be set multiple times)
199 Enable running a command in the context of the configured workspaces of
202 the current project while filtering by running only the workspaces de‐
203 fined by this configuration option.
204 Valid values for the workspace config are either:
206 • Workspace names
208 • Path to a workspace directory
210 • Path to a parent workspace directory (will result in selecting all
212 workspaces within that folder)
213 When set for the npm init command, this may be set to the folder of a
216 workspace which does not yet exist, to create the folder and set it up
217 as a brand new workspace within the project.
218 This value is not exported to the environment for child processes.
220 <!-- automatically generated, do not edit manually --> <!-- see
221 lib/utils/config/definitions.js -->
222 workspaces
225 • Default: null
226 • Type: null or Boolean
228 Set to true to run the command in the context of all configured
231 workspaces.
232 Explicitly setting this to false will cause commands like install to
234 ignore workspaces altogether. When not set explicitly:
235 • Commands that operate on the node_modules tree (install, update,
237 etc.) will link workspaces into the node_modules folder. - Commands
238 that do other things (test, exec, publish, etc.) will operate on the
239 root project, unless one or more workspaces are specified in the
240 workspace config.
241 This value is not exported to the environment for child processes.
244 <!-- automatically generated, do not edit manually --> <!-- see
245 lib/utils/config/definitions.js -->
246 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
248
250 • npm help install
251 • npm help init
253 • npm help config
255 • npm help set-script
257 • npm help workspaces
259 January 2022 NPM-PKG(1)