CLI documentation update from CI

npm CLI robot committed May 19, 2022 at 02:58 UTC 3de3e27163be02071bb0ca5abf5505a922bfec2c
16 files changed +66 -25
cli/v8
+1 -1
@@ -1 +1 @@
1 -Subproject commit 8a49e3ab6499c6196c5d7a0f6dad3b345944b992
1 +Subproject commit ee3308a7a08799ec7e86237165ebaf278d9a4f9f
content/cli/v8/commands/npm-bin.md
+2
@@ -44,6 +44,8 @@ Print the folder where npm will install executables.
44
45 * Default: false
46 * Type: Boolean
47 +* DEPRECATED: `--global`, `--local` are deprecated. Use `--location=global`
48 + instead.
49
50 Operates in "global" mode, so that packages are installed into the `prefix`
51 folder instead of the current working directory. See
content/cli/v8/commands/npm-ci.md
+2 -7
@@ -1,7 +1,7 @@
1 ---
2 title: npm-ci
3 section: 1
4 -description: Install a project with a clean slate
4 +description: Clean install a project
5 redirect_from:
6 - /cli/ci
7 - /cli/ci.html
@@ -38,12 +38,7 @@ it's meant to be used in automated environments such as test platforms,
38 continuous integration, and deployment -- or any situation where you want
39 to make sure you're doing a clean install of your dependencies.
40
41 -`npm ci` will be significantly faster when:
42 -
43 -- There is a `package-lock.json` or `npm-shrinkwrap.json` file.
44 -- The `node_modules` folder is missing or empty.
45 -
46 -In short, the main differences between using `npm install` and `npm ci` are:
41 +The main differences between using `npm install` and `npm ci` are:
42
43 * The project **must** have an existing `package-lock.json` or
44 `npm-shrinkwrap.json`.
content/cli/v8/commands/npm-config.md
+11
@@ -134,6 +134,8 @@ Not supported by all npm commands.
134
135 * Default: false
136 * Type: Boolean
137 +* DEPRECATED: `--global`, `--local` are deprecated. Use `--location=global`
138 + instead.
139
140 Operates in "global" mode, so that packages are installed into the `prefix`
141 folder instead of the current working directory. See
@@ -166,6 +168,15 @@ The command to run for `npm edit` and `npm config edit`.
168
169 When passed to `npm config` this refers to which config file to use.
170
171 +When set to "global" mode, packages are installed into the `prefix` folder
172 +instead of the current working directory. See
173 +[folders](/cli/v8/configuring-npm/folders) for more on the differences in behavior.
174 +
175 +* packages are installed into the `{prefix}/lib/node_modules` folder, instead
176 + of the current working directory.
177 +* bin files are linked to `{prefix}/bin`
178 +* man pages are linked to `{prefix}/share/man`
179 +
180 <!-- automatically generated, do not edit manually -->
181 <!-- see lib/utils/config/definitions.js -->
182
content/cli/v8/commands/npm-diff.md
+2
@@ -258,6 +258,8 @@ Treat all files as text in `npm diff`.
258
259 * Default: false
260 * Type: Boolean
261 +* DEPRECATED: `--global`, `--local` are deprecated. Use `--location=global`
262 + instead.
263
264 Operates in "global" mode, so that packages are installed into the `prefix`
265 folder instead of the current working directory. See
content/cli/v8/commands/npm-install-test.md
+2
@@ -80,6 +80,8 @@ rather than using npm's default semver range operator.
80
81 * Default: false
82 * Type: Boolean
83 +* DEPRECATED: `--global`, `--local` are deprecated. Use `--location=global`
84 + instead.
85
86 Operates in "global" mode, so that packages are installed into the `prefix`
87 folder instead of the current working directory. See
content/cli/v8/commands/npm-install.md
+2
@@ -471,6 +471,8 @@ rather than using npm's default semver range operator.
471
472 * Default: false
473 * Type: Boolean
474 +* DEPRECATED: `--global`, `--local` are deprecated. Use `--location=global`
475 + instead.
476
477 Operates in "global" mode, so that packages are installed into the `prefix`
478 folder instead of the current working directory. See
content/cli/v8/commands/npm-link.md
+2
@@ -163,6 +163,8 @@ rather than using npm's default semver range operator.
163
164 * Default: false
165 * Type: Boolean
166 +* DEPRECATED: `--global`, `--local` are deprecated. Use `--location=global`
167 + instead.
168
169 Operates in "global" mode, so that packages are installed into the `prefix`
170 folder instead of the current working directory. See
content/cli/v8/commands/npm-ls.md
+2
@@ -147,6 +147,8 @@ Output parseable results from commands that write to standard output. For
147
148 * Default: false
149 * Type: Boolean
150 +* DEPRECATED: `--global`, `--local` are deprecated. Use `--location=global`
151 + instead.
152
153 Operates in "global" mode, so that packages are installed into the `prefix`
154 folder instead of the current working directory. See
content/cli/v8/commands/npm-outdated.md
+2
@@ -160,6 +160,8 @@ Output parseable results from commands that write to standard output. For
160
161 * Default: false
162 * Type: Boolean
163 +* DEPRECATED: `--global`, `--local` are deprecated. Use `--location=global`
164 + instead.
165
166 Operates in "global" mode, so that packages are installed into the `prefix`
167 folder instead of the current working directory. See
content/cli/v8/commands/npm-prefix.md
+2
@@ -61,6 +61,8 @@ npm prefix -g
61
62 * Default: false
63 * Type: Boolean
64 +* DEPRECATED: `--global`, `--local` are deprecated. Use `--location=global`
65 + instead.
66
67 Operates in "global" mode, so that packages are installed into the `prefix`
68 folder instead of the current working directory. See
content/cli/v8/commands/npm-rebuild.md
+2
@@ -52,6 +52,8 @@ will be rebuilt.
52
53 * Default: false
54 * Type: Boolean
55 +* DEPRECATED: `--global`, `--local` are deprecated. Use `--location=global`
56 + instead.
57
58 Operates in "global" mode, so that packages are installed into the `prefix`
59 folder instead of the current working directory. See
content/cli/v8/commands/npm-root.md
+2
@@ -51,6 +51,8 @@ echo "Global packages installed in: ${global_node_modules}"
51
52 * Default: false
53 * Type: Boolean
54 +* DEPRECATED: `--global`, `--local` are deprecated. Use `--location=global`
55 + instead.
56
57 Operates in "global" mode, so that packages are installed into the `prefix`
58 folder instead of the current working directory. See
content/cli/v8/commands/npm-set-script.md
+2
@@ -17,6 +17,8 @@ github_path: docs/content/commands/npm-set-script.md
17 ### Synopsis
18 An npm command that lets you create a task in the `scripts` section of the `package.json`.
19
20 +Deprecated.
21 +
22 <!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
23 <!-- automatically generated, do not edit manually -->
24 <!-- see lib/commands/set-script.js -->
content/cli/v8/commands/npm-update.md
+2
@@ -198,6 +198,8 @@ Will also prevent writing to `package-lock.json` if set to `false`.
198
199 * Default: false
200 * Type: Boolean
201 +* DEPRECATED: `--global`, `--local` are deprecated. Use `--location=global`
202 + instead.
203
204 Operates in "global" mode, so that packages are installed into the `prefix`
205 folder instead of the current working directory. See
content/cli/v8/using-npm/config.md
+28 -17
@@ -695,23 +695,6 @@ results in no commit being made at all.
695 <!-- automatically generated, do not edit manually -->
696 <!-- see lib/utils/config/definitions.js -->
697
698 -#### `global`
699 -
700 -* Default: false
701 -* Type: Boolean
702 -
703 -Operates in "global" mode, so that packages are installed into the `prefix`
704 -folder instead of the current working directory. See
705 -[folders](/cli/v8/configuring-npm/folders) for more on the differences in behavior.
706 -
707 -* packages are installed into the `{prefix}/lib/node_modules` folder, instead
708 - of the current working directory.
709 -* bin files are linked to `{prefix}/bin`
710 -* man pages are linked to `{prefix}/share/man`
711 -
712 -<!-- automatically generated, do not edit manually -->
713 -<!-- see lib/utils/config/definitions.js -->
714 -
698 #### `global-style`
699
700 * Default: false
@@ -1009,6 +992,15 @@ npm registry. Must be IPv4 in versions of Node prior to 0.12.
992
993 When passed to `npm config` this refers to which config file to use.
994
995 +When set to "global" mode, packages are installed into the `prefix` folder
996 +instead of the current working directory. See
997 +[folders](/cli/v8/configuring-npm/folders) for more on the differences in behavior.
998 +
999 +* packages are installed into the `{prefix}/lib/node_modules` folder, instead
1000 + of the current working directory.
1001 +* bin files are linked to `{prefix}/bin`
1002 +* man pages are linked to `{prefix}/share/man`
1003 +
1004 <!-- automatically generated, do not edit manually -->
1005 <!-- see lib/utils/config/definitions.js -->
1006
@@ -1949,6 +1941,25 @@ Alias for `--include=dev`.
1941 <!-- automatically generated, do not edit manually -->
1942 <!-- see lib/utils/config/definitions.js -->
1943
1944 +#### `global`
1945 +
1946 +* Default: false
1947 +* Type: Boolean
1948 +* DEPRECATED: `--global`, `--local` are deprecated. Use `--location=global`
1949 + instead.
1950 +
1951 +Operates in "global" mode, so that packages are installed into the `prefix`
1952 +folder instead of the current working directory. See
1953 +[folders](/cli/v8/configuring-npm/folders) for more on the differences in behavior.
1954 +
1955 +* packages are installed into the `{prefix}/lib/node_modules` folder, instead
1956 + of the current working directory.
1957 +* bin files are linked to `{prefix}/bin`
1958 +* man pages are linked to `{prefix}/share/man`
1959 +
1960 +<!-- automatically generated, do not edit manually -->
1961 +<!-- see lib/utils/config/definitions.js -->
1962 +
1963 #### `init.author.email`
1964
1965 * Default: ""