CLI documentation update from CI

CI User committed Apr 20, 2022 at 03:00 UTC 30fdd647f8b093b4c785c9357bab7e8f983920d5
14 files changed +150 -5
cli/v8
+1 -1
@@ -1 +1 @@
1 -Subproject commit 4ca858c4e210781f369c4403e711dbbbbe5aaca6
1 +Subproject commit 6253d1968d8390ea6b16604ff3abb5e6509349c9
content/cli/v8/commands/npm-audit.md
+12
@@ -409,6 +409,18 @@ This value is not exported to the environment for child processes.
409 <!-- automatically generated, do not edit manually -->
410 <!-- see lib/utils/config/definitions.js -->
411
412 +#### `install-links`
413 +
414 +* Default: false
415 +* Type: Boolean
416 +
417 +When set file: protocol dependencies that exist outside of the project root
418 +will be packed and installed as regular dependencies instead of creating a
419 +symlink. This option has no effect on workspaces.
420 +
421 +<!-- automatically generated, do not edit manually -->
422 +<!-- see lib/utils/config/definitions.js -->
423 +
424 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
425
426 ### See Also
content/cli/v8/commands/npm-ci.md
+3 -2
@@ -58,8 +58,9 @@ In short, the main differences between using `npm install` and `npm ci` are:
58
59 NOTE: If you create your `package-lock.json` file by running `npm install`
60 with flags that can affect the shape of your dependency tree, such as
61 -`--legacy-peer-deps`, you _must_ provide the same flags to `npm ci` or you
62 -are likely to encounter errors. An easy way to do this is to run
61 +`--legacy-peer-deps` or `--install-links`, you _must_ provide the same
62 +flags to `npm ci` or you are likely to encounter errors. An easy way to do
63 +this is to run, for example,
64 `npm config set legacy-peer-deps=true --location=project` and commit the
65 `.npmrc` file to your repo.
66
content/cli/v8/commands/npm-dedupe.md
+12
@@ -320,6 +320,18 @@ This value is not exported to the environment for child processes.
320 <!-- automatically generated, do not edit manually -->
321 <!-- see lib/utils/config/definitions.js -->
322
323 +#### `install-links`
324 +
325 +* Default: false
326 +* Type: Boolean
327 +
328 +When set file: protocol dependencies that exist outside of the project root
329 +will be packed and installed as regular dependencies instead of creating a
330 +symlink. This option has no effect on workspaces.
331 +
332 +<!-- automatically generated, do not edit manually -->
333 +<!-- see lib/utils/config/definitions.js -->
334 +
335 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
336
337 ### See Also
content/cli/v8/commands/npm-find-dupes.md
+12
@@ -244,6 +244,18 @@ This value is not exported to the environment for child processes.
244 <!-- automatically generated, do not edit manually -->
245 <!-- see lib/utils/config/definitions.js -->
246
247 +#### `install-links`
248 +
249 +* Default: false
250 +* Type: Boolean
251 +
252 +When set file: protocol dependencies that exist outside of the project root
253 +will be packed and installed as regular dependencies instead of creating a
254 +symlink. This option has no effect on workspaces.
255 +
256 +<!-- automatically generated, do not edit manually -->
257 +<!-- see lib/utils/config/definitions.js -->
258 +
259 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
260
261 ### See Also
content/cli/v8/commands/npm-install-test.md
+12
@@ -329,6 +329,18 @@ This value is not exported to the environment for child processes.
329 <!-- automatically generated, do not edit manually -->
330 <!-- see lib/utils/config/definitions.js -->
331
332 +#### `install-links`
333 +
334 +* Default: false
335 +* Type: Boolean
336 +
337 +When set file: protocol dependencies that exist outside of the project root
338 +will be packed and installed as regular dependencies instead of creating a
339 +symlink. This option has no effect on workspaces.
340 +
341 +<!-- automatically generated, do not edit manually -->
342 +<!-- see lib/utils/config/definitions.js -->
343 +
344 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
345
346 ### See Also
content/cli/v8/commands/npm-install.md
+14 -2
@@ -102,12 +102,12 @@ into a tarball (b).
102 *npm will not install the package dependencies* in the directory `<folder>`,
103 but it will create a symlink to `<folder>`.
104
105 - > NOTE: If you want to install the content of a directory like a package from the registry instead of creating a link, you would need to use [`npm pack`](/cli/v8/commands/npm-pack) while in the `<folder>` directory, and then install the resulting tarball instead of the `<folder>` using `npm install <tarball file>`
105 + > NOTE: If you want to install the content of a directory like a package from the registry instead of creating a link, you would need to use the `--install-links` option.
106
107 Example:
108
109 ```bash
110 - npm install ../../other-package
110 + npm install ../../other-package --install-links
111 npm install ./sub-package
112 ```
113
@@ -720,6 +720,18 @@ This value is not exported to the environment for child processes.
720 <!-- automatically generated, do not edit manually -->
721 <!-- see lib/utils/config/definitions.js -->
722
723 +#### `install-links`
724 +
725 +* Default: false
726 +* Type: Boolean
727 +
728 +When set file: protocol dependencies that exist outside of the project root
729 +will be packed and installed as regular dependencies instead of creating a
730 +symlink. This option has no effect on workspaces.
731 +
732 +<!-- automatically generated, do not edit manually -->
733 +<!-- see lib/utils/config/definitions.js -->
734 +
735 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
736
737 ### Algorithm
content/cli/v8/commands/npm-link.md
+12
@@ -397,6 +397,18 @@ This value is not exported to the environment for child processes.
397 <!-- automatically generated, do not edit manually -->
398 <!-- see lib/utils/config/definitions.js -->
399
400 +#### `install-links`
401 +
402 +* Default: false
403 +* Type: Boolean
404 +
405 +When set file: protocol dependencies that exist outside of the project root
406 +will be packed and installed as regular dependencies instead of creating a
407 +symlink. This option has no effect on workspaces.
408 +
409 +<!-- automatically generated, do not edit manually -->
410 +<!-- see lib/utils/config/definitions.js -->
411 +
412 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
413
414 ### See Also
content/cli/v8/commands/npm-ls.md
+12
@@ -295,6 +295,18 @@ This value is not exported to the environment for child processes.
295 <!-- automatically generated, do not edit manually -->
296 <!-- see lib/utils/config/definitions.js -->
297
298 +#### `install-links`
299 +
300 +* Default: false
301 +* Type: Boolean
302 +
303 +When set file: protocol dependencies that exist outside of the project root
304 +will be packed and installed as regular dependencies instead of creating a
305 +symlink. This option has no effect on workspaces.
306 +
307 +<!-- automatically generated, do not edit manually -->
308 +<!-- see lib/utils/config/definitions.js -->
309 +
310 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
311
312 ### See Also
content/cli/v8/commands/npm-prune.md
+12
@@ -201,6 +201,18 @@ This value is not exported to the environment for child processes.
201 <!-- automatically generated, do not edit manually -->
202 <!-- see lib/utils/config/definitions.js -->
203
204 +#### `install-links`
205 +
206 +* Default: false
207 +* Type: Boolean
208 +
209 +When set file: protocol dependencies that exist outside of the project root
210 +will be packed and installed as regular dependencies instead of creating a
211 +symlink. This option has no effect on workspaces.
212 +
213 +<!-- automatically generated, do not edit manually -->
214 +<!-- see lib/utils/config/definitions.js -->
215 +
216 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
217
218 ### See Also
content/cli/v8/commands/npm-rebuild.md
+12
@@ -172,6 +172,18 @@ This value is not exported to the environment for child processes.
172 <!-- automatically generated, do not edit manually -->
173 <!-- see lib/utils/config/definitions.js -->
174
175 +#### `install-links`
176 +
177 +* Default: false
178 +* Type: Boolean
179 +
180 +When set file: protocol dependencies that exist outside of the project root
181 +will be packed and installed as regular dependencies instead of creating a
182 +symlink. This option has no effect on workspaces.
183 +
184 +<!-- automatically generated, do not edit manually -->
185 +<!-- see lib/utils/config/definitions.js -->
186 +
187 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
188
189 ### See Also
content/cli/v8/commands/npm-uninstall.md
+12
@@ -155,6 +155,18 @@ This value is not exported to the environment for child processes.
155 <!-- automatically generated, do not edit manually -->
156 <!-- see lib/utils/config/definitions.js -->
157
158 +#### `install-links`
159 +
160 +* Default: false
161 +* Type: Boolean
162 +
163 +When set file: protocol dependencies that exist outside of the project root
164 +will be packed and installed as regular dependencies instead of creating a
165 +symlink. This option has no effect on workspaces.
166 +
167 +<!-- automatically generated, do not edit manually -->
168 +<!-- see lib/utils/config/definitions.js -->
169 +
170 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
171
172 ### See Also
content/cli/v8/commands/npm-update.md
+12
@@ -447,6 +447,18 @@ This value is not exported to the environment for child processes.
447 <!-- automatically generated, do not edit manually -->
448 <!-- see lib/utils/config/definitions.js -->
449
450 +#### `install-links`
451 +
452 +* Default: false
453 +* Type: Boolean
454 +
455 +When set file: protocol dependencies that exist outside of the project root
456 +will be packed and installed as regular dependencies instead of creating a
457 +symlink. This option has no effect on workspaces.
458 +
459 +<!-- automatically generated, do not edit manually -->
460 +<!-- see lib/utils/config/definitions.js -->
461 +
462 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
463
464 ### See Also
content/cli/v8/using-npm/config.md
+12
@@ -899,6 +899,18 @@ number, if not already set in package.json.
899 <!-- automatically generated, do not edit manually -->
900 <!-- see lib/utils/config/definitions.js -->
901
902 +#### `install-links`
903 +
904 +* Default: false
905 +* Type: Boolean
906 +
907 +When set file: protocol dependencies that exist outside of the project root
908 +will be packed and installed as regular dependencies instead of creating a
909 +symlink. This option has no effect on workspaces.
910 +
911 +<!-- automatically generated, do not edit manually -->
912 +<!-- see lib/utils/config/definitions.js -->
913 +
914 #### `json`
915
916 * Default: false