@cryptotaxi247 / documentation-1 / commits / 29a5c51

CLI documentation update from CI

npm CLI robot committed Nov 4, 2022 at 02:58 UTC 29a5c51d87e7560a82b6f4b2526d7ffe50b82234

90 files changed +115 -2536

cli/releases.json

+1 -1

@@ -16,7 +16,7 @@

16 "id": "v8",

17 "branch": "release/v8",

18 "spec": "latest",

19 - "resolved": "https://registry.npmjs.org/npm/-/npm-8.19.2.tgz"

19 + "resolved": "https://registry.npmjs.org/npm/-/npm-8.19.3.tgz"

20 },

21 {

22 "id": "v9",

content/cli/v8/commands/index.mdx

+1 -1

@@ -3,7 +3,7 @@ title: CLI Commands

3 shortName: Commands

4 github_repo: npm/cli

5 github_branch: release/v8

6 -github_path: docs/nav.yml

6 +github_path: docs/lib/content/nav.yml

7 redirect_from:

8 - /cli-commands

9 - /cli-commands/index

content/cli/v8/commands/npm-access.md

+1 -21

@@ -4,7 +4,7 @@ section: 1

4 description: Set access level on published packages

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-access.md

7 +github_path: docs/lib/content/commands/npm-access.md

8 redirect_from:

9 - /cli-commands/access

10 - /cli-commands/npm-access

@@ -37,10 +37,6 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm access public [<package>]

42 npm access restricted [<package>]

@@ -53,11 +49,6 @@ npm access ls-collaborators [<package> [<user>]]

49 npm access edit [<package>]

50 ```

56 -

57 -

58 -

59 -

60 -

52 ### Description

54 Used to set access controls on private packages.

@@ -119,9 +110,6 @@ Management of teams and team memberships is done with the `npm team` command.

110

111 ### Configuration

112

122 -

123 -

124 -

113 #### `registry`

114

115 * Default: "https://registry.npmjs.org/"

@@ -129,9 +117,6 @@ Management of teams and team memberships is done with the `npm team` command.

117

118 The base URL of the npm registry.

119

132 -

133 -

134 -

120 #### `otp`

121

122 * Default: null

@@ -143,11 +128,6 @@ when publishing or changing package permissions with `npm access`.

128 If not set, and a registry response fails with a challenge for a one-time

129 password, npm will prompt on the command line for one.

130

146 -

147 -

148 -

149 -

150 -

131 ### See Also

132

133 * [`libnpmaccess`](https://npm.im/libnpmaccess)

content/cli/v8/commands/npm-adduser.md

+1 -24

@@ -4,7 +4,7 @@ section: 1

4 description: Add a registry user account

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-adduser.md

7 +github_path: docs/lib/content/commands/npm-adduser.md

8 redirect_from:

9 - /cli-commands/adduser

10 - /cli-commands/npm-adduser

@@ -37,21 +37,12 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm adduser

43 aliases: login, add-user

44 ```

50 -

51 -

52 -

53 -

54 -

46 Note: This command is unaware of workspaces.

48 ### Description

@@ -75,9 +66,6 @@ your existing record.

67 ### Configuration

78 -

79 -

80 -

69 #### `registry`

71 * Default: "https://registry.npmjs.org/"

@@ -85,9 +73,6 @@ your existing record.

74 The base URL of the npm registry.

88 -

89 -

90 -

76 #### `scope`

78 * Default: the scope of the current project, if any, or ""

@@ -118,9 +103,6 @@ npm init --scope=@foo --yes

103 ```

104

105

121 -

122 -

123 -

106 #### `auth-type`

107

108 * Default: "legacy"

@@ -131,11 +113,6 @@ removed in a future version.

113

114 What authentication strategy to use with `login`.

115

134 -

135 -

136 -

137 -

138 -

116 ### See Also

117

118 * [npm registry](/cli/v8/using-npm/registry)

content/cli/v8/commands/npm-audit.md

+1 -51

@@ -4,7 +4,7 @@ section: 1

4 description: Run a security audit

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-audit.md

7 +github_path: docs/lib/content/commands/npm-audit.md

8 redirect_from:

9 - /cli-commands/audit

10 - /cli-commands/npm-audit

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm audit [fix|signatures]

42 ```

48 -

49 -

50 -

51 -

52 -

44 ### Description

46 The audit command submits a description of the dependencies configured in

@@ -278,9 +269,6 @@ $ npm audit --audit-level=moderate

269

270 ### Configuration

271

281 -

282 -

283 -

272 #### `audit-level`

273

274 * Default: null

@@ -289,9 +277,6 @@ $ npm audit --audit-level=moderate

277 The minimum level of vulnerability for `npm audit` to exit with a non-zero

278 exit code.

279

292 -

293 -

294 -

280 #### `dry-run`

281

282 * Default: false

@@ -305,9 +290,6 @@ commands that modify your local installation, eg, `install`, `update`,

290 Note: This is NOT honored by other network related commands, eg `dist-tags`,

291 `owner`, etc.

292

308 -

309 -

310 -

293 #### `force`

294

295 * Default: false

@@ -334,9 +316,6 @@ mistakes, unnecessary performance degradation, and malicious input.

316 If you don't have a clear idea of what you want to do, it is strongly

317 recommended that you do not use this option!

318

337 -

338 -

339 -

319 #### `json`

320

321 * Default: false

@@ -349,9 +328,6 @@ Whether or not to output JSON data, rather than the normal output.

328

329 Not supported by all npm commands.

330

352 -

353 -

354 -

331 #### `package-lock-only`

332

333 * Default: false

@@ -366,9 +342,6 @@ instead of checking `node_modules` and downloading dependencies.

342 For `list` this means the output will be based on the tree described by the

343 `package-lock.json`, rather than the contents of `node_modules`.

344

369 -

370 -

371 -

345 #### `omit`

346

347 * Default: 'dev' if the `NODE_ENV` environment variable is set to

@@ -387,9 +360,6 @@ it will be included.

360 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment

361 variable will be set to `'production'` for all lifecycle scripts.

362

390 -

391 -

392 -

363 #### `foreground-scripts`

364

365 * Default: false

@@ -402,9 +372,6 @@ input, output, and error with the main npm process.

372 Note that this will generally make installs run slower, and be much noisier,

373 but can be useful for debugging.

374

405 -

406 -

407 -

375 #### `ignore-scripts`

376

377 * Default: false

@@ -417,9 +384,6 @@ Note that commands explicitly intended to run a particular script, such as

384 will still run their intended script if `ignore-scripts` is set, but they

385 will *not* run any pre- or post-scripts.

386

420 -

421 -

422 -

387 #### `workspace`

388

389 * Default:

@@ -442,9 +406,6 @@ brand new workspace within the project.

406

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

408

445 -

446 -

447 -

409 #### `workspaces`

410

411 * Default: null

@@ -463,9 +424,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

424

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

426

466 -

467 -

468 -

427 #### `include-workspace-root`

428

429 * Default: false

@@ -479,9 +437,6 @@ the specified workspaces, and not on the root project.

437

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

439

482 -

483 -

484 -

440 #### `install-links`

441

442 * Default: false

@@ -491,11 +446,6 @@ When set file: protocol dependencies that exist outside of the project root

446 will be packed and installed as regular dependencies instead of creating a

447 symlink. This option has no effect on workspaces.

448

494 -

495 -

496 -

497 -

498 -

449 ### See Also

450

451 * [npm install](/cli/v8/commands/npm-install)

content/cli/v8/commands/npm-bin.md

+1 -18

@@ -4,7 +4,7 @@ section: 1

4 description: Display npm bin folder

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-bin.md

7 +github_path: docs/lib/content/commands/npm-bin.md

8 redirect_from:

9 - /cli-commands/bin

10 - /cli-commands/npm-bin

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm bin

42 ```

48 -

49 -

50 -

51 -

52 -

44 Note: This command is unaware of workspaces.

46 ### Description

@@ -58,9 +49,6 @@ Print the folder where npm will install executables.

50 ### Configuration

61 -

62 -

63 -

52 #### `global`

54 * Default: false

@@ -75,11 +63,6 @@ folder instead of the current working directory. See

63 * bin files are linked to `{prefix}/bin`

64 * man pages are linked to `{prefix}/share/man`

78 -

79 -

80 -

81 -

82 -

66 ### See Also

68 * [npm prefix](/cli/v8/commands/npm-prefix)

content/cli/v8/commands/npm-bugs.md

+1 -30

@@ -4,7 +4,7 @@ section: 1

4 description: Report bugs for a package in a web browser

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-bugs.md

7 +github_path: docs/lib/content/commands/npm-bugs.md

8 redirect_from:

9 - /cli-commands/bugs

10 - /cli-commands/npm-bugs

@@ -37,21 +37,12 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm bugs [<pkgname> [<pkgname> ...]]

43 alias: issues

44 ```

50 -

51 -

52 -

53 -

54 -

46 ### Description

48 This command tries to guess at the likely location of a package's bug

@@ -61,9 +52,6 @@ will search for a `package.json` in the current folder and use the `name` proper

53 ### Configuration

64 -

65 -

66 -

55 #### `browser`

57 * Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`

@@ -76,9 +64,6 @@ terminal.

65 Set to `true` to use default system URL opener.

79 -

80 -

81 -

67 #### `registry`

69 * Default: "https://registry.npmjs.org/"

@@ -86,9 +71,6 @@ Set to `true` to use default system URL opener.

72 The base URL of the npm registry.

89 -

90 -

91 -

74 #### `workspace`

76 * Default:

@@ -111,9 +93,6 @@ brand new workspace within the project.

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

114 -

115 -

116 -

96 #### `workspaces`

98 * Default: null

@@ -132,9 +111,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

111

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

113

135 -

136 -

137 -

114 #### `include-workspace-root`

115

116 * Default: false

@@ -148,11 +124,6 @@ the specified workspaces, and not on the root project.

124

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

126

151 -

152 -

153 -

154 -

155 -

127 ### See Also

128

129 * [npm docs](/cli/v8/commands/npm-docs)

content/cli/v8/commands/npm-cache.md

+1 -18

@@ -4,7 +4,7 @@ section: 1

4 description: Manipulates packages cache

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-cache.md

7 +github_path: docs/lib/content/commands/npm-cache.md

8 redirect_from:

9 - /cli-commands/cache

10 - /cli-commands/npm-cache

@@ -37,10 +37,6 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm cache add <package-spec>

42 npm cache clean [<key>]

@@ -48,11 +44,6 @@ npm cache ls [<name>@<version>]

44 npm cache verify

45 ```

51 -

52 -

53 -

54 -

55 -

47 Note: This command is unaware of workspaces.

49 ### Description

@@ -110,9 +101,6 @@ verify`.

101

102 ### Configuration

103

113 -

114 -

115 -

104 #### `cache`

105

106 * Default: Windows: `%LocalAppData%\npm-cache`, Posix: `~/.npm`

@@ -121,11 +109,6 @@ verify`.

109 The location of npm's cache directory. See [`npm

110 cache`](/cli/v8/commands/npm-cache)

111

124 -

125 -

126 -

127 -

128 -

112 ### See Also

113

114 * [package spec](/cli/v8/using-npm/package-spec)

content/cli/v8/commands/npm-ci.md

+1 -69

@@ -4,7 +4,7 @@ section: 1

4 description: Clean install a project

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-ci.md

7 +github_path: docs/lib/content/commands/npm-ci.md

8 redirect_from:

9 - /cli-commands/ci

10 - /cli-commands/npm-ci

@@ -37,21 +37,12 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm ci

43 aliases: clean-install, ic, install-clean, isntall-clean

44 ```

50 -

51 -

52 -

53 -

54 -

46 ### Description

48 This command is similar to [`npm install`](/cli/v8/commands/npm-install), except

@@ -112,9 +103,6 @@ cache:

103

104 ### Configuration

105

115 -

116 -

117 -

106 #### `save`

107

108 * Default: `true` unless when using `npm update` where it defaults to `false`

@@ -127,9 +115,6 @@ When used with the `npm rm` command, removes the dependency from

115

116 Will also prevent writing to `package-lock.json` if set to `false`.

117

130 -

131 -

132 -

118 #### `save-exact`

119

120 * Default: false

@@ -138,9 +123,6 @@ Will also prevent writing to `package-lock.json` if set to `false`.

123 Dependencies saved to package.json will be configured with an exact version

124 rather than using npm's default semver range operator.

125

141 -

142 -

143 -

126 #### `global`

127

128 * Default: false

@@ -155,9 +137,6 @@ folder instead of the current working directory. See

137 * bin files are linked to `{prefix}/bin`

138 * man pages are linked to `{prefix}/share/man`

139

158 -

159 -

160 -

140 #### `global-style`

141

142 * Default: false

@@ -170,9 +149,6 @@ on will be flattened in their `node_modules` folders. This obviously will

149 eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`

150 will be preferred.

151

173 -

174 -

175 -

152 #### `legacy-bundling`

153

154 * Default: false

@@ -183,9 +159,6 @@ such as the one included with node 0.8, can install the package. This

159 eliminates all automatic deduping. If used with `global-style` this option

160 will be preferred.

161

186 -

187 -

188 -

162 #### `omit`

163

164 * Default: 'dev' if the `NODE_ENV` environment variable is set to

@@ -204,9 +177,6 @@ it will be included.

177 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment

178 variable will be set to `'production'` for all lifecycle scripts.

179

207 -

208 -

209 -

180 #### `strict-peer-deps`

181

182 * Default: false

@@ -226,9 +196,6 @@ When such and override is performed, a warning is printed, explaining the

196 conflict and the packages involved. If `--strict-peer-deps` is set, then

197 this warning is treated as a failure.

198

229 -

230 -

231 -

199 #### `package-lock`

200

201 * Default: true

@@ -239,9 +206,6 @@ will also prevent _writing_ `package-lock.json` if `save` is true.

206

207 This configuration does not affect `npm ci`.

208

242 -

243 -

244 -

209 #### `foreground-scripts`

210

211 * Default: false

@@ -254,9 +218,6 @@ input, output, and error with the main npm process.

218 Note that this will generally make installs run slower, and be much noisier,

219 but can be useful for debugging.

220

257 -

258 -

259 -

221 #### `ignore-scripts`

222

223 * Default: false

@@ -269,9 +230,6 @@ Note that commands explicitly intended to run a particular script, such as

230 will still run their intended script if `ignore-scripts` is set, but they

231 will *not* run any pre- or post-scripts.

232

272 -

273 -

274 -

233 #### `audit`

234

235 * Default: true

@@ -282,9 +240,6 @@ default registry and all registries configured for scopes. See the

240 documentation for [`npm audit`](/cli/v8/commands/npm-audit) for details on what is

241 submitted.

242

285 -

286 -

287 -

243 #### `bin-links`

244

245 * Default: true

@@ -297,9 +252,6 @@ Set to false to have it not do this. This can be used to work around the

252 fact that some file systems don't support symlinks, even on ostensibly Unix

253 systems.

254

300 -

301 -

302 -

255 #### `fund`

256

257 * Default: true

@@ -309,9 +261,6 @@ When "true" displays the message at the end of each `npm install`

261 acknowledging the number of dependencies looking for funding. See [`npm

262 fund`](/cli/v8/commands/npm-fund) for details.

263

312 -

313 -

314 -

264 #### `dry-run`

265

266 * Default: false

@@ -325,9 +274,6 @@ commands that modify your local installation, eg, `install`, `update`,

274 Note: This is NOT honored by other network related commands, eg `dist-tags`,

275 `owner`, etc.

276

328 -

329 -

330 -

277 #### `workspace`

278

279 * Default:

@@ -350,9 +296,6 @@ brand new workspace within the project.

296

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

298

353 -

354 -

355 -

299 #### `workspaces`

300

301 * Default: null

@@ -371,9 +314,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

314

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

316

374 -

375 -

376 -

317 #### `include-workspace-root`

318

319 * Default: false

@@ -387,9 +327,6 @@ the specified workspaces, and not on the root project.

327

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

329

390 -

391 -

392 -

330 #### `install-links`

331

332 * Default: false

@@ -399,11 +336,6 @@ When set file: protocol dependencies that exist outside of the project root

336 will be packed and installed as regular dependencies instead of creating a

337 symlink. This option has no effect on workspaces.

338

402 -

403 -

404 -

405 -

406 -

339 ### See Also

340

341 * [npm install](/cli/v8/commands/npm-install)

content/cli/v8/commands/npm-completion.md

+1 -10

@@ -4,7 +4,7 @@ section: 1

4 description: Tab Completion for npm

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-completion.md

7 +github_path: docs/lib/content/commands/npm-completion.md

8 redirect_from:

9 - /cli-commands/completion

10 - /cli-commands/npm-completion

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm completion

42 ```

48 -

49 -

50 -

51 -

52 -

44 Note: This command is unaware of workspaces.

46 ### Description

content/cli/v8/commands/npm-config.md

+1 -30

@@ -4,7 +4,7 @@ section: 1

4 description: Manage the npm configuration files

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-config.md

7 +github_path: docs/lib/content/commands/npm-config.md

8 redirect_from:

9 - /cli-commands/config

10 - /cli-commands/npm-config

@@ -37,10 +37,6 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm config set <key>=<value> [<key>=<value> ...]

42 npm config get [<key> [<key> ...]]

@@ -51,11 +47,6 @@ npm config edit

47 alias: c

48 ```

54 -

55 -

56 -

57 -

58 -

50 Note: This command is unaware of workspaces.

52 ### Description

@@ -133,9 +124,6 @@ global config.

124

125 ### Configuration

126

136 -

137 -

138 -

127 #### `json`

128

129 * Default: false

@@ -148,9 +136,6 @@ Whether or not to output JSON data, rather than the normal output.

136

137 Not supported by all npm commands.

138

151 -

152 -

153 -

139 #### `global`

140

141 * Default: false

@@ -165,9 +150,6 @@ folder instead of the current working directory. See

150 * bin files are linked to `{prefix}/bin`

151 * man pages are linked to `{prefix}/share/man`

152

168 -

169 -

170 -

153 #### `editor`

154

155 * Default: The EDITOR or VISUAL environment variables, or 'notepad.exe' on

@@ -176,9 +158,6 @@ folder instead of the current working directory. See

158

159 The command to run for `npm edit` and `npm config edit`.

160

179 -

180 -

181 -

161 #### `location`

162

163 * Default: "user" unless `--global` is passed, which will also set this value

@@ -196,9 +175,6 @@ instead of the current working directory. See

175 * bin files are linked to `{prefix}/bin`

176 * man pages are linked to `{prefix}/share/man`

177

199 -

200 -

201 -

178 #### `long`

179

180 * Default: false

@@ -206,11 +182,6 @@ instead of the current working directory. See

182

183 Show extended information in `ls`, `search`, and `help-search`.

184

209 -

210 -

211 -

212 -

213 -

185 ### See Also

186

187 * [npm folders](/cli/v8/configuring-npm/folders)

content/cli/v8/commands/npm-dedupe.md

+1 -57

@@ -4,7 +4,7 @@ section: 1

4 description: Reduce duplication in the package tree

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-dedupe.md

7 +github_path: docs/lib/content/commands/npm-dedupe.md

8 redirect_from:

9 - /cli-commands/dedupe

10 - /cli-commands/npm-dedupe

@@ -37,21 +37,12 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm dedupe

43 alias: ddp

44 ```

50 -

51 -

52 -

53 -

54 -

46 ### Description

48 Searches the local package tree and attempts to simplify the overall

@@ -117,9 +108,6 @@ values in `package.json` you can run: `npm update --save` instead.

108

109 ### Configuration

110

120 -

121 -

122 -

111 #### `global-style`

112

113 * Default: false

@@ -132,9 +120,6 @@ on will be flattened in their `node_modules` folders. This obviously will

120 eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`

121 will be preferred.

122

135 -

136 -

137 -

123 #### `legacy-bundling`

124

125 * Default: false

@@ -145,9 +130,6 @@ such as the one included with node 0.8, can install the package. This

130 eliminates all automatic deduping. If used with `global-style` this option

131 will be preferred.

132

148 -

149 -

150 -

133 #### `strict-peer-deps`

134

135 * Default: false

@@ -167,9 +149,6 @@ When such and override is performed, a warning is printed, explaining the

149 conflict and the packages involved. If `--strict-peer-deps` is set, then

150 this warning is treated as a failure.

151

170 -

171 -

172 -

152 #### `package-lock`

153

154 * Default: true

@@ -180,9 +159,6 @@ will also prevent _writing_ `package-lock.json` if `save` is true.

159

160 This configuration does not affect `npm ci`.

161

183 -

184 -

185 -

162 #### `omit`

163

164 * Default: 'dev' if the `NODE_ENV` environment variable is set to

@@ -201,9 +177,6 @@ it will be included.

177 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment

178 variable will be set to `'production'` for all lifecycle scripts.

179

204 -

205 -

206 -

180 #### `ignore-scripts`

181

182 * Default: false

@@ -216,9 +189,6 @@ Note that commands explicitly intended to run a particular script, such as

189 will still run their intended script if `ignore-scripts` is set, but they

190 will *not* run any pre- or post-scripts.

191

219 -

220 -

221 -

192 #### `audit`

193

194 * Default: true

@@ -229,9 +199,6 @@ default registry and all registries configured for scopes. See the

199 documentation for [`npm audit`](/cli/v8/commands/npm-audit) for details on what is

200 submitted.

201

232 -

233 -

234 -

202 #### `bin-links`

203

204 * Default: true

@@ -244,9 +211,6 @@ Set to false to have it not do this. This can be used to work around the

211 fact that some file systems don't support symlinks, even on ostensibly Unix

212 systems.

213

247 -

248 -

249 -

214 #### `fund`

215

216 * Default: true

@@ -256,9 +220,6 @@ When "true" displays the message at the end of each `npm install`

220 acknowledging the number of dependencies looking for funding. See [`npm

221 fund`](/cli/v8/commands/npm-fund) for details.

222

259 -

260 -

261 -

223 #### `dry-run`

224

225 * Default: false

@@ -272,9 +233,6 @@ commands that modify your local installation, eg, `install`, `update`,

233 Note: This is NOT honored by other network related commands, eg `dist-tags`,

234 `owner`, etc.

235

275 -

276 -

277 -

236 #### `workspace`

237

238 * Default:

@@ -297,9 +255,6 @@ brand new workspace within the project.

255

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

257

300 -

301 -

302 -

258 #### `workspaces`

259

260 * Default: null

@@ -318,9 +273,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

273

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

275

321 -

322 -

323 -

276 #### `include-workspace-root`

277

278 * Default: false

@@ -334,9 +286,6 @@ the specified workspaces, and not on the root project.

286

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

288

337 -

338 -

339 -

289 #### `install-links`

290

291 * Default: false

@@ -346,11 +295,6 @@ When set file: protocol dependencies that exist outside of the project root

295 will be packed and installed as regular dependencies instead of creating a

296 symlink. This option has no effect on workspaces.

297

349 -

350 -

351 -

352 -

353 -

298 ### See Also

299

300 * [npm find-dupes](/cli/v8/commands/npm-find-dupes)

content/cli/v8/commands/npm-deprecate.md

+1 -21

@@ -4,7 +4,7 @@ section: 1

4 description: Deprecate a version of a package

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-deprecate.md

7 +github_path: docs/lib/content/commands/npm-deprecate.md

8 redirect_from:

9 - /cli-commands/deprecate

10 - /cli-commands/npm-deprecate

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm deprecate <package-spec> <message>

42 ```

48 -

49 -

50 -

51 -

52 -

44 Note: This command is unaware of workspaces.

46 ### Description

@@ -82,9 +73,6 @@ format an empty string.

74 ### Configuration

85 -

86 -

87 -

76 #### `registry`

78 * Default: "https://registry.npmjs.org/"

@@ -92,9 +80,6 @@ format an empty string.

81 The base URL of the npm registry.

95 -

96 -

97 -

83 #### `otp`

85 * Default: null

@@ -106,11 +91,6 @@ when publishing or changing package permissions with `npm access`.

91 If not set, and a registry response fails with a challenge for a one-time

92 password, npm will prompt on the command line for one.

109 -

110 -

111 -

112 -

113 -

94 ### See Also

96 * [package spec](/cli/v8/using-npm/package-spec)

content/cli/v8/commands/npm-diff.md

+1 -54

@@ -4,7 +4,7 @@ section: 1

4 description: The registry diff command

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-diff.md

7 +github_path: docs/lib/content/commands/npm-diff.md

8 redirect_from:

9 - /cli-commands/diff

10 - /cli-commands/npm-diff

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm diff [...<paths>]

42 ```

48 -

49 -

50 -

51 -

52 -

44 ### Description

46 Similar to its `git diff` counterpart, this command will print diff patches

@@ -189,9 +180,6 @@ located within the folder `./lib/` and changed lines of code within the

180

181 ### Configuration

182

192 -

193 -

194 -

183 #### `diff`

184

185 * Default:

@@ -199,9 +187,6 @@ located within the folder `./lib/` and changed lines of code within the

187

188 Define arguments to compare in `npm diff`.

189

202 -

203 -

204 -

190 #### `diff-name-only`

191

192 * Default: false

@@ -209,9 +194,6 @@ Define arguments to compare in `npm diff`.

194

195 Prints only filenames when using `npm diff`.

196

212 -

213 -

214 -

197 #### `diff-unified`

198

199 * Default: 3

@@ -219,9 +201,6 @@ Prints only filenames when using `npm diff`.

201

202 The number of lines of context to print in `npm diff`.

203

222 -

223 -

224 -

204 #### `diff-ignore-all-space`

205

206 * Default: false

@@ -229,9 +208,6 @@ The number of lines of context to print in `npm diff`.

208

209 Ignore whitespace when comparing lines in `npm diff`.

210

232 -

233 -

234 -

211 #### `diff-no-prefix`

212

213 * Default: false

@@ -242,9 +218,6 @@ Do not show any source or destination prefix in `npm diff` output.

218 Note: this causes `npm diff` to ignore the `--diff-src-prefix` and

219 `--diff-dst-prefix` configs.

220

245 -

246 -

247 -

221 #### `diff-src-prefix`

222

223 * Default: "a/"

@@ -252,9 +225,6 @@ Note: this causes `npm diff` to ignore the `--diff-src-prefix` and

225

226 Source prefix to be used in `npm diff` output.

227

255 -

256 -

257 -

228 #### `diff-dst-prefix`

229

230 * Default: "b/"

@@ -262,9 +232,6 @@ Source prefix to be used in `npm diff` output.

232

233 Destination prefix to be used in `npm diff` output.

234

265 -

266 -

267 -

235 #### `diff-text`

236

237 * Default: false

@@ -272,9 +239,6 @@ Destination prefix to be used in `npm diff` output.

239

240 Treat all files as text in `npm diff`.

241

275 -

276 -

277 -

242 #### `global`

243

244 * Default: false

@@ -289,9 +253,6 @@ folder instead of the current working directory. See

253 * bin files are linked to `{prefix}/bin`

254 * man pages are linked to `{prefix}/share/man`

255

292 -

293 -

294 -

256 #### `tag`

257

258 * Default: "latest"

@@ -306,9 +267,6 @@ command, if no explicit tag is given.

267 When used by the `npm diff` command, this is the tag used to fetch the

268 tarball that will be compared with the local files by default.

269

309 -

310 -

311 -

270 #### `workspace`

271

272 * Default:

@@ -331,9 +289,6 @@ brand new workspace within the project.

289

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

291

334 -

335 -

336 -

292 #### `workspaces`

293

294 * Default: null

@@ -352,9 +307,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

307

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

309

355 -

356 -

357 -

310 #### `include-workspace-root`

311

312 * Default: false

@@ -367,11 +319,6 @@ all workspaces via the `workspaces` flag, will cause npm to operate only on

319 the specified workspaces, and not on the root project.

320

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

370 -

371 -

372 -

373 -

374 -

322 ## See Also

323

324 * [npm outdated](/cli/v8/commands/npm-outdated)

content/cli/v8/commands/npm-dist-tag.md

+1 -24

@@ -4,7 +4,7 @@ section: 1

4 description: Modify package distribution tags

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-dist-tag.md

7 +github_path: docs/lib/content/commands/npm-dist-tag.md

8 redirect_from:

9 - /cli-commands/dist-tag

10 - /cli-commands/npm-dist-tag

@@ -37,10 +37,6 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm dist-tag add <package-spec (with version)> [<tag>]

42 npm dist-tag rm <package-spec> <tag>

@@ -49,11 +45,6 @@ npm dist-tag ls [<package-spec>]

45 alias: dist-tags

46 ```

52 -

53 -

54 -

55 -

56 -

48 ### Description

50 Add, remove, and enumerate distribution tags on a package:

@@ -130,9 +121,6 @@ not begin with a number or the letter `v`.

121

122 ### Configuration

123

133 -

134 -

135 -

124 #### `workspace`

125

126 * Default:

@@ -155,9 +143,6 @@ brand new workspace within the project.

143

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

145

158 -

159 -

160 -

146 #### `workspaces`

147

148 * Default: null

@@ -176,9 +161,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

161

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

163

179 -

180 -

181 -

164 #### `include-workspace-root`

165

166 * Default: false

@@ -192,11 +174,6 @@ the specified workspaces, and not on the root project.

174

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

176

195 -

196 -

197 -

198 -

199 -

177 ### See Also

178

179 * [package spec](/cli/v8/using-npm/package-spec)

content/cli/v8/commands/npm-docs.md

+1 -30

@@ -4,7 +4,7 @@ section: 1

4 description: Open documentation for a package in a web browser

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-docs.md

7 +github_path: docs/lib/content/commands/npm-docs.md

8 redirect_from:

9 - /cli-commands/docs

10 - /cli-commands/npm-docs

@@ -37,21 +37,12 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm docs [<pkgname> [<pkgname> ...]]

43 alias: home

44 ```

50 -

51 -

52 -

53 -

54 -

46 ### Description

48 This command tries to guess at the likely location of a package's

@@ -62,9 +53,6 @@ the `name` property.

54 ### Configuration

65 -

66 -

67 -

56 #### `browser`

58 * Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`

@@ -77,9 +65,6 @@ terminal.

66 Set to `true` to use default system URL opener.

80 -

81 -

82 -

68 #### `registry`

70 * Default: "https://registry.npmjs.org/"

@@ -87,9 +72,6 @@ Set to `true` to use default system URL opener.

73 The base URL of the npm registry.

90 -

91 -

92 -

75 #### `workspace`

77 * Default:

@@ -112,9 +94,6 @@ brand new workspace within the project.

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

115 -

116 -

117 -

97 #### `workspaces`

99 * Default: null

@@ -133,9 +112,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

112

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

114

136 -

137 -

138 -

115 #### `include-workspace-root`

116

117 * Default: false

@@ -149,11 +125,6 @@ the specified workspaces, and not on the root project.

125

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

127

152 -

153 -

154 -

155 -

156 -

128 ### See Also

129

130 * [npm view](/cli/v8/commands/npm-view)

content/cli/v8/commands/npm-doctor.md

+1 -18

@@ -4,7 +4,7 @@ section: 1

4 description: Check your npm environment

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-doctor.md

7 +github_path: docs/lib/content/commands/npm-doctor.md

8 redirect_from:

9 - /cli-commands/doctor

10 - /cli-commands/npm-doctor

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm doctor

42 ```

48 -

49 -

50 -

51 -

52 -

44 Note: This command is unaware of workspaces.

46 ### Description

@@ -144,9 +135,6 @@ reset the cache.

135

136 ### Configuration

137

147 -

148 -

149 -

138 #### `registry`

139

140 * Default: "https://registry.npmjs.org/"

@@ -154,11 +142,6 @@ reset the cache.

142

143 The base URL of the npm registry.

144

157 -

158 -

159 -

160 -

161 -

145 ### See Also

146

147 * [npm bugs](/cli/v8/commands/npm-bugs)

content/cli/v8/commands/npm-edit.md

+1 -18

@@ -4,7 +4,7 @@ section: 1

4 description: Edit an installed package

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-edit.md

7 +github_path: docs/lib/content/commands/npm-edit.md

8 redirect_from:

9 - /cli-commands/edit

10 - /cli-commands/npm-edit

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm edit <pkg>[/<subpkg>...]

42 ```

48 -

49 -

50 -

51 -

52 -

44 Note: This command is unaware of workspaces.

46 ### Description

@@ -67,9 +58,6 @@ changes to your locally installed copy.

59 ### Configuration

70 -

71 -

72 -

61 #### `editor`

63 * Default: The EDITOR or VISUAL environment variables, or 'notepad.exe' on

@@ -78,11 +66,6 @@ changes to your locally installed copy.

67 The command to run for `npm edit` and `npm config edit`.

81 -

82 -

83 -

84 -

85 -

69 ### See Also

71 * [npm folders](/cli/v8/configuring-npm/folders)

content/cli/v8/commands/npm-exec.md

+1 -30

@@ -4,7 +4,7 @@ section: 1

4 description: Run a command from a local or remote npm package

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-exec.md

7 +github_path: docs/lib/content/commands/npm-exec.md

8 redirect_from:

9 - /cli-commands/exec

10 - /cli-commands/npm-exec

@@ -37,10 +37,6 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm exec -- <pkg>[@<version>] [args...]

42 npm exec --package=<pkg>[@<version>] -- <cmd> [args...]

@@ -50,11 +46,6 @@ npm exec --package=foo -c '<cmd> [args...]'

46 alias: x

47 ```

53 -

54 -

55 -

56 -

57 -

49 ### Description

51 This command allows you to run an arbitrary command from an npm package

@@ -150,9 +141,6 @@ $ npm exec -- foo@latest bar --package=@npmcli/foo

141

142 ### Configuration

143

153 -

154 -

155 -

144 #### `package`

145

146 * Default:

@@ -160,9 +148,6 @@ $ npm exec -- foo@latest bar --package=@npmcli/foo

148

149 The package or packages to install for [`npm exec`](/cli/v8/commands/npm-exec)

150

163 -

164 -

165 -

151 #### `call`

152

153 * Default: ""

@@ -176,9 +161,6 @@ npm exec --package yo --package generator-node --call "yo node"

161 ```

162

163

179 -

180 -

181 -

164 #### `workspace`

165

166 * Default:

@@ -201,9 +183,6 @@ brand new workspace within the project.

183

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

185

204 -

205 -

206 -

186 #### `workspaces`

187

188 * Default: null

@@ -222,9 +201,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

201

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

203

225 -

226 -

227 -

204 #### `include-workspace-root`

205

206 * Default: false

@@ -238,11 +214,6 @@ the specified workspaces, and not on the root project.

214

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

216

241 -

242 -

243 -

244 -

245 -

217 ### Examples

218

219 Run the version of `tap` in the local dependencies, with the provided

content/cli/v8/commands/npm-explain.md

+1 -21

@@ -4,7 +4,7 @@ section: 1

4 description: Explain installed packages

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-explain.md

7 +github_path: docs/lib/content/commands/npm-explain.md

8 redirect_from:

9 - /cli-commands/explain

10 - /cli-commands/npm-explain

@@ -37,21 +37,12 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm explain <package-spec>

43 alias: why

44 ```

50 -

51 -

52 -

53 -

54 -

46 ### Description

48 This command will print the chain of dependencies causing a given package

@@ -95,9 +86,6 @@ node_modules/nyc/node_modules/find-up

86 ```

88 ### Configuration

98 -

99 -

100 -

89 #### `json`

91 * Default: false

@@ -110,9 +98,6 @@ Whether or not to output JSON data, rather than the normal output.

99 Not supported by all npm commands.

100

113 -

114 -

115 -

101 #### `workspace`

102

103 * Default:

@@ -135,11 +120,6 @@ brand new workspace within the project.

120

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

122

138 -

139 -

140 -

141 -

142 -

123 ### See Also

124

125 * [package spec](/cli/v8/using-npm/package-spec)

content/cli/v8/commands/npm-explore.md

+1 -18

@@ -4,7 +4,7 @@ section: 1

4 description: Browse an installed package

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-explore.md

7 +github_path: docs/lib/content/commands/npm-explore.md

8 redirect_from:

9 - /cli-commands/explore

10 - /cli-commands/npm-explore

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm explore <pkg> [ -- <command>]

42 ```

48 -

49 -

50 -

51 -

52 -

44 Note: This command is unaware of workspaces.

46 ### Description

@@ -71,9 +62,6 @@ sure to use `npm rebuild <pkg>` if you make any changes.

63 ### Configuration

74 -

75 -

76 -

65 #### `shell`

67 * Default: SHELL environment variable, or "bash" on Posix, or "cmd.exe" on

@@ -82,11 +70,6 @@ sure to use `npm rebuild <pkg>` if you make any changes.

71 The shell to run for the `npm explore` command.

85 -

86 -

87 -

88 -

89 -

73 ### See Also

75 * [npm folders](/cli/v8/configuring-npm/folders)

content/cli/v8/commands/npm-find-dupes.md

+1 -54

@@ -4,7 +4,7 @@ section: 1

4 description: Find duplication in the package tree

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-find-dupes.md

7 +github_path: docs/lib/content/commands/npm-find-dupes.md

8 redirect_from:

9 - /cli-commands/find-dupes

10 - /cli-commands/npm-find-dupes

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm find-dupes

42 ```

48 -

49 -

50 -

51 -

52 -

44 ### Description

46 Runs `npm dedupe` in `--dry-run` mode, making npm only output the

@@ -57,9 +48,6 @@ duplications, without actually changing the package tree.

49 ### Configuration

60 -

61 -

62 -

51 #### `global-style`

53 * Default: false

@@ -72,9 +60,6 @@ on will be flattened in their `node_modules` folders. This obviously will

60 eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`

61 will be preferred.

75 -

76 -

77 -

63 #### `legacy-bundling`

65 * Default: false

@@ -85,9 +70,6 @@ such as the one included with node 0.8, can install the package. This

70 eliminates all automatic deduping. If used with `global-style` this option

71 will be preferred.

88 -

89 -

90 -

73 #### `strict-peer-deps`

75 * Default: false

@@ -107,9 +89,6 @@ When such and override is performed, a warning is printed, explaining the

89 conflict and the packages involved. If `--strict-peer-deps` is set, then

90 this warning is treated as a failure.

110 -

111 -

112 -

92 #### `package-lock`

94 * Default: true

@@ -120,9 +99,6 @@ will also prevent _writing_ `package-lock.json` if `save` is true.

100 This configuration does not affect `npm ci`.

101

123 -

124 -

125 -

102 #### `omit`

103

104 * Default: 'dev' if the `NODE_ENV` environment variable is set to

@@ -141,9 +117,6 @@ it will be included.

117 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment

118 variable will be set to `'production'` for all lifecycle scripts.

119

144 -

145 -

146 -

120 #### `ignore-scripts`

121

122 * Default: false

@@ -156,9 +129,6 @@ Note that commands explicitly intended to run a particular script, such as

129 will still run their intended script if `ignore-scripts` is set, but they

130 will *not* run any pre- or post-scripts.

131

159 -

160 -

161 -

132 #### `audit`

133

134 * Default: true

@@ -169,9 +139,6 @@ default registry and all registries configured for scopes. See the

139 documentation for [`npm audit`](/cli/v8/commands/npm-audit) for details on what is

140 submitted.

141

172 -

173 -

174 -

142 #### `bin-links`

143

144 * Default: true

@@ -184,9 +151,6 @@ Set to false to have it not do this. This can be used to work around the

151 fact that some file systems don't support symlinks, even on ostensibly Unix

152 systems.

153

187 -

188 -

189 -

154 #### `fund`

155

156 * Default: true

@@ -196,9 +160,6 @@ When "true" displays the message at the end of each `npm install`

160 acknowledging the number of dependencies looking for funding. See [`npm

161 fund`](/cli/v8/commands/npm-fund) for details.

162

199 -

200 -

201 -

163 #### `workspace`

164

165 * Default:

@@ -221,9 +182,6 @@ brand new workspace within the project.

182

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

184

224 -

225 -

226 -

185 #### `workspaces`

186

187 * Default: null

@@ -242,9 +200,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

200

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

202

245 -

246 -

247 -

203 #### `include-workspace-root`

204

205 * Default: false

@@ -258,9 +213,6 @@ the specified workspaces, and not on the root project.

213

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

215

261 -

262 -

263 -

216 #### `install-links`

217

218 * Default: false

@@ -270,11 +222,6 @@ When set file: protocol dependencies that exist outside of the project root

222 will be packed and installed as regular dependencies instead of creating a

223 symlink. This option has no effect on workspaces.

224

273 -

274 -

275 -

276 -

277 -

225 ### See Also

226

227 * [npm dedupe](/cli/v8/commands/npm-dedupe)

content/cli/v8/commands/npm-fund.md

+1 -30

@@ -4,7 +4,7 @@ section: 1

4 description: Retrieve funding information

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-fund.md

7 +github_path: docs/lib/content/commands/npm-fund.md

8 redirect_from:

9 - /cli-commands/fund

10 - /cli-commands/npm-fund

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm fund [<package-spec>]

42 ```

48 -

49 -

50 -

51 -

52 -

44 ### Description

46 This command retrieves information on how to fund the dependencies of a

@@ -103,9 +94,6 @@ test-workspaces-fund@1.0.0

95 ### Configuration

106 -

107 -

108 -

97 #### `json`

99 * Default: false

@@ -118,9 +106,6 @@ Whether or not to output JSON data, rather than the normal output.

106

107 Not supported by all npm commands.

108

121 -

122 -

123 -

109 #### `browser`

110

111 * Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`

@@ -133,9 +118,6 @@ terminal.

118

119 Set to `true` to use default system URL opener.

120

136 -

137 -

138 -

121 #### `unicode`

122

123 * Default: false on windows, true on mac/unix systems with a unicode locale,

@@ -145,9 +127,6 @@ Set to `true` to use default system URL opener.

127 When set to true, npm uses unicode characters in the tree output. When

128 false, it uses ascii characters instead of unicode glyphs.

129

148 -

149 -

150 -

130 #### `workspace`

131

132 * Default:

@@ -170,9 +149,6 @@ brand new workspace within the project.

149

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

151

173 -

174 -

175 -

152 #### `which`

153

154 * Default: null

@@ -180,11 +156,6 @@ This value is not exported to the environment for child processes.

156

157 If there are multiple funding sources, which 1-indexed source URL to open.

158

183 -

184 -

185 -

186 -

187 -

159 ## See Also

160

161 * [package spec](/cli/v8/using-npm/package-spec)

content/cli/v8/commands/npm-help-search.md

+1 -18

@@ -4,7 +4,7 @@ section: 1

4 description: Search npm help documentation

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-help-search.md

7 +github_path: docs/lib/content/commands/npm-help-search.md

8 redirect_from:

9 - /cli-commands/help-search

10 - /cli-commands/npm-help-search

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm help-search <text>

42 ```

48 -

49 -

50 -

51 -

52 -

44 Note: This command is unaware of workspaces.

46 ### Description

@@ -65,9 +56,6 @@ directly.

57 ### Configuration

68 -

69 -

70 -

59 #### `long`

61 * Default: false

@@ -75,11 +63,6 @@ directly.

64 Show extended information in `ls`, `search`, and `help-search`.

78 -

79 -

80 -

81 -

82 -

66 ### See Also

68 * [npm](/cli/v8/commands/npm)

content/cli/v8/commands/npm-help.md

+1 -18

@@ -4,7 +4,7 @@ section: 1

4 description: Get help on npm

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-help.md

7 +github_path: docs/lib/content/commands/npm-help.md

8 redirect_from:

9 - /cli-commands/help

10 - /cli-commands/npm-help

@@ -37,21 +37,12 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm help <term> [<terms..>]

43 alias: hlep

44 ```

50 -

51 -

52 -

53 -

54 -

46 Note: This command is unaware of workspaces.

48 ### Description

@@ -65,9 +56,6 @@ topic, so unique matches are equivalent to specifying a topic name.

57 ### Configuration

68 -

69 -

70 -

59 #### `viewer`

61 * Default: "man" on Posix, "browser" on Windows

@@ -77,11 +65,6 @@ The program to use to view help content.

66 Set to `"browser"` to view html help content in the default web browser.

80 -

81 -

82 -

83 -

84 -

68 ### See Also

70 * [npm](/cli/v8/commands/npm)

content/cli/v8/commands/npm-hook.md

+1 -21

@@ -4,7 +4,7 @@ section: 1

4 description: Manage registry hooks

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-hook.md

7 +github_path: docs/lib/content/commands/npm-hook.md

8 redirect_from:

9 - /cli-commands/hook

10 - /cli-commands/npm-hook

@@ -37,10 +37,6 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm hook add <pkg> <url> <secret> [--type=<type>]

42 npm hook ls [pkg]

@@ -48,11 +44,6 @@ npm hook rm <id>

44 npm hook update <id> <url> <secret>

45 ```

51 -

52 -

53 -

54 -

55 -

47 Note: This command is unaware of workspaces.

49 ### Description

@@ -125,9 +116,6 @@ $ npm hook rm id-deadbeef

116

117 ### Configuration

118

128 -

129 -

130 -

119 #### `registry`

120

121 * Default: "https://registry.npmjs.org/"

@@ -135,9 +123,6 @@ $ npm hook rm id-deadbeef

123

124 The base URL of the npm registry.

125

138 -

139 -

140 -

126 #### `otp`

127

128 * Default: null

@@ -149,11 +134,6 @@ when publishing or changing package permissions with `npm access`.

134 If not set, and a registry response fails with a challenge for a one-time

135 password, npm will prompt on the command line for one.

136

152 -

153 -

154 -

155 -

156 -

137 ### See Also

138

139 * ["Introducing Hooks" blog post](https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm)

content/cli/v8/commands/npm-init.md

+1 -36

@@ -4,7 +4,7 @@ section: 1

4 description: Create a package.json file

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-init.md

7 +github_path: docs/lib/content/commands/npm-init.md

8 redirect_from:

9 - /cli-commands/init

10 - /cli-commands/npm-init

@@ -37,10 +37,6 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm init <package-spec> (same as `npx <package-spec>)

42 npm init <@scope> (same as `npx <@scope>/create`)

@@ -48,11 +44,6 @@ npm init <@scope> (same as `npx <@scope>/create`)

44 aliases: create, innit

45 ```

51 -

52 -

53 -

54 -

55 -

47 ### Description

49 `npm init <initializer>` can be used to set up a new or existing npm

@@ -196,9 +187,6 @@ dot to represent the current directory in that context, e.g: `react-app .`:

187

188 ### Configuration

189

199 -

200 -

201 -

190 #### `yes`

191

192 * Default: null

@@ -207,9 +195,6 @@ dot to represent the current directory in that context, e.g: `react-app .`:

195 Automatically answer "yes" to any prompts that npm might print on the

196 command line.

197

210 -

211 -

212 -

198 #### `force`

199

200 * Default: false

@@ -236,9 +221,6 @@ mistakes, unnecessary performance degradation, and malicious input.

221 If you don't have a clear idea of what you want to do, it is strongly

222 recommended that you do not use this option!

223

239 -

240 -

241 -

224 #### `scope`

225

226 * Default: the scope of the current project, if any, or ""

@@ -269,9 +251,6 @@ npm init --scope=@foo --yes

251 ```

252

253

272 -

273 -

274 -

254 #### `workspace`

255

256 * Default:

@@ -294,9 +273,6 @@ brand new workspace within the project.

273

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

275

297 -

298 -

299 -

276 #### `workspaces`

277

278 * Default: null

@@ -315,9 +291,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

291

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

293

318 -

319 -

320 -

294 #### `workspaces-update`

295

296 * Default: true

@@ -326,9 +299,6 @@ This value is not exported to the environment for child processes.

299 If set to true, the npm cli will run an update after operations that may

300 possibly change the workspaces installed to the `node_modules` folder.

301

329 -

330 -

331 -

302 #### `include-workspace-root`

303

304 * Default: false

@@ -342,11 +312,6 @@ the specified workspaces, and not on the root project.

312

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

314

345 -

346 -

347 -

348 -

349 -

315 ### See Also

316

317 * [package spec](/cli/v8/using-npm/package-spec)

content/cli/v8/commands/npm-install-ci-test.md

+1 -69

@@ -4,7 +4,7 @@ section: 1

4 description: Install a project with a clean slate and run tests

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-install-ci-test.md

7 +github_path: docs/lib/content/commands/npm-install-ci-test.md

8 redirect_from:

9 - /cli-commands/install-ci-test

10 - /cli-commands/npm-install-ci-test

@@ -37,30 +37,18 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm install-ci-test

43 alias: cit

44 ```

50 -

51 -

52 -

53 -

54 -

46 ### Description

48 This command runs `npm ci` followed immediately by `npm test`.

50 ### Configuration

61 -

62 -

63 -

52 #### `save`

54 * Default: `true` unless when using `npm update` where it defaults to `false`

@@ -73,9 +61,6 @@ When used with the `npm rm` command, removes the dependency from

62 Will also prevent writing to `package-lock.json` if set to `false`.

76 -

77 -

78 -

64 #### `save-exact`

66 * Default: false

@@ -84,9 +69,6 @@ Will also prevent writing to `package-lock.json` if set to `false`.

69 Dependencies saved to package.json will be configured with an exact version

70 rather than using npm's default semver range operator.

87 -

88 -

89 -

72 #### `global`

74 * Default: false

@@ -101,9 +83,6 @@ folder instead of the current working directory. See

83 * bin files are linked to `{prefix}/bin`

84 * man pages are linked to `{prefix}/share/man`

104 -

105 -

106 -

86 #### `global-style`

88 * Default: false

@@ -116,9 +95,6 @@ on will be flattened in their `node_modules` folders. This obviously will

95 eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`

96 will be preferred.

119 -

120 -

121 -

98 #### `legacy-bundling`

100 * Default: false

@@ -129,9 +105,6 @@ such as the one included with node 0.8, can install the package. This

105 eliminates all automatic deduping. If used with `global-style` this option

106 will be preferred.

107

132 -

133 -

134 -

108 #### `omit`

109

110 * Default: 'dev' if the `NODE_ENV` environment variable is set to

@@ -150,9 +123,6 @@ it will be included.

123 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment

124 variable will be set to `'production'` for all lifecycle scripts.

125

153 -

154 -

155 -

126 #### `strict-peer-deps`

127

128 * Default: false

@@ -172,9 +142,6 @@ When such and override is performed, a warning is printed, explaining the

142 conflict and the packages involved. If `--strict-peer-deps` is set, then

143 this warning is treated as a failure.

144

175 -

176 -

177 -

145 #### `package-lock`

146

147 * Default: true

@@ -185,9 +152,6 @@ will also prevent _writing_ `package-lock.json` if `save` is true.

152

153 This configuration does not affect `npm ci`.

154

188 -

189 -

190 -

155 #### `foreground-scripts`

156

157 * Default: false

@@ -200,9 +164,6 @@ input, output, and error with the main npm process.

164 Note that this will generally make installs run slower, and be much noisier,

165 but can be useful for debugging.

166

203 -

204 -

205 -

167 #### `ignore-scripts`

168

169 * Default: false

@@ -215,9 +176,6 @@ Note that commands explicitly intended to run a particular script, such as

176 will still run their intended script if `ignore-scripts` is set, but they

177 will *not* run any pre- or post-scripts.

178

218 -

219 -

220 -

179 #### `audit`

180

181 * Default: true

@@ -228,9 +186,6 @@ default registry and all registries configured for scopes. See the

186 documentation for [`npm audit`](/cli/v8/commands/npm-audit) for details on what is

187 submitted.

188

231 -

232 -

233 -

189 #### `bin-links`

190

191 * Default: true

@@ -243,9 +198,6 @@ Set to false to have it not do this. This can be used to work around the

198 fact that some file systems don't support symlinks, even on ostensibly Unix

199 systems.

200

246 -

247 -

248 -

201 #### `fund`

202

203 * Default: true

@@ -255,9 +207,6 @@ When "true" displays the message at the end of each `npm install`

207 acknowledging the number of dependencies looking for funding. See [`npm

208 fund`](/cli/v8/commands/npm-fund) for details.

209

258 -

259 -

260 -

210 #### `dry-run`

211

212 * Default: false

@@ -271,9 +220,6 @@ commands that modify your local installation, eg, `install`, `update`,

220 Note: This is NOT honored by other network related commands, eg `dist-tags`,

221 `owner`, etc.

222

274 -

275 -

276 -

223 #### `workspace`

224

225 * Default:

@@ -296,9 +242,6 @@ brand new workspace within the project.

242

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

244

299 -

300 -

301 -

245 #### `workspaces`

246

247 * Default: null

@@ -317,9 +260,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

260

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

262

320 -

321 -

322 -

263 #### `include-workspace-root`

264

265 * Default: false

@@ -333,9 +273,6 @@ the specified workspaces, and not on the root project.

273

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

275

336 -

337 -

338 -

276 #### `install-links`

277

278 * Default: false

@@ -345,11 +282,6 @@ When set file: protocol dependencies that exist outside of the project root

282 will be packed and installed as regular dependencies instead of creating a

283 symlink. This option has no effect on workspaces.

284

348 -

349 -

350 -

351 -

352 -

285 ### See Also

286

287 * [npm install-test](/cli/v8/commands/npm-install-test)

content/cli/v8/commands/npm-install-test.md

+1 -69

@@ -4,7 +4,7 @@ section: 1

4 description: Install package(s) and run tests

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-install-test.md

7 +github_path: docs/lib/content/commands/npm-install-test.md

8 redirect_from:

9 - /cli-commands/install-test

10 - /cli-commands/npm-install-test

@@ -37,21 +37,12 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm install-test [<package-spec> ...]

43 alias: it

44 ```

50 -

51 -

52 -

53 -

54 -

46 ### Description

48 This command runs an `npm install` followed immediately by an `npm test`. It

@@ -59,9 +50,6 @@ takes exactly the same arguments as `npm install`.

51 ### Configuration

62 -

63 -

64 -

53 #### `save`

55 * Default: `true` unless when using `npm update` where it defaults to `false`

@@ -74,9 +62,6 @@ When used with the `npm rm` command, removes the dependency from

63 Will also prevent writing to `package-lock.json` if set to `false`.

77 -

78 -

79 -

65 #### `save-exact`

67 * Default: false

@@ -85,9 +70,6 @@ Will also prevent writing to `package-lock.json` if set to `false`.

70 Dependencies saved to package.json will be configured with an exact version

71 rather than using npm's default semver range operator.

88 -

89 -

90 -

73 #### `global`

75 * Default: false

@@ -102,9 +84,6 @@ folder instead of the current working directory. See

84 * bin files are linked to `{prefix}/bin`

85 * man pages are linked to `{prefix}/share/man`

105 -

106 -

107 -

87 #### `global-style`

89 * Default: false

@@ -117,9 +96,6 @@ on will be flattened in their `node_modules` folders. This obviously will

96 eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`

97 will be preferred.

120 -

121 -

122 -

99 #### `legacy-bundling`

100

101 * Default: false

@@ -130,9 +106,6 @@ such as the one included with node 0.8, can install the package. This

106 eliminates all automatic deduping. If used with `global-style` this option

107 will be preferred.

108

133 -

134 -

135 -

109 #### `omit`

110

111 * Default: 'dev' if the `NODE_ENV` environment variable is set to

@@ -151,9 +124,6 @@ it will be included.

124 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment

125 variable will be set to `'production'` for all lifecycle scripts.

126

154 -

155 -

156 -

127 #### `strict-peer-deps`

128

129 * Default: false

@@ -173,9 +143,6 @@ When such and override is performed, a warning is printed, explaining the

143 conflict and the packages involved. If `--strict-peer-deps` is set, then

144 this warning is treated as a failure.

145

176 -

177 -

178 -

146 #### `package-lock`

147

148 * Default: true

@@ -186,9 +153,6 @@ will also prevent _writing_ `package-lock.json` if `save` is true.

153

154 This configuration does not affect `npm ci`.

155

189 -

190 -

191 -

156 #### `foreground-scripts`

157

158 * Default: false

@@ -201,9 +165,6 @@ input, output, and error with the main npm process.

165 Note that this will generally make installs run slower, and be much noisier,

166 but can be useful for debugging.

167

204 -

205 -

206 -

168 #### `ignore-scripts`

169

170 * Default: false

@@ -216,9 +177,6 @@ Note that commands explicitly intended to run a particular script, such as

177 will still run their intended script if `ignore-scripts` is set, but they

178 will *not* run any pre- or post-scripts.

179

219 -

220 -

221 -

180 #### `audit`

181

182 * Default: true

@@ -229,9 +187,6 @@ default registry and all registries configured for scopes. See the

187 documentation for [`npm audit`](/cli/v8/commands/npm-audit) for details on what is

188 submitted.

189

232 -

233 -

234 -

190 #### `bin-links`

191

192 * Default: true

@@ -244,9 +199,6 @@ Set to false to have it not do this. This can be used to work around the

199 fact that some file systems don't support symlinks, even on ostensibly Unix

200 systems.

201

247 -

248 -

249 -

202 #### `fund`

203

204 * Default: true

@@ -256,9 +208,6 @@ When "true" displays the message at the end of each `npm install`

208 acknowledging the number of dependencies looking for funding. See [`npm

209 fund`](/cli/v8/commands/npm-fund) for details.

210

259 -

260 -

261 -

211 #### `dry-run`

212

213 * Default: false

@@ -272,9 +221,6 @@ commands that modify your local installation, eg, `install`, `update`,

221 Note: This is NOT honored by other network related commands, eg `dist-tags`,

222 `owner`, etc.

223

275 -

276 -

277 -

224 #### `workspace`

225

226 * Default:

@@ -297,9 +243,6 @@ brand new workspace within the project.

243

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

245

300 -

301 -

302 -

246 #### `workspaces`

247

248 * Default: null

@@ -318,9 +261,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

261

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

263

321 -

322 -

323 -

264 #### `include-workspace-root`

265

266 * Default: false

@@ -334,9 +274,6 @@ the specified workspaces, and not on the root project.

274

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

276

337 -

338 -

339 -

277 #### `install-links`

278

279 * Default: false

@@ -346,11 +283,6 @@ When set file: protocol dependencies that exist outside of the project root

283 will be packed and installed as regular dependencies instead of creating a

284 symlink. This option has no effect on workspaces.

285

349 -

350 -

351 -

352 -

353 -

286 ### See Also

287

288 * [npm install](/cli/v8/commands/npm-install)

content/cli/v8/commands/npm-install.md

+1 -69

@@ -4,7 +4,7 @@ section: 1

4 description: Install a package

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-install.md

7 +github_path: docs/lib/content/commands/npm-install.md

8 redirect_from:

9 - /cli-commands/install

10 - /cli-commands/npm-install

@@ -37,21 +37,12 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm install [<package-spec> ...]

43 aliases: add, i, in, ins, inst, insta, instal, isnt, isnta, isntal, isntall

44 ```

50 -

51 -

52 -

53 -

54 -

46 ### Description

48 This command installs a package and any packages that it depends on. If the

@@ -449,9 +440,6 @@ does.

440

441 These are some of the most common options related to installation.

442

452 -

453 -

454 -

443 #### `save`

444

445 * Default: `true` unless when using `npm update` where it defaults to `false`

@@ -464,9 +452,6 @@ When used with the `npm rm` command, removes the dependency from

452

453 Will also prevent writing to `package-lock.json` if set to `false`.

454

467 -

468 -

469 -

455 #### `save-exact`

456

457 * Default: false

@@ -475,9 +460,6 @@ Will also prevent writing to `package-lock.json` if set to `false`.

460 Dependencies saved to package.json will be configured with an exact version

461 rather than using npm's default semver range operator.

462

478 -

479 -

480 -

463 #### `global`

464

465 * Default: false

@@ -492,9 +474,6 @@ folder instead of the current working directory. See

474 * bin files are linked to `{prefix}/bin`

475 * man pages are linked to `{prefix}/share/man`

476

495 -

496 -

497 -

477 #### `global-style`

478

479 * Default: false

@@ -507,9 +486,6 @@ on will be flattened in their `node_modules` folders. This obviously will

486 eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`

487 will be preferred.

488

510 -

511 -

512 -

489 #### `legacy-bundling`

490

491 * Default: false

@@ -520,9 +496,6 @@ such as the one included with node 0.8, can install the package. This

496 eliminates all automatic deduping. If used with `global-style` this option

497 will be preferred.

498

523 -

524 -

525 -

499 #### `omit`

500

501 * Default: 'dev' if the `NODE_ENV` environment variable is set to

@@ -541,9 +514,6 @@ it will be included.

514 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment

515 variable will be set to `'production'` for all lifecycle scripts.

516

544 -

545 -

546 -

517 #### `strict-peer-deps`

518

519 * Default: false

@@ -563,9 +533,6 @@ When such and override is performed, a warning is printed, explaining the

533 conflict and the packages involved. If `--strict-peer-deps` is set, then

534 this warning is treated as a failure.

535

566 -

567 -

568 -

536 #### `package-lock`

537

538 * Default: true

@@ -576,9 +543,6 @@ will also prevent _writing_ `package-lock.json` if `save` is true.

543

544 This configuration does not affect `npm ci`.

545

579 -

580 -

581 -

546 #### `foreground-scripts`

547

548 * Default: false

@@ -591,9 +555,6 @@ input, output, and error with the main npm process.

555 Note that this will generally make installs run slower, and be much noisier,

556 but can be useful for debugging.

557

594 -

595 -

596 -

558 #### `ignore-scripts`

559

560 * Default: false

@@ -606,9 +567,6 @@ Note that commands explicitly intended to run a particular script, such as

567 will still run their intended script if `ignore-scripts` is set, but they

568 will *not* run any pre- or post-scripts.

569

609 -

610 -

611 -

570 #### `audit`

571

572 * Default: true

@@ -619,9 +577,6 @@ default registry and all registries configured for scopes. See the

577 documentation for [`npm audit`](/cli/v8/commands/npm-audit) for details on what is

578 submitted.

579

622 -

623 -

624 -

580 #### `bin-links`

581

582 * Default: true

@@ -634,9 +589,6 @@ Set to false to have it not do this. This can be used to work around the

589 fact that some file systems don't support symlinks, even on ostensibly Unix

590 systems.

591

637 -

638 -

639 -

592 #### `fund`

593

594 * Default: true

@@ -646,9 +598,6 @@ When "true" displays the message at the end of each `npm install`

598 acknowledging the number of dependencies looking for funding. See [`npm

599 fund`](/cli/v8/commands/npm-fund) for details.

600

649 -

650 -

651 -

601 #### `dry-run`

602

603 * Default: false

@@ -662,9 +611,6 @@ commands that modify your local installation, eg, `install`, `update`,

611 Note: This is NOT honored by other network related commands, eg `dist-tags`,

612 `owner`, etc.

613

665 -

666 -

667 -

614 #### `workspace`

615

616 * Default:

@@ -687,9 +633,6 @@ brand new workspace within the project.

633

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

635

690 -

691 -

692 -

636 #### `workspaces`

637

638 * Default: null

@@ -708,9 +651,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

651

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

653

711 -

712 -

713 -

654 #### `include-workspace-root`

655

656 * Default: false

@@ -724,9 +664,6 @@ the specified workspaces, and not on the root project.

664

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

666

727 -

728 -

729 -

667 #### `install-links`

668

669 * Default: false

@@ -736,11 +673,6 @@ When set file: protocol dependencies that exist outside of the project root

673 will be packed and installed as regular dependencies instead of creating a

674 symlink. This option has no effect on workspaces.

675

739 -

740 -

741 -

742 -

743 -

676 ### Algorithm

677

678 Given a `package{dep}` structure: `A{B,C}, B{C}, C{D}`,

content/cli/v8/commands/npm-link.md

+1 -66

@@ -4,7 +4,7 @@ section: 1

4 description: Symlink a package folder

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-link.md

7 +github_path: docs/lib/content/commands/npm-link.md

8 redirect_from:

9 - /cli-commands/link

10 - /cli-commands/npm-link

@@ -37,21 +37,12 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm link [<package-spec>]

43 alias: ln

44 ```

50 -

51 -

52 -

53 -

54 -

46 ### Description

48 This is handy for installing your own stuff, so that you can work on it and

@@ -150,9 +141,6 @@ workspace(s).

141

142 ### Configuration

143

153 -

154 -

155 -

144 #### `save`

145

146 * Default: `true` unless when using `npm update` where it defaults to `false`

@@ -165,9 +153,6 @@ When used with the `npm rm` command, removes the dependency from

153

154 Will also prevent writing to `package-lock.json` if set to `false`.

155

168 -

169 -

170 -

156 #### `save-exact`

157

158 * Default: false

@@ -176,9 +161,6 @@ Will also prevent writing to `package-lock.json` if set to `false`.

161 Dependencies saved to package.json will be configured with an exact version

162 rather than using npm's default semver range operator.

163

179 -

180 -

181 -

164 #### `global`

165

166 * Default: false

@@ -193,9 +175,6 @@ folder instead of the current working directory. See

175 * bin files are linked to `{prefix}/bin`

176 * man pages are linked to `{prefix}/share/man`

177

196 -

197 -

198 -

178 #### `global-style`

179

180 * Default: false

@@ -208,9 +187,6 @@ on will be flattened in their `node_modules` folders. This obviously will

187 eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`

188 will be preferred.

189

211 -

212 -

213 -

190 #### `legacy-bundling`

191

192 * Default: false

@@ -221,9 +197,6 @@ such as the one included with node 0.8, can install the package. This

197 eliminates all automatic deduping. If used with `global-style` this option

198 will be preferred.

199

224 -

225 -

226 -

200 #### `strict-peer-deps`

201

202 * Default: false

@@ -243,9 +216,6 @@ When such and override is performed, a warning is printed, explaining the

216 conflict and the packages involved. If `--strict-peer-deps` is set, then

217 this warning is treated as a failure.

218

246 -

247 -

248 -

219 #### `package-lock`

220

221 * Default: true

@@ -256,9 +226,6 @@ will also prevent _writing_ `package-lock.json` if `save` is true.

226

227 This configuration does not affect `npm ci`.

228

259 -

260 -

261 -

229 #### `omit`

230

231 * Default: 'dev' if the `NODE_ENV` environment variable is set to

@@ -277,9 +244,6 @@ it will be included.

244 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment

245 variable will be set to `'production'` for all lifecycle scripts.

246

280 -

281 -

282 -

247 #### `ignore-scripts`

248

249 * Default: false

@@ -292,9 +256,6 @@ Note that commands explicitly intended to run a particular script, such as

256 will still run their intended script if `ignore-scripts` is set, but they

257 will *not* run any pre- or post-scripts.

258

295 -

296 -

297 -

259 #### `audit`

260

261 * Default: true

@@ -305,9 +266,6 @@ default registry and all registries configured for scopes. See the

266 documentation for [`npm audit`](/cli/v8/commands/npm-audit) for details on what is

267 submitted.

268

308 -

309 -

310 -

269 #### `bin-links`

270

271 * Default: true

@@ -320,9 +278,6 @@ Set to false to have it not do this. This can be used to work around the

278 fact that some file systems don't support symlinks, even on ostensibly Unix

279 systems.

280

323 -

324 -

325 -

281 #### `fund`

282

283 * Default: true

@@ -332,9 +287,6 @@ When "true" displays the message at the end of each `npm install`

287 acknowledging the number of dependencies looking for funding. See [`npm

288 fund`](/cli/v8/commands/npm-fund) for details.

289

335 -

336 -

337 -

290 #### `dry-run`

291

292 * Default: false

@@ -348,9 +300,6 @@ commands that modify your local installation, eg, `install`, `update`,

300 Note: This is NOT honored by other network related commands, eg `dist-tags`,

301 `owner`, etc.

302

351 -

352 -

353 -

303 #### `workspace`

304

305 * Default:

@@ -373,9 +322,6 @@ brand new workspace within the project.

322

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

324

376 -

377 -

378 -

325 #### `workspaces`

326

327 * Default: null

@@ -394,9 +340,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

340

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

342

397 -

398 -

399 -

343 #### `include-workspace-root`

344

345 * Default: false

@@ -410,9 +353,6 @@ the specified workspaces, and not on the root project.

353

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

355

413 -

414 -

415 -

356 #### `install-links`

357

358 * Default: false

@@ -422,11 +362,6 @@ When set file: protocol dependencies that exist outside of the project root

362 will be packed and installed as regular dependencies instead of creating a

363 symlink. This option has no effect on workspaces.

364

425 -

426 -

427 -

428 -

429 -

365 ### See Also

366

367 * [package spec](/cli/v8/using-npm/package-spec)

content/cli/v8/commands/npm-logout.md

+1 -21

@@ -4,7 +4,7 @@ section: 1

4 description: Log out of the registry

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-logout.md

7 +github_path: docs/lib/content/commands/npm-logout.md

8 redirect_from:

9 - /cli-commands/logout

10 - /cli-commands/npm-logout

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm logout

42 ```

48 -

49 -

50 -

51 -

52 -

44 Note: This command is unaware of workspaces.

46 ### Description

@@ -67,9 +58,6 @@ connected to that scope, if set.

59 ### Configuration

70 -

71 -

72 -

61 #### `registry`

63 * Default: "https://registry.npmjs.org/"

@@ -77,9 +65,6 @@ connected to that scope, if set.

66 The base URL of the npm registry.

80 -

81 -

82 -

68 #### `scope`

70 * Default: the scope of the current project, if any, or ""

@@ -110,11 +95,6 @@ npm init --scope=@foo --yes

95 ```

113 -

114 -

115 -

116 -

117 -

98 ### See Also

100 * [npm adduser](/cli/v8/commands/npm-adduser)

content/cli/v8/commands/npm-ls.md

+2 -58

@@ -4,7 +4,7 @@ section: 1

4 description: List installed packages

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-ls.md

7 +github_path: docs/lib/content/commands/npm-ls.md

8 redirect_from:

9 - /cli-commands/ls

10 - /cli-commands/npm-ls

@@ -37,21 +37,12 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm ls <package-spec>

43 alias: list

44 ```

50 -

51 -

52 -

53 -

54 -

46 ### Description

48 This command will print to stdout all the versions of packages that are

@@ -67,7 +58,7 @@ packages will *also* show the paths to the specified packages. For

58 example, running `npm ls promzard` in npm's source tree will show:

60 ```bash

70 -npm@8.19.2 /path/to/npm

61 +npm@8.19.3 /path/to/npm

62 └─┬ init-package-json@0.0.4

63 └── promzard@0.1.5

64 ```

@@ -113,9 +104,6 @@ least the default human-readable `npm ls` output in npm v8.

104

105 ### Configuration

106

116 -

117 -

118 -

107 #### `all`

108

109 * Default: false

@@ -125,9 +113,6 @@ When running `npm outdated` and `npm ls`, setting `--all` will show all

113 outdated or installed packages, rather than only those directly depended

114 upon by the current project.

115

128 -

129 -

130 -

116 #### `json`

117

118 * Default: false

@@ -140,9 +125,6 @@ Whether or not to output JSON data, rather than the normal output.

125

126 Not supported by all npm commands.

127

143 -

144 -

145 -

128 #### `long`

129

130 * Default: false

@@ -150,9 +132,6 @@ Not supported by all npm commands.

132

133 Show extended information in `ls`, `search`, and `help-search`.

134

153 -

154 -

155 -

135 #### `parseable`

136

137 * Default: false

@@ -161,9 +140,6 @@ Show extended information in `ls`, `search`, and `help-search`.

140 Output parseable results from commands that write to standard output. For

141 `npm search`, this will be tab-separated table format.

142

164 -

165 -

166 -

143 #### `global`

144

145 * Default: false

@@ -178,9 +154,6 @@ folder instead of the current working directory. See

154 * bin files are linked to `{prefix}/bin`

155 * man pages are linked to `{prefix}/share/man`

156

181 -

182 -

183 -

157 #### `depth`

158

159 * Default: `Infinity` if `--all` is set, otherwise `1`

@@ -191,9 +164,6 @@ The depth to go when recursing packages for `npm ls`.

164 If not set, `npm ls` will show only the immediate dependencies of the root

165 project. If `--all` is set, then npm will show all dependencies by default.

166

194 -

195 -

196 -

167 #### `omit`

168

169 * Default: 'dev' if the `NODE_ENV` environment variable is set to

@@ -212,9 +182,6 @@ it will be included.

182 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment

183 variable will be set to `'production'` for all lifecycle scripts.

184

215 -

216 -

217 -

185 #### `link`

186

187 * Default: false

@@ -222,9 +189,6 @@ variable will be set to `'production'` for all lifecycle scripts.

189

190 Used with `npm ls`, limiting output to only those packages that are linked.

191

225 -

226 -

227 -

192 #### `package-lock-only`

193

194 * Default: false

@@ -239,9 +203,6 @@ instead of checking `node_modules` and downloading dependencies.

203 For `list` this means the output will be based on the tree described by the

204 `package-lock.json`, rather than the contents of `node_modules`.

205

242 -

243 -

244 -

206 #### `unicode`

207

208 * Default: false on windows, true on mac/unix systems with a unicode locale,

@@ -251,9 +212,6 @@ For `list` this means the output will be based on the tree described by the

212 When set to true, npm uses unicode characters in the tree output. When

213 false, it uses ascii characters instead of unicode glyphs.

214

254 -

255 -

256 -

215 #### `workspace`

216

217 * Default:

@@ -276,9 +234,6 @@ brand new workspace within the project.

234

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

236

279 -

280 -

281 -

237 #### `workspaces`

238

239 * Default: null

@@ -297,9 +252,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

252

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

254

300 -

301 -

302 -

255 #### `include-workspace-root`

256

257 * Default: false

@@ -313,9 +265,6 @@ the specified workspaces, and not on the root project.

265

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

267

316 -

317 -

318 -

268 #### `install-links`

269

270 * Default: false

@@ -325,11 +274,6 @@ When set file: protocol dependencies that exist outside of the project root

274 will be packed and installed as regular dependencies instead of creating a

275 symlink. This option has no effect on workspaces.

276

328 -

329 -

330 -

331 -

332 -

277 ### See Also

278

279 * [package spec](/cli/v8/using-npm/package-spec)

content/cli/v8/commands/npm-org.md

+1 -27

@@ -4,7 +4,7 @@ section: 1

4 description: Manage orgs

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-org.md

7 +github_path: docs/lib/content/commands/npm-org.md

8 redirect_from:

9 - /cli-commands/npm-org

10 - /cli-commands/org

@@ -37,10 +37,6 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm org set orgname username [developer | admin | owner]

42 npm org rm orgname username

@@ -49,11 +45,6 @@ npm org ls orgname [<username>]

45 alias: ogr

46 ```

52 -

53 -

54 -

55 -

56 -

48 Note: This command is unaware of workspaces.

50 ### Example

@@ -102,9 +93,6 @@ listing them, and finding specific ones and their roles.

94 ### Configuration

105 -

106 -

107 -

96 #### `registry`

98 * Default: "https://registry.npmjs.org/"

@@ -112,9 +100,6 @@ listing them, and finding specific ones and their roles.

100

101 The base URL of the npm registry.

102

115 -

116 -

117 -

103 #### `otp`

104

105 * Default: null

@@ -126,9 +111,6 @@ when publishing or changing package permissions with `npm access`.

111 If not set, and a registry response fails with a challenge for a one-time

112 password, npm will prompt on the command line for one.

113

129 -

130 -

131 -

114 #### `json`

115

116 * Default: false

@@ -141,9 +123,6 @@ Whether or not to output JSON data, rather than the normal output.

123

124 Not supported by all npm commands.

125

144 -

145 -

146 -

126 #### `parseable`

127

128 * Default: false

@@ -152,11 +131,6 @@ Not supported by all npm commands.

131 Output parseable results from commands that write to standard output. For

132 `npm search`, this will be tab-separated table format.

133

155 -

156 -

157 -

158 -

159 -

134 ### See Also

135

136 * [using orgs](/cli/v8/using-npm/orgs)

content/cli/v8/commands/npm-outdated.md

+1 -33

@@ -4,7 +4,7 @@ section: 1

4 description: Check for outdated packages

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-outdated.md

7 +github_path: docs/lib/content/commands/npm-outdated.md

8 redirect_from:

9 - /cli-commands/npm-outdated

10 - /cli-commands/outdated

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm outdated [<package-spec> ...]

42 ```

48 -

49 -

50 -

51 -

52 -

44 ### Description

46 This command will check the registry to see if any (or, specific) installed

@@ -126,9 +117,6 @@ A few things to note:

117

118 ### Configuration

119

129 -

130 -

131 -

120 #### `all`

121

122 * Default: false

@@ -138,9 +126,6 @@ When running `npm outdated` and `npm ls`, setting `--all` will show all

126 outdated or installed packages, rather than only those directly depended

127 upon by the current project.

128

141 -

142 -

143 -

129 #### `json`

130

131 * Default: false

@@ -153,9 +138,6 @@ Whether or not to output JSON data, rather than the normal output.

138

139 Not supported by all npm commands.

140

156 -

157 -

158 -

141 #### `long`

142

143 * Default: false

@@ -163,9 +145,6 @@ Not supported by all npm commands.

145

146 Show extended information in `ls`, `search`, and `help-search`.

147

166 -

167 -

168 -

148 #### `parseable`

149

150 * Default: false

@@ -174,9 +153,6 @@ Show extended information in `ls`, `search`, and `help-search`.

153 Output parseable results from commands that write to standard output. For

154 `npm search`, this will be tab-separated table format.

155

177 -

178 -

179 -

156 #### `global`

157

158 * Default: false

@@ -191,9 +167,6 @@ folder instead of the current working directory. See

167 * bin files are linked to `{prefix}/bin`

168 * man pages are linked to `{prefix}/share/man`

169

194 -

195 -

196 -

170 #### `workspace`

171

172 * Default:

@@ -216,11 +189,6 @@ brand new workspace within the project.

189

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

191

219 -

220 -

221 -

222 -

223 -

192 ### See Also

193

194 * [package spec](/cli/v8/using-npm/package-spec)

content/cli/v8/commands/npm-owner.md

+1 -27

@@ -4,7 +4,7 @@ section: 1

4 description: Manage package owners

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-owner.md

7 +github_path: docs/lib/content/commands/npm-owner.md

8 redirect_from:

9 - /cli-commands/npm-owner

10 - /cli-commands/owner

@@ -37,10 +37,6 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm owner add <user> <package-spec>

42 npm owner rm <user> <package-spec>

@@ -49,11 +45,6 @@ npm owner ls <package-spec>

45 alias: author

46 ```

52 -

53 -

54 -

55 -

56 -

48 Note: This command is unaware of workspaces.

50 ### Description

@@ -77,9 +68,6 @@ on the command line when changing ownership with `--otp`.

69 ### Configuration

80 -

81 -

82 -

71 #### `registry`

73 * Default: "https://registry.npmjs.org/"

@@ -87,9 +75,6 @@ on the command line when changing ownership with `--otp`.

76 The base URL of the npm registry.

90 -

91 -

92 -

78 #### `otp`

80 * Default: null

@@ -101,9 +86,6 @@ when publishing or changing package permissions with `npm access`.

86 If not set, and a registry response fails with a challenge for a one-time

87 password, npm will prompt on the command line for one.

104 -

105 -

106 -

89 #### `workspace`

91 * Default:

@@ -126,9 +108,6 @@ brand new workspace within the project.

108

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

110

129 -

130 -

131 -

111 #### `workspaces`

112

113 * Default: null

@@ -147,11 +126,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

126

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

128

150 -

151 -

152 -

153 -

154 -

129 ### See Also

130

131 * [package spec](/cli/v8/using-npm/package-spec)

content/cli/v8/commands/npm-pack.md

+1 -33

@@ -4,7 +4,7 @@ section: 1

4 description: Create a tarball from a package

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-pack.md

7 +github_path: docs/lib/content/commands/npm-pack.md

8 redirect_from:

9 - /cli-commands/npm-pack

10 - /cli-commands/pack

@@ -37,24 +37,12 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm pack <package-spec>

42 ```

48 -

49 -

50 -

51 -

52 -

44 ### Configuration

55 -

56 -

57 -

46 #### `dry-run`

48 * Default: false

@@ -68,9 +56,6 @@ commands that modify your local installation, eg, `install`, `update`,

56 Note: This is NOT honored by other network related commands, eg `dist-tags`,

57 `owner`, etc.

71 -

72 -

73 -

59 #### `json`

61 * Default: false

@@ -83,9 +68,6 @@ Whether or not to output JSON data, rather than the normal output.

69 Not supported by all npm commands.

86 -

87 -

88 -

71 #### `pack-destination`

73 * Default: "."

@@ -93,9 +75,6 @@ Not supported by all npm commands.

76 Directory in which `npm pack` will save tarballs.

96 -

97 -

98 -

78 #### `workspace`

80 * Default:

@@ -118,9 +97,6 @@ brand new workspace within the project.

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

121 -

122 -

123 -

100 #### `workspaces`

101

102 * Default: null

@@ -139,9 +115,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

115

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

117

142 -

143 -

144 -

118 #### `include-workspace-root`

119

120 * Default: false

@@ -155,11 +128,6 @@ the specified workspaces, and not on the root project.

128

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

130

158 -

159 -

160 -

161 -

162 -

131 ### Description

132

133 For anything that's installable (that is, a package folder, tarball,

content/cli/v8/commands/npm-ping.md

+1 -18

@@ -4,7 +4,7 @@ section: 1

4 description: Ping npm registry

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-ping.md

7 +github_path: docs/lib/content/commands/npm-ping.md

8 redirect_from:

9 - /cli-commands/npm-ping

10 - /cli-commands/ping

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm ping

42 ```

48 -

49 -

50 -

51 -

52 -

44 Note: This command is unaware of workspaces.

46 ### Description

@@ -70,9 +61,6 @@ npm ERR! 404 Not Found - GET http://www.foo.com/-/ping?write=true

62 ### Configuration

73 -

74 -

75 -

64 #### `registry`

66 * Default: "https://registry.npmjs.org/"

@@ -80,11 +68,6 @@ npm ERR! 404 Not Found - GET http://www.foo.com/-/ping?write=true

69 The base URL of the npm registry.

83 -

84 -

85 -

86 -

87 -

71 ### See Also

73 * [npm doctor](/cli/v8/commands/npm-doctor)

content/cli/v8/commands/npm-pkg.md

+1 -27

@@ -4,7 +4,7 @@ section: 1

4 description: Manages your package.json

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-pkg.md

7 +github_path: docs/lib/content/commands/npm-pkg.md

8 redirect_from:

9 - /cli-commands/npm-pkg

10 - /cli-commands/pkg

@@ -37,10 +37,6 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm pkg set <key>=<value> [<key>=<value> ...]

42 npm pkg get [<key> [<key> ...]]

@@ -49,11 +45,6 @@ npm pkg set [<array>[<index>].<key>=<value> ...]

45 npm pkg set [<array>[].<key>=<value> ...]

46 ```

52 -

53 -

54 -

55 -

56 -

48 ### Description

50 A command that automates the management of `package.json` files.

@@ -214,9 +205,6 @@ npm pkg get name version --ws

205

206 ### Configuration

207

217 -

218 -

219 -

208 #### `force`

209

210 * Default: false

@@ -243,9 +231,6 @@ mistakes, unnecessary performance degradation, and malicious input.

231 If you don't have a clear idea of what you want to do, it is strongly

232 recommended that you do not use this option!

233

246 -

247 -

248 -

234 #### `json`

235

236 * Default: false

@@ -258,9 +243,6 @@ Whether or not to output JSON data, rather than the normal output.

243

244 Not supported by all npm commands.

245

261 -

262 -

263 -

246 #### `workspace`

247

248 * Default:

@@ -283,9 +265,6 @@ brand new workspace within the project.

265

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

267

286 -

287 -

288 -

268 #### `workspaces`

269

270 * Default: null

@@ -303,11 +282,6 @@ other things (test, exec, publish, etc.) will operate on the root project,

282 _unless_ one or more workspaces are specified in the `workspace` config.

283

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

306 -

307 -

308 -

309 -

310 -

285 ## See Also

286

287 * [npm install](/cli/v8/commands/npm-install)

content/cli/v8/commands/npm-prefix.md

+1 -18

@@ -4,7 +4,7 @@ section: 1

4 description: Display prefix

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-prefix.md

7 +github_path: docs/lib/content/commands/npm-prefix.md

8 redirect_from:

9 - /cli-commands/npm-prefix

10 - /cli-commands/prefix

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm prefix [-g]

42 ```

48 -

49 -

50 -

51 -

52 -

44 Note: This command is unaware of workspaces.

46 ### Description

@@ -75,9 +66,6 @@ npm prefix -g

67 ### Configuration

78 -

79 -

80 -

69 #### `global`

71 * Default: false

@@ -92,11 +80,6 @@ folder instead of the current working directory. See

80 * bin files are linked to `{prefix}/bin`

81 * man pages are linked to `{prefix}/share/man`

95 -

96 -

97 -

98 -

99 -

83 ### See Also

85 * [npm root](/cli/v8/commands/npm-root)

content/cli/v8/commands/npm-profile.md

+1 -27

@@ -4,7 +4,7 @@ section: 1

4 description: Change settings on your registry profile

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-profile.md

7 +github_path: docs/lib/content/commands/npm-profile.md

8 redirect_from:

9 - /cli-commands/npm-profile

10 - /cli-commands/profile

@@ -37,10 +37,6 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm profile enable-2fa [auth-only|auth-and-writes]

42 npm profile disable-2fa

@@ -48,11 +44,6 @@ npm profile get [<key>]

44 npm profile set <key> <value>

45 ```

51 -

52 -

53 -

54 -

55 -

47 Note: This command is unaware of workspaces.

49 ### Description

@@ -114,9 +105,6 @@ Some of these commands may not be available on non npmjs.com registries.

105

106 ### Configuration

107

117 -

118 -

119 -

108 #### `registry`

109

110 * Default: "https://registry.npmjs.org/"

@@ -124,9 +112,6 @@ Some of these commands may not be available on non npmjs.com registries.

112

113 The base URL of the npm registry.

114

127 -

128 -

129 -

115 #### `json`

116

117 * Default: false

@@ -139,9 +124,6 @@ Whether or not to output JSON data, rather than the normal output.

124

125 Not supported by all npm commands.

126

142 -

143 -

144 -

127 #### `parseable`

128

129 * Default: false

@@ -150,9 +132,6 @@ Not supported by all npm commands.

132 Output parseable results from commands that write to standard output. For

133 `npm search`, this will be tab-separated table format.

134

153 -

154 -

155 -

135 #### `otp`

136

137 * Default: null

@@ -164,11 +143,6 @@ when publishing or changing package permissions with `npm access`.

143 If not set, and a registry response fails with a challenge for a one-time

144 password, npm will prompt on the command line for one.

145

167 -

168 -

169 -

170 -

171 -

146 ### See Also

147

148 * [npm adduser](/cli/v8/commands/npm-adduser)

content/cli/v8/commands/npm-prune.md

+1 -42

@@ -4,7 +4,7 @@ section: 1

4 description: Remove extraneous packages

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-prune.md

7 +github_path: docs/lib/content/commands/npm-prune.md

8 redirect_from:

9 - /cli-commands/npm-prune

10 - /cli-commands/prune

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm prune [[<@scope>/]<pkg>...]

42 ```

48 -

49 -

50 -

51 -

52 -

44 ### Description

46 This command removes "extraneous" packages. If a package name is provided,

@@ -75,9 +66,6 @@ this command can help clean up any resulting garbage.

67 ### Configuration

78 -

79 -

80 -

69 #### `omit`

71 * Default: 'dev' if the `NODE_ENV` environment variable is set to

@@ -96,9 +84,6 @@ it will be included.

84 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment

85 variable will be set to `'production'` for all lifecycle scripts.

99 -

100 -

101 -

87 #### `dry-run`

89 * Default: false

@@ -112,9 +97,6 @@ commands that modify your local installation, eg, `install`, `update`,

97 Note: This is NOT honored by other network related commands, eg `dist-tags`,

98 `owner`, etc.

115 -

116 -

117 -

100 #### `json`

101

102 * Default: false

@@ -127,9 +109,6 @@ Whether or not to output JSON data, rather than the normal output.

109

110 Not supported by all npm commands.

111

130 -

131 -

132 -

112 #### `foreground-scripts`

113

114 * Default: false

@@ -142,9 +121,6 @@ input, output, and error with the main npm process.

121 Note that this will generally make installs run slower, and be much noisier,

122 but can be useful for debugging.

123

145 -

146 -

147 -

124 #### `ignore-scripts`

125

126 * Default: false

@@ -157,9 +133,6 @@ Note that commands explicitly intended to run a particular script, such as

133 will still run their intended script if `ignore-scripts` is set, but they

134 will *not* run any pre- or post-scripts.

135

160 -

161 -

162 -

136 #### `workspace`

137

138 * Default:

@@ -182,9 +155,6 @@ brand new workspace within the project.

155

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

157

185 -

186 -

187 -

158 #### `workspaces`

159

160 * Default: null

@@ -203,9 +173,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

173

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

175

206 -

207 -

208 -

176 #### `include-workspace-root`

177

178 * Default: false

@@ -219,9 +186,6 @@ the specified workspaces, and not on the root project.

186

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

188

222 -

223 -

224 -

189 #### `install-links`

190

191 * Default: false

@@ -231,11 +195,6 @@ When set file: protocol dependencies that exist outside of the project root

195 will be packed and installed as regular dependencies instead of creating a

196 symlink. This option has no effect on workspaces.

197

234 -

235 -

236 -

237 -

238 -

198 ### See Also

199

200 * [npm uninstall](/cli/v8/commands/npm-uninstall)

content/cli/v8/commands/npm-publish.md

+1 -36

@@ -4,7 +4,7 @@ section: 1

4 description: Publish a package

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-publish.md

7 +github_path: docs/lib/content/commands/npm-publish.md

8 redirect_from:

9 - /cli-commands/npm-publish

10 - /cli-commands/publish

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm publish <package-spec>

42 ```

48 -

49 -

50 -

51 -

52 -

44 ### Description

46 Publishes a package to the registry so that it can be installed by name.

@@ -127,9 +118,6 @@ built.

118

119 ### Configuration

120

130 -

131 -

132 -

121 #### `tag`

122

123 * Default: "latest"

@@ -144,9 +132,6 @@ command, if no explicit tag is given.

132 When used by the `npm diff` command, this is the tag used to fetch the

133 tarball that will be compared with the local files by default.

134

147 -

148 -

149 -

135 #### `access`

136

137 * Default: 'restricted' for scoped packages, 'public' for unscoped packages

@@ -163,9 +148,6 @@ subsequent `npm publish` commands using the `--access` flag will not have an

148 effect to the access level. To make changes to the access level after the

149 initial publish use `npm access`.

150

166 -

167 -

168 -

151 #### `dry-run`

152

153 * Default: false

@@ -179,9 +161,6 @@ commands that modify your local installation, eg, `install`, `update`,

161 Note: This is NOT honored by other network related commands, eg `dist-tags`,

162 `owner`, etc.

163

182 -

183 -

184 -

164 #### `otp`

165

166 * Default: null

@@ -193,9 +172,6 @@ when publishing or changing package permissions with `npm access`.

172 If not set, and a registry response fails with a challenge for a one-time

173 password, npm will prompt on the command line for one.

174

196 -

197 -

198 -

175 #### `workspace`

176

177 * Default:

@@ -218,9 +194,6 @@ brand new workspace within the project.

194

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

196

221 -

222 -

223 -

197 #### `workspaces`

198

199 * Default: null

@@ -239,9 +212,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

212

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

214

242 -

243 -

244 -

215 #### `include-workspace-root`

216

217 * Default: false

@@ -255,11 +225,6 @@ the specified workspaces, and not on the root project.

225

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

227

258 -

259 -

260 -

261 -

262 -

228 ### See Also

229

230 * [package spec](/cli/v8/using-npm/package-spec)

content/cli/v8/commands/npm-query.md

+1 -27

@@ -4,7 +4,7 @@ section: 1

4 description: Dependency selector query

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-query.md

7 +github_path: docs/lib/content/commands/npm-query.md

8 redirect_from:

9 - /cli-commands/npm-query

10 - /cli-commands/query

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm query <selector>

42 ```

48 -

49 -

50 -

51 -

52 -

44 ### Description

46 The `npm query` command allows for usage of css selectors in order to retrieve

@@ -178,9 +169,6 @@ npm query ":type(git)" | jq 'map(.name)' | xargs -I {} npm why {}

169

170 ### Configuration

171

181 -

182 -

183 -

172 #### `global`

173

174 * Default: false

@@ -195,9 +183,6 @@ folder instead of the current working directory. See

183 * bin files are linked to `{prefix}/bin`

184 * man pages are linked to `{prefix}/share/man`

185

198 -

199 -

200 -

186 #### `workspace`

187

188 * Default:

@@ -220,9 +205,6 @@ brand new workspace within the project.

205

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

207

223 -

224 -

225 -

208 #### `workspaces`

209

210 * Default: null

@@ -241,9 +223,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

223

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

225

244 -

245 -

246 -

226 #### `include-workspace-root`

227

228 * Default: false

@@ -256,11 +235,6 @@ all workspaces via the `workspaces` flag, will cause npm to operate only on

235 the specified workspaces, and not on the root project.

236

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

259 -

260 -

261 -

262 -

263 -

238 ## See Also

239

240 * [dependency selectors](/cli/v8/using-npm/dependency-selectors)

content/cli/v8/commands/npm-rebuild.md

+1 -39

@@ -4,7 +4,7 @@ section: 1

4 description: Rebuild a package

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-rebuild.md

7 +github_path: docs/lib/content/commands/npm-rebuild.md

8 redirect_from:

9 - /cli-commands/npm-rebuild

10 - /cli-commands/rebuild

@@ -37,21 +37,12 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm rebuild [<package-spec>] ...]

43 alias: rb

44 ```

50 -

51 -

52 -

53 -

54 -

46 ### Description

48 This command runs the `npm build` command on the matched folders. This is

@@ -65,9 +56,6 @@ name and version matching one of the specifiers will be rebuilt.

57 ### Configuration

68 -

69 -

70 -

59 #### `global`

61 * Default: false

@@ -82,9 +70,6 @@ folder instead of the current working directory. See

70 * bin files are linked to `{prefix}/bin`

71 * man pages are linked to `{prefix}/share/man`

85 -

86 -

87 -

73 #### `bin-links`

75 * Default: true

@@ -97,9 +82,6 @@ Set to false to have it not do this. This can be used to work around the

82 fact that some file systems don't support symlinks, even on ostensibly Unix

83 systems.

100 -

101 -

102 -

85 #### `foreground-scripts`

87 * Default: false

@@ -112,9 +94,6 @@ input, output, and error with the main npm process.

94 Note that this will generally make installs run slower, and be much noisier,

95 but can be useful for debugging.

115 -

116 -

117 -

97 #### `ignore-scripts`

99 * Default: false

@@ -127,9 +106,6 @@ Note that commands explicitly intended to run a particular script, such as

106 will still run their intended script if `ignore-scripts` is set, but they

107 will *not* run any pre- or post-scripts.

108

130 -

131 -

132 -

109 #### `workspace`

110

111 * Default:

@@ -152,9 +128,6 @@ brand new workspace within the project.

128

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

130

155 -

156 -

157 -

131 #### `workspaces`

132

133 * Default: null

@@ -173,9 +146,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

146

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

148

176 -

177 -

178 -

149 #### `include-workspace-root`

150

151 * Default: false

@@ -189,9 +159,6 @@ the specified workspaces, and not on the root project.

159

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

161

192 -

193 -

194 -

162 #### `install-links`

163

164 * Default: false

@@ -201,11 +168,6 @@ When set file: protocol dependencies that exist outside of the project root

168 will be packed and installed as regular dependencies instead of creating a

169 symlink. This option has no effect on workspaces.

170

204 -

205 -

206 -

207 -

208 -

171 ### See Also

172

173 * [package spec](/cli/v8/using-npm/package-spec)

content/cli/v8/commands/npm-repo.md

+1 -30

@@ -4,7 +4,7 @@ section: 1

4 description: Open package repository page in the browser

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-repo.md

7 +github_path: docs/lib/content/commands/npm-repo.md

8 redirect_from:

9 - /cli-commands/npm-repo

10 - /cli-commands/repo

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm repo [<pkgname> [<pkgname> ...]]

42 ```

48 -

49 -

50 -

51 -

52 -

44 ### Description

46 This command tries to guess at the likely location of a package's

@@ -59,9 +50,6 @@ in the current folder and use the `repository` property.

51 ### Configuration

62 -

63 -

64 -

53 #### `browser`

55 * Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`

@@ -74,9 +62,6 @@ terminal.

63 Set to `true` to use default system URL opener.

77 -

78 -

79 -

65 #### `registry`

67 * Default: "https://registry.npmjs.org/"

@@ -84,9 +69,6 @@ Set to `true` to use default system URL opener.

70 The base URL of the npm registry.

87 -

88 -

89 -

72 #### `workspace`

74 * Default:

@@ -109,9 +91,6 @@ brand new workspace within the project.

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

112 -

113 -

114 -

94 #### `workspaces`

96 * Default: null

@@ -130,9 +109,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

109

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

111

133 -

134 -

135 -

112 #### `include-workspace-root`

113

114 * Default: false

@@ -146,11 +122,6 @@ the specified workspaces, and not on the root project.

122

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

124

149 -

150 -

151 -

152 -

153 -

125 ### See Also

126

127 * [npm docs](/cli/v8/commands/npm-docs)

content/cli/v8/commands/npm-restart.md

+1 -21

@@ -4,7 +4,7 @@ section: 1

4 description: Restart a package

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-restart.md

7 +github_path: docs/lib/content/commands/npm-restart.md

8 redirect_from:

9 - /cli-commands/npm-restart

10 - /cli-commands/restart

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm restart [-- <args>]

42 ```

48 -

49 -

50 -

51 -

52 -

44 ### Description

46 This restarts a project. It is equivalent to running `npm run-script

@@ -76,9 +67,6 @@ If it does _not_ have a `"restart"` script specified, but it does have

68 ### Configuration

79 -

80 -

81 -

70 #### `ignore-scripts`

72 * Default: false

@@ -91,9 +79,6 @@ Note that commands explicitly intended to run a particular script, such as

79 will still run their intended script if `ignore-scripts` is set, but they

80 will *not* run any pre- or post-scripts.

94 -

95 -

96 -

82 #### `script-shell`

84 * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows

@@ -102,11 +87,6 @@ will *not* run any pre- or post-scripts.

87 The shell to use for scripts run with the `npm exec`, `npm run` and `npm

88 init <package-spec>` commands.

105 -

106 -

107 -

108 -

109 -

90 ### See Also

92 * [npm run-script](/cli/v8/commands/npm-run-script)

content/cli/v8/commands/npm-root.md

+1 -18

@@ -4,7 +4,7 @@ section: 1

4 description: Display npm root

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-root.md

7 +github_path: docs/lib/content/commands/npm-root.md

8 redirect_from:

9 - /cli-commands/npm-root

10 - /cli-commands/root

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm root

42 ```

48 -

49 -

50 -

51 -

52 -

44 ### Description

46 Print the effective `node_modules` folder to standard out.

@@ -65,9 +56,6 @@ echo "Global packages installed in: ${global_node_modules}"

57 ### Configuration

68 -

69 -

70 -

59 #### `global`

61 * Default: false

@@ -82,11 +70,6 @@ folder instead of the current working directory. See

70 * bin files are linked to `{prefix}/bin`

71 * man pages are linked to `{prefix}/share/man`

85 -

86 -

87 -

88 -

89 -

73 ### See Also

75 * [npm prefix](/cli/v8/commands/npm-prefix)

content/cli/v8/commands/npm-run-script.md

+1 -36

@@ -4,7 +4,7 @@ section: 1

4 description: Run arbitrary package scripts

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-run-script.md

7 +github_path: docs/lib/content/commands/npm-run-script.md

8 redirect_from:

9 - /cli-commands/npm-run-script

10 - /cli-commands/run-script

@@ -37,21 +37,12 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm run-script <command> [-- <args>]

43 aliases: run, rum, urn

44 ```

50 -

51 -

52 -

53 -

54 -

46 ### Description

48 This runs an arbitrary command from a package's `"scripts"` object. If no

@@ -174,9 +165,6 @@ packages.

165

166 ### Configuration

167

177 -

178 -

179 -

168 #### `workspace`

169

170 * Default:

@@ -199,9 +187,6 @@ brand new workspace within the project.

187

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

189

202 -

203 -

204 -

190 #### `workspaces`

191

192 * Default: null

@@ -220,9 +205,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

205

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

207

223 -

224 -

225 -

208 #### `include-workspace-root`

209

210 * Default: false

@@ -236,9 +218,6 @@ the specified workspaces, and not on the root project.

218

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

220

239 -

240 -

241 -

221 #### `if-present`

222

223 * Default: false

@@ -253,9 +232,6 @@ CI setup.

232

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

234

256 -

257 -

258 -

235 #### `ignore-scripts`

236

237 * Default: false

@@ -268,9 +244,6 @@ Note that commands explicitly intended to run a particular script, such as

244 will still run their intended script if `ignore-scripts` is set, but they

245 will *not* run any pre- or post-scripts.

246

271 -

272 -

273 -

247 #### `foreground-scripts`

248

249 * Default: false

@@ -283,9 +256,6 @@ input, output, and error with the main npm process.

256 Note that this will generally make installs run slower, and be much noisier,

257 but can be useful for debugging.

258

286 -

287 -

288 -

259 #### `script-shell`

260

261 * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows

@@ -294,11 +264,6 @@ but can be useful for debugging.

264 The shell to use for scripts run with the `npm exec`, `npm run` and `npm

265 init <package-spec>` commands.

266

297 -

298 -

299 -

300 -

301 -

267 ### See Also

268

269 * [npm scripts](/cli/v8/using-npm/scripts)

content/cli/v8/commands/npm-search.md

+1 -48

@@ -4,7 +4,7 @@ section: 1

4 description: Search for packages

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-search.md

7 +github_path: docs/lib/content/commands/npm-search.md

8 redirect_from:

9 - /cli-commands/npm-search

10 - /cli-commands/search

@@ -37,21 +37,12 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm search [search terms ...]

43 aliases: find, s, se

44 ```

50 -

51 -

52 -

53 -

54 -

46 Note: This command is unaware of workspaces.

48 ### Description

@@ -79,9 +70,6 @@ expression characters in most shells.)

71 ### Configuration

82 -

83 -

84 -

73 #### `long`

75 * Default: false

@@ -89,9 +77,6 @@ expression characters in most shells.)

78 Show extended information in `ls`, `search`, and `help-search`.

92 -

93 -

94 -

80 #### `json`

82 * Default: false

@@ -104,9 +89,6 @@ Whether or not to output JSON data, rather than the normal output.

90 Not supported by all npm commands.

107 -

108 -

109 -

92 #### `color`

94 * Default: true unless the NO_COLOR environ is set to something other than '0'

@@ -115,9 +97,6 @@ Not supported by all npm commands.

97 If false, never shows colors. If `"always"` then always shows colors. If

98 true, then only prints color codes for tty file descriptors.

118 -

119 -

120 -

100 #### `parseable`

101

102 * Default: false

@@ -126,9 +105,6 @@ true, then only prints color codes for tty file descriptors.

105 Output parseable results from commands that write to standard output. For

106 `npm search`, this will be tab-separated table format.

107

129 -

130 -

131 -

108 #### `description`

109

110 * Default: true

@@ -136,9 +112,6 @@ Output parseable results from commands that write to standard output. For

112

113 Show the description in `npm search`

114

139 -

140 -

141 -

115 #### `searchopts`

116

117 * Default: ""

@@ -146,9 +119,6 @@ Show the description in `npm search`

119

120 Space-separated options that are always passed to search.

121

149 -

150 -

151 -

122 #### `searchexclude`

123

124 * Default: ""

@@ -156,9 +126,6 @@ Space-separated options that are always passed to search.

126

127 Space-separated options that limit the results from search.

128

159 -

160 -

161 -

129 #### `registry`

130

131 * Default: "https://registry.npmjs.org/"

@@ -166,9 +133,6 @@ Space-separated options that limit the results from search.

133

134 The base URL of the npm registry.

135

169 -

170 -

171 -

136 #### `prefer-online`

137

138 * Default: false

@@ -177,9 +141,6 @@ The base URL of the npm registry.

141 If true, staleness checks for cached data will be forced, making the CLI

142 look for updates immediately even for fresh package data.

143

180 -

181 -

182 -

144 #### `prefer-offline`

145

146 * Default: false

@@ -189,9 +150,6 @@ If true, staleness checks for cached data will be bypassed, but missing data

150 will be requested from the server. To force full offline mode, use

151 `--offline`.

152

192 -

193 -

194 -

153 #### `offline`

154

155 * Default: false

@@ -200,11 +158,6 @@ will be requested from the server. To force full offline mode, use

158 Force offline mode: no network requests will be done during install. To

159 allow the CLI to fill in missing cache data, see `--prefer-offline`.

160

203 -

204 -

205 -

206 -

207 -

161 ### See Also

162

163 * [npm registry](/cli/v8/using-npm/registry)

content/cli/v8/commands/npm-set-script.md

+1 -24

@@ -4,7 +4,7 @@ section: 1

4 description: Set tasks in the scripts section of package.json

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-set-script.md

7 +github_path: docs/lib/content/commands/npm-set-script.md

8 redirect_from:

9 - /cli-commands/npm-set-script

10 - /cli-commands/set-script

@@ -40,19 +40,10 @@ An npm command that lets you create a task in the `scripts` section of the `pack

41 Deprecated.

43 -

44 -

45 -

46 -

43 ```bash

44 npm set-script [<script>] [<command>]

45 ```

51 -

52 -

53 -

54 -

55 -

48 **Example:**

@@ -70,9 +61,6 @@ npm set-script [<script>] [<command>]

62 ### Configuration

73 -

74 -

75 -

64 #### `workspace`

66 * Default:

@@ -95,9 +83,6 @@ brand new workspace within the project.

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

98 -

99 -

100 -

86 #### `workspaces`

88 * Default: null

@@ -116,9 +101,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

101

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

103

119 -

120 -

121 -

104 #### `include-workspace-root`

105

106 * Default: false

@@ -132,11 +114,6 @@ the specified workspaces, and not on the root project.

114

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

116

135 -

136 -

137 -

138 -

139 -

117 ### See Also

118

119 * [npm run-script](/cli/v8/commands/npm-run-script)

content/cli/v8/commands/npm-shrinkwrap.md

+1 -10

@@ -4,7 +4,7 @@ section: 1

4 description: Lock down dependency versions for publication

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-shrinkwrap.md

7 +github_path: docs/lib/content/commands/npm-shrinkwrap.md

8 redirect_from:

9 - /cli-commands/npm-shrinkwrap

10 - /cli-commands/shrinkwrap

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm shrinkwrap

42 ```

48 -

49 -

50 -

51 -

52 -

44 Note: This command is unaware of workspaces.

46 ### Description

content/cli/v8/commands/npm-star.md

+1 -24

@@ -4,7 +4,7 @@ section: 1

4 description: Mark your favorite packages

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-star.md

7 +github_path: docs/lib/content/commands/npm-star.md

8 redirect_from:

9 - /cli-commands/npm-star

10 - /cli-commands/star

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm star [<package-spec>...]

42 ```

48 -

49 -

50 -

51 -

52 -

44 Note: This command is unaware of workspaces.

46 ### Description

@@ -75,9 +66,6 @@ You can see all your starred packages using [`npm stars`](/cli/v8/commands/npm-s

67 ### Configuration

78 -

79 -

80 -

69 #### `registry`

71 * Default: "https://registry.npmjs.org/"

@@ -85,9 +73,6 @@ You can see all your starred packages using [`npm stars`](/cli/v8/commands/npm-s

74 The base URL of the npm registry.

88 -

89 -

90 -

76 #### `unicode`

78 * Default: false on windows, true on mac/unix systems with a unicode locale,

@@ -97,9 +82,6 @@ The base URL of the npm registry.

82 When set to true, npm uses unicode characters in the tree output. When

83 false, it uses ascii characters instead of unicode glyphs.

100 -

101 -

102 -

85 #### `otp`

87 * Default: null

@@ -111,11 +93,6 @@ when publishing or changing package permissions with `npm access`.

93 If not set, and a registry response fails with a challenge for a one-time

94 password, npm will prompt on the command line for one.

114 -

115 -

116 -

117 -

118 -

96 ### See Also

98 * [package spec](/cli/v8/using-npm/package-spec)

content/cli/v8/commands/npm-stars.md

+1 -18

@@ -4,7 +4,7 @@ section: 1

4 description: View packages marked as favorites

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-stars.md

7 +github_path: docs/lib/content/commands/npm-stars.md

8 redirect_from:

9 - /cli-commands/npm-stars

10 - /cli-commands/stars

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm stars [<user>]

42 ```

48 -

49 -

50 -

51 -

52 -

44 Note: This command is unaware of workspaces.

46 ### Description

@@ -62,9 +53,6 @@ you will most certainly enjoy this command.

54 ### Configuration

65 -

66 -

67 -

56 #### `registry`

58 * Default: "https://registry.npmjs.org/"

@@ -72,11 +60,6 @@ you will most certainly enjoy this command.

61 The base URL of the npm registry.

75 -

76 -

77 -

78 -

79 -

63 ### See Also

65 * [npm star](/cli/v8/commands/npm-star)

content/cli/v8/commands/npm-start.md

+1 -21

@@ -4,7 +4,7 @@ section: 1

4 description: Start a package

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-start.md

7 +github_path: docs/lib/content/commands/npm-start.md

8 redirect_from:

9 - /cli-commands/npm-start

10 - /cli-commands/start

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm start [-- <args>]

42 ```

48 -

49 -

50 -

51 -

52 -

44 ### Description

46 This runs a predefined command specified in the `"start"` property of

@@ -87,9 +78,6 @@ npm start

79 ### Configuration

90 -

91 -

92 -

81 #### `ignore-scripts`

83 * Default: false

@@ -102,9 +90,6 @@ Note that commands explicitly intended to run a particular script, such as

90 will still run their intended script if `ignore-scripts` is set, but they

91 will *not* run any pre- or post-scripts.

105 -

106 -

107 -

93 #### `script-shell`

95 * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows

@@ -113,11 +98,6 @@ will *not* run any pre- or post-scripts.

98 The shell to use for scripts run with the `npm exec`, `npm run` and `npm

99 init <package-spec>` commands.

100

116 -

117 -

118 -

119 -

120 -

101 ### See Also

102

103 * [npm run-script](/cli/v8/commands/npm-run-script)

content/cli/v8/commands/npm-stop.md

+1 -21

@@ -4,7 +4,7 @@ section: 1

4 description: Stop a package

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-stop.md

7 +github_path: docs/lib/content/commands/npm-stop.md

8 redirect_from:

9 - /cli-commands/npm-stop

10 - /cli-commands/stop

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm stop [-- <args>]

42 ```

48 -

49 -

50 -

51 -

52 -

44 ### Description

46 This runs a predefined command specified in the "stop" property of a

@@ -80,9 +71,6 @@ npm stop

72 ### Configuration

83 -

84 -

85 -

74 #### `ignore-scripts`

76 * Default: false

@@ -95,9 +83,6 @@ Note that commands explicitly intended to run a particular script, such as

83 will still run their intended script if `ignore-scripts` is set, but they

84 will *not* run any pre- or post-scripts.

98 -

99 -

100 -

86 #### `script-shell`

88 * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows

@@ -106,11 +91,6 @@ will *not* run any pre- or post-scripts.

91 The shell to use for scripts run with the `npm exec`, `npm run` and `npm

92 init <package-spec>` commands.

109 -

110 -

111 -

112 -

113 -

94 ### See Also

96 * [npm run-script](/cli/v8/commands/npm-run-script)

content/cli/v8/commands/npm-team.md

+1 -27

@@ -4,7 +4,7 @@ section: 1

4 description: Manage organization teams and team memberships

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-team.md

7 +github_path: docs/lib/content/commands/npm-team.md

8 redirect_from:

9 - /cli-commands/npm-team

10 - /cli-commands/team

@@ -37,10 +37,6 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm team create <scope:team> [--otp <otpcode>]

42 npm team destroy <scope:team> [--otp <otpcode>]

@@ -49,11 +45,6 @@ npm team rm <scope:team> <user> [--otp <otpcode>]

45 npm team ls <scope>|<scope:team>

46 ```

52 -

53 -

54 -

55 -

56 -

48 Note: This command is unaware of workspaces.

50 ### Description

@@ -141,9 +132,6 @@ use the `npm access` command to grant or revoke the appropriate permissions.

132

133 ### Configuration

134

144 -

145 -

146 -

135 #### `registry`

136

137 * Default: "https://registry.npmjs.org/"

@@ -151,9 +139,6 @@ use the `npm access` command to grant or revoke the appropriate permissions.

139

140 The base URL of the npm registry.

141

154 -

155 -

156 -

142 #### `otp`

143

144 * Default: null

@@ -165,9 +150,6 @@ when publishing or changing package permissions with `npm access`.

150 If not set, and a registry response fails with a challenge for a one-time

151 password, npm will prompt on the command line for one.

152

168 -

169 -

170 -

153 #### `parseable`

154

155 * Default: false

@@ -176,9 +158,6 @@ password, npm will prompt on the command line for one.

158 Output parseable results from commands that write to standard output. For

159 `npm search`, this will be tab-separated table format.

160

179 -

180 -

181 -

161 #### `json`

162

163 * Default: false

@@ -191,11 +170,6 @@ Whether or not to output JSON data, rather than the normal output.

170

171 Not supported by all npm commands.

172

194 -

195 -

196 -

197 -

198 -

173 ### See Also

174

175 * [npm access](/cli/v8/commands/npm-access)

content/cli/v8/commands/npm-test.md

+1 -21

@@ -4,7 +4,7 @@ section: 1

4 description: Test a package

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-test.md

7 +github_path: docs/lib/content/commands/npm-test.md

8 redirect_from:

9 - /cli-commands/npm-test

10 - /cli-commands/test

@@ -37,21 +37,12 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm test [-- <args>]

43 aliases: tst, t

44 ```

50 -

51 -

52 -

53 -

54 -

46 ### Description

48 This runs a predefined command specified in the `"test"` property of

@@ -77,9 +68,6 @@ npm test

69 ### Configuration

80 -

81 -

82 -

71 #### `ignore-scripts`

73 * Default: false

@@ -92,9 +80,6 @@ Note that commands explicitly intended to run a particular script, such as

80 will still run their intended script if `ignore-scripts` is set, but they

81 will *not* run any pre- or post-scripts.

95 -

96 -

97 -

83 #### `script-shell`

85 * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows

@@ -103,11 +88,6 @@ will *not* run any pre- or post-scripts.

88 The shell to use for scripts run with the `npm exec`, `npm run` and `npm

89 init <package-spec>` commands.

106 -

107 -

108 -

109 -

110 -

91 ### See Also

93 * [npm run-script](/cli/v8/commands/npm-run-script)

content/cli/v8/commands/npm-token.md

+1 -27

@@ -4,7 +4,7 @@ section: 1

4 description: Manage your authentication tokens

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-token.md

7 +github_path: docs/lib/content/commands/npm-token.md

8 redirect_from:

9 - /cli-commands/npm-token

10 - /cli-commands/token

@@ -37,21 +37,12 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm token list

42 npm token revoke <id|token>

43 npm token create [--read-only] [--cidr=list]

44 ```

50 -

51 -

52 -

53 -

54 -

46 Note: This command is unaware of workspaces.

48 ### Description

@@ -117,9 +108,6 @@ This lets you list, create and revoke authentication tokens.

108

109 ### Configuration

110

120 -

121 -

122 -

111 #### `read-only`

112

113 * Default: false

@@ -128,9 +116,6 @@ This lets you list, create and revoke authentication tokens.

116 This is used to mark a token as unable to publish when configuring limited

117 access tokens with the `npm token create` command.

118

131 -

132 -

133 -

119 #### `cidr`

120

121 * Default: null

@@ -139,9 +124,6 @@ access tokens with the `npm token create` command.

124 This is a list of CIDR address to be used when configuring limited access

125 tokens with the `npm token create` command.

126

142 -

143 -

144 -

127 #### `registry`

128

129 * Default: "https://registry.npmjs.org/"

@@ -149,9 +131,6 @@ tokens with the `npm token create` command.

131

132 The base URL of the npm registry.

133

152 -

153 -

154 -

134 #### `otp`

135

136 * Default: null

@@ -163,11 +142,6 @@ when publishing or changing package permissions with `npm access`.

142 If not set, and a registry response fails with a challenge for a one-time

143 password, npm will prompt on the command line for one.

144

166 -

167 -

168 -

169 -

170 -

145 ### See Also

146

147 * [npm adduser](/cli/v8/commands/npm-adduser)

content/cli/v8/commands/npm-uninstall.md

+1 -30

@@ -4,7 +4,7 @@ section: 1

4 description: Remove a package

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-uninstall.md

7 +github_path: docs/lib/content/commands/npm-uninstall.md

8 redirect_from:

9 - /cli-commands/npm-uninstall

10 - /cli-commands/uninstall

@@ -37,21 +37,12 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm uninstall [<@scope>/]<pkg>...

43 aliases: unlink, remove, rm, r, un

44 ```

50 -

51 -

52 -

53 -

54 -

46 ### Description

48 This uninstalls a package, completely removing everything npm installed

@@ -96,9 +87,6 @@ npm uninstall lodash --no-save

88 ### Configuration

99 -

100 -

101 -

90 #### `save`

92 * Default: `true` unless when using `npm update` where it defaults to `false`

@@ -111,9 +99,6 @@ When used with the `npm rm` command, removes the dependency from

100 Will also prevent writing to `package-lock.json` if set to `false`.

101

114 -

115 -

116 -

102 #### `workspace`

103

104 * Default:

@@ -136,9 +121,6 @@ brand new workspace within the project.

121

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

123

139 -

140 -

141 -

124 #### `workspaces`

125

126 * Default: null

@@ -157,9 +139,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

139

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

141

160 -

161 -

162 -

142 #### `include-workspace-root`

143

144 * Default: false

@@ -173,9 +152,6 @@ the specified workspaces, and not on the root project.

152

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

154

176 -

177 -

178 -

155 #### `install-links`

156

157 * Default: false

@@ -185,11 +161,6 @@ When set file: protocol dependencies that exist outside of the project root

161 will be packed and installed as regular dependencies instead of creating a

162 symlink. This option has no effect on workspaces.

163

188 -

189 -

190 -

191 -

192 -

164 ### See Also

165

166 * [npm prune](/cli/v8/commands/npm-prune)

content/cli/v8/commands/npm-unpublish.md

+1 -27

@@ -4,7 +4,7 @@ section: 1

4 description: Remove a package from the registry

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-unpublish.md

7 +github_path: docs/lib/content/commands/npm-unpublish.md

8 redirect_from:

9 - /cli-commands/npm-unpublish

10 - /cli-commands/unpublish

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm unpublish [<package-spec>]

42 ```

48 -

49 -

50 -

51 -

52 -

44 To learn more about how the npm registry treats unpublish, see our <a

45 href="https://docs.npmjs.com/policies/unpublish" target="_blank"

46 rel="noopener noreferrer"> unpublish policies</a>

@@ -79,9 +70,6 @@ passed.

71 ### Configuration

82 -

83 -

84 -

73 #### `dry-run`

75 * Default: false

@@ -95,9 +83,6 @@ commands that modify your local installation, eg, `install`, `update`,

83 Note: This is NOT honored by other network related commands, eg `dist-tags`,

84 `owner`, etc.

98 -

99 -

100 -

86 #### `force`

88 * Default: false

@@ -124,9 +109,6 @@ mistakes, unnecessary performance degradation, and malicious input.

109 If you don't have a clear idea of what you want to do, it is strongly

110 recommended that you do not use this option!

111

127 -

128 -

129 -

112 #### `workspace`

113

114 * Default:

@@ -149,9 +131,6 @@ brand new workspace within the project.

131

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

133

152 -

153 -

154 -

134 #### `workspaces`

135

136 * Default: null

@@ -170,11 +149,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

149

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

151

173 -

174 -

175 -

176 -

177 -

152 ### See Also

153

154 * [package spec](/cli/v8/using-npm/package-spec)

content/cli/v8/commands/npm-unstar.md

+1 -24

@@ -4,7 +4,7 @@ section: 1

4 description: Remove an item from your favorite packages

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-unstar.md

7 +github_path: docs/lib/content/commands/npm-unstar.md

8 redirect_from:

9 - /cli-commands/npm-unstar

10 - /cli-commands/unstar

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm unstar [<package-spec>...]

42 ```

48 -

49 -

50 -

51 -

52 -

44 Note: This command is unaware of workspaces.

46 ### Description

@@ -71,9 +62,6 @@ You can see all your starred packages using [`npm stars`](/cli/v8/commands/npm-s

63 ### Configuration

74 -

75 -

76 -

65 #### `registry`

67 * Default: "https://registry.npmjs.org/"

@@ -81,9 +69,6 @@ You can see all your starred packages using [`npm stars`](/cli/v8/commands/npm-s

70 The base URL of the npm registry.

84 -

85 -

86 -

72 #### `unicode`

74 * Default: false on windows, true on mac/unix systems with a unicode locale,

@@ -93,9 +78,6 @@ The base URL of the npm registry.

78 When set to true, npm uses unicode characters in the tree output. When

79 false, it uses ascii characters instead of unicode glyphs.

96 -

97 -

98 -

81 #### `otp`

83 * Default: null

@@ -107,11 +89,6 @@ when publishing or changing package permissions with `npm access`.

89 If not set, and a registry response fails with a challenge for a one-time

90 password, npm will prompt on the command line for one.

110 -

111 -

112 -

113 -

114 -

92 ### See Also

94 * [npm star](/cli/v8/commands/npm-star)

content/cli/v8/commands/npm-update.md

+1 -66

@@ -4,7 +4,7 @@ section: 1

4 description: Update packages

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-update.md

7 +github_path: docs/lib/content/commands/npm-update.md

8 redirect_from:

9 - /cli-commands/npm-update

10 - /cli-commands/update

@@ -37,21 +37,12 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm update [<pkg>...]

43 aliases: up, upgrade, udpate

44 ```

50 -

51 -

52 -

53 -

54 -

46 ### Description

48 This command will update all the packages listed to the latest version

@@ -197,9 +188,6 @@ be _downgraded_.

188

189 ### Configuration

190

200 -

201 -

202 -

191 #### `save`

192

193 * Default: `true` unless when using `npm update` where it defaults to `false`

@@ -212,9 +200,6 @@ When used with the `npm rm` command, removes the dependency from

200

201 Will also prevent writing to `package-lock.json` if set to `false`.

202

215 -

216 -

217 -

203 #### `global`

204

205 * Default: false

@@ -229,9 +214,6 @@ folder instead of the current working directory. See

214 * bin files are linked to `{prefix}/bin`

215 * man pages are linked to `{prefix}/share/man`

216

232 -

233 -

234 -

217 #### `global-style`

218

219 * Default: false

@@ -244,9 +226,6 @@ on will be flattened in their `node_modules` folders. This obviously will

226 eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`

227 will be preferred.

228

247 -

248 -

249 -

229 #### `legacy-bundling`

230

231 * Default: false

@@ -257,9 +236,6 @@ such as the one included with node 0.8, can install the package. This

236 eliminates all automatic deduping. If used with `global-style` this option

237 will be preferred.

238

260 -

261 -

262 -

239 #### `omit`

240

241 * Default: 'dev' if the `NODE_ENV` environment variable is set to

@@ -278,9 +254,6 @@ it will be included.

254 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment

255 variable will be set to `'production'` for all lifecycle scripts.

256

281 -

282 -

283 -

257 #### `strict-peer-deps`

258

259 * Default: false

@@ -300,9 +273,6 @@ When such and override is performed, a warning is printed, explaining the

273 conflict and the packages involved. If `--strict-peer-deps` is set, then

274 this warning is treated as a failure.

275

303 -

304 -

305 -

276 #### `package-lock`

277

278 * Default: true

@@ -313,9 +283,6 @@ will also prevent _writing_ `package-lock.json` if `save` is true.

283

284 This configuration does not affect `npm ci`.

285

316 -

317 -

318 -

286 #### `foreground-scripts`

287

288 * Default: false

@@ -328,9 +295,6 @@ input, output, and error with the main npm process.

295 Note that this will generally make installs run slower, and be much noisier,

296 but can be useful for debugging.

297

331 -

332 -

333 -

298 #### `ignore-scripts`

299

300 * Default: false

@@ -343,9 +307,6 @@ Note that commands explicitly intended to run a particular script, such as

307 will still run their intended script if `ignore-scripts` is set, but they

308 will *not* run any pre- or post-scripts.

309

346 -

347 -

348 -

310 #### `audit`

311

312 * Default: true

@@ -356,9 +317,6 @@ default registry and all registries configured for scopes. See the

317 documentation for [`npm audit`](/cli/v8/commands/npm-audit) for details on what is

318 submitted.

319

359 -

360 -

361 -

320 #### `bin-links`

321

322 * Default: true

@@ -371,9 +329,6 @@ Set to false to have it not do this. This can be used to work around the

329 fact that some file systems don't support symlinks, even on ostensibly Unix

330 systems.

331

374 -

375 -

376 -

332 #### `fund`

333

334 * Default: true

@@ -383,9 +338,6 @@ When "true" displays the message at the end of each `npm install`

338 acknowledging the number of dependencies looking for funding. See [`npm

339 fund`](/cli/v8/commands/npm-fund) for details.

340

386 -

387 -

388 -

341 #### `dry-run`

342

343 * Default: false

@@ -399,9 +351,6 @@ commands that modify your local installation, eg, `install`, `update`,

351 Note: This is NOT honored by other network related commands, eg `dist-tags`,

352 `owner`, etc.

353

402 -

403 -

404 -

354 #### `workspace`

355

356 * Default:

@@ -424,9 +373,6 @@ brand new workspace within the project.

373

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

375

427 -

428 -

429 -

376 #### `workspaces`

377

378 * Default: null

@@ -445,9 +391,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

391

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

393

448 -

449 -

450 -

394 #### `include-workspace-root`

395

396 * Default: false

@@ -461,9 +404,6 @@ the specified workspaces, and not on the root project.

404

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

406

464 -

465 -

466 -

407 #### `install-links`

408

409 * Default: false

@@ -473,11 +413,6 @@ When set file: protocol dependencies that exist outside of the project root

413 will be packed and installed as regular dependencies instead of creating a

414 symlink. This option has no effect on workspaces.

415

476 -

477 -

478 -

479 -

480 -

416 ### See Also

417

418 * [npm install](/cli/v8/commands/npm-install)

content/cli/v8/commands/npm-version.md

+1 -45

@@ -4,7 +4,7 @@ section: 1

4 description: Bump a package version

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-version.md

7 +github_path: docs/lib/content/commands/npm-version.md

8 redirect_from:

9 - /cli-commands/npm-version

10 - /cli-commands/version

@@ -37,26 +37,14 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

43 alias: verison

44 ```

50 -

51 -

52 -

53 -

54 -

46 ### Configuration

57 -

58 -

59 -

48 #### `allow-same-version`

50 * Default: false

@@ -65,9 +53,6 @@ alias: verison

53 Prevents throwing an error when `npm version` is used to set the new version

54 to the same value as the current version.

68 -

69 -

70 -

56 #### `commit-hooks`

58 * Default: true

@@ -75,9 +60,6 @@ to the same value as the current version.

61 Run git commit hooks when using the `npm version` command.

78 -

79 -

80 -

63 #### `git-tag-version`

65 * Default: true

@@ -86,9 +68,6 @@ Run git commit hooks when using the `npm version` command.

68 Tag the commit when using the `npm version` command. Setting this to false

69 results in no commit being made at all.

89 -

90 -

91 -

71 #### `json`

73 * Default: false

@@ -101,9 +80,6 @@ Whether or not to output JSON data, rather than the normal output.

81 Not supported by all npm commands.

104 -

105 -

106 -

83 #### `preid`

85 * Default: ""

@@ -112,9 +88,6 @@ Not supported by all npm commands.

88 The "prerelease identifier" to use as a prefix for the "prerelease" part of

89 a semver. Like the `rc` in `1.2.0-rc.8`.

115 -

116 -

117 -

91 #### `sign-git-tag`

93 * Default: false

@@ -126,9 +99,6 @@ If set to true, then the `npm version` command will tag the version using

99 Note that git requires you to have set up GPG keys in your git configs for

100 this to work properly.

101

129 -

130 -

131 -

102 #### `workspace`

103

104 * Default:

@@ -151,9 +121,6 @@ brand new workspace within the project.

121

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

123

154 -

155 -

156 -

124 #### `workspaces`

125

126 * Default: null

@@ -172,9 +139,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

139

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

141

175 -

176 -

177 -

142 #### `workspaces-update`

143

144 * Default: true

@@ -183,9 +147,6 @@ This value is not exported to the environment for child processes.

147 If set to true, the npm cli will run an update after operations that may

148 possibly change the workspaces installed to the `node_modules` folder.

149

186 -

187 -

188 -

150 #### `include-workspace-root`

151

152 * Default: false

@@ -199,11 +160,6 @@ the specified workspaces, and not on the root project.

160

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

162

202 -

203 -

204 -

205 -

206 -

163 ### Description

164

165 Run this in a package directory to bump the version and write the new data

content/cli/v8/commands/npm-view.md

+1 -27

@@ -4,7 +4,7 @@ section: 1

4 description: View registry info

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-view.md

7 +github_path: docs/lib/content/commands/npm-view.md

8 redirect_from:

9 - /cli-commands/npm-view

10 - /cli-commands/view

@@ -37,21 +37,12 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm view [<package-spec>] [<field>[.subfield]...]

43 aliases: info, show, v

44 ```

50 -

51 -

52 -

53 -

54 -

46 ### Description

48 This command shows data about a package and prints it to stdout.

@@ -136,9 +127,6 @@ npm view connect versions

127

128 ### Configuration

129

139 -

140 -

141 -

130 #### `json`

131

132 * Default: false

@@ -151,9 +139,6 @@ Whether or not to output JSON data, rather than the normal output.

139

140 Not supported by all npm commands.

141

154 -

155 -

156 -

142 #### `workspace`

143

144 * Default:

@@ -176,9 +161,6 @@ brand new workspace within the project.

161

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

163

179 -

180 -

181 -

164 #### `workspaces`

165

166 * Default: null

@@ -197,9 +179,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

179

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

181

200 -

201 -

202 -

182 #### `include-workspace-root`

183

184 * Default: false

@@ -213,11 +192,6 @@ the specified workspaces, and not on the root project.

192

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

194

216 -

217 -

218 -

219 -

220 -

195 ### Output

196

197 If only a single string field for a single version is output, then it

content/cli/v8/commands/npm-whoami.md

+1 -18

@@ -4,7 +4,7 @@ section: 1

4 description: Display npm username

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm-whoami.md

7 +github_path: docs/lib/content/commands/npm-whoami.md

8 redirect_from:

9 - /cli-commands/npm-whoami

10 - /cli-commands/whoami

@@ -37,19 +37,10 @@ redirect_from:

38 ### Synopsis

40 -

41 -

42 -

43 -

40 ```bash

41 npm whoami

42 ```

48 -

49 -

50 -

51 -

52 -

44 Note: This command is unaware of workspaces.

46 ### Description

@@ -65,9 +56,6 @@ If logged into a registry that uses Basic Auth, then simply print the

57 ### Configuration

68 -

69 -

70 -

59 #### `registry`

61 * Default: "https://registry.npmjs.org/"

@@ -75,11 +63,6 @@ If logged into a registry that uses Basic Auth, then simply print the

64 The base URL of the npm registry.

78 -

79 -

80 -

81 -

82 -

66 ### See Also

68 * [npm config](/cli/v8/commands/npm-config)

content/cli/v8/commands/npm.md

+5 -4

@@ -4,7 +4,7 @@ section: 1

4 description: javascript package manager

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npm.md

7 +github_path: docs/lib/content/commands/npm.md

8 redirect_from:

9 - /cli-commands/npm

10 - /cli-documentation/cli-commands/npm

@@ -23,12 +23,13 @@ redirect_from:

24 ### Synopsis

26 -

27 -

26 +```bash

27 +npm

28 +```

30 ### Version

31 -8.19.2

32 +8.19.3

34 ### Description

content/cli/v8/commands/npx.md

+1 -10

@@ -4,7 +4,7 @@ section: 1

4 description: Run a command from a local or remote npm package

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/commands/npx.md

7 +github_path: docs/lib/content/commands/npx.md

8 redirect_from:

9 - /cli-commands/npx

10 - /cli-documentation/cli-commands/npx

@@ -23,10 +23,6 @@ redirect_from:

24 ### Synopsis

26 -

27 -

28 -

29 -

26 ```bash

27 npx -- <pkg>[@<version>] [args...]

28 npx --package=<pkg>[@<version>] -- <cmd> [args...]

@@ -34,11 +30,6 @@ npx -c '<cmd> [args...]'

30 npx --package=foo -c '<cmd> [args...]'

31 ```

37 -

38 -

39 -

40 -

41 -

33 ### Description

35 This command allows you to run an arbitrary command from an npm package

content/cli/v8/configuring-npm/folders.md

+1 -1

@@ -4,7 +4,7 @@ section: 5

4 description: Folder Structures Used by npm

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/configuring-npm/folders.md

7 +github_path: docs/lib/content/configuring-npm/folders.md

8 redirect_from:

9 - /cli-documentation/configuring-npm/folders

10 - /cli-documentation/files/folders

content/cli/v8/configuring-npm/index.mdx

+1 -1

@@ -3,7 +3,7 @@ title: Configuring npm

3 shortName: Configuring

4 github_repo: npm/cli

5 github_branch: release/v8

6 -github_path: docs/nav.yml

6 +github_path: docs/lib/content/nav.yml

7 redirect_from:

8 - /cli-documentation/configuring-npm

9 - /cli-documentation/configuring-npm/index

content/cli/v8/configuring-npm/install.md

+1 -1

@@ -4,7 +4,7 @@ section: 5

4 description: Download and install node and npm

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/configuring-npm/install.md

7 +github_path: docs/lib/content/configuring-npm/install.md

8 redirect_from:

9 - /cli-documentation/configuring-npm/install

10 - /cli-documentation/files/install

content/cli/v8/configuring-npm/npm-shrinkwrap-json.md

+1 -1

@@ -4,7 +4,7 @@ section: 5

4 description: A publishable lockfile

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/configuring-npm/npm-shrinkwrap-json.md

7 +github_path: docs/lib/content/configuring-npm/npm-shrinkwrap-json.md

8 redirect_from:

9 - /cli-documentation/configuring-npm/npm-shrinkwrap-json

10 - /cli-documentation/configuring-npm/npm-shrinkwrap.json

content/cli/v8/configuring-npm/npmrc.md

+1 -1

@@ -4,7 +4,7 @@ section: 5

4 description: The npm config files

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/configuring-npm/npmrc.md

7 +github_path: docs/lib/content/configuring-npm/npmrc.md

8 redirect_from:

9 - /cli-documentation/configuring-npm/npmrc

10 - /cli-documentation/files/npmrc

content/cli/v8/configuring-npm/package-json.md

+6 -11

@@ -4,7 +4,7 @@ section: 5

4 description: Specifics of npm's package.json handling

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/configuring-npm/package-json.md

7 +github_path: docs/lib/content/configuring-npm/package-json.md

8 redirect_from:

9 - /cli-documentation/configuring-npm/package-json

10 - /cli-documentation/configuring-npm/package.json

@@ -41,11 +41,9 @@ settings described in [`config`](/cli/v8/using-npm/config).

41 If you plan to publish your package, the *most* important things in your

42 package.json are the name and version fields as they will be required. The

43 name and version together form an identifier that is assumed to be

44 -completely unique. Changes to the package should come along with changes

45 -to the version. If you don't plan to publish your package, the name and

44 +completely unique. If you don't plan to publish your package, the name and

45 version fields are optional.

47 -

48 -The name is what your thing is called.

46 +The name field contains your package name.

48 Some rules:

@@ -75,12 +73,9 @@ A name can be optionally prefixed by a scope, e.g. `@myorg/mypackage`. See

74 ### version

78 -If you plan to publish your package, the *most* important things in your

79 -package.json are the name and version fields as they will be required. The

80 -name and version together form an identifier that is assumed to be

81 -completely unique. Changes to the package should come along with changes

82 -to the version. If you don't plan to publish your package, the name and

83 -version fields are optional.

76 +Changes to the package should come along with changes to the version.

77 +You can show developers how much they need to adjust on a new update by

78 +using [semantic versioning](../../about-semantic-versioning)

80 Version must be parseable by

81 [node-semver](https://github.com/npm/node-semver), which is bundled with

content/cli/v8/configuring-npm/package-lock-json.md

+1 -1

@@ -4,7 +4,7 @@ section: 5

4 description: A manifestation of the manifest

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/configuring-npm/package-lock-json.md

7 +github_path: docs/lib/content/configuring-npm/package-lock-json.md

8 redirect_from:

9 - /cli-documentation/configuring-npm/package-lock-json

10 - /cli-documentation/configuring-npm/package-lock.json

content/cli/v8/index.mdx

+1 -1

@@ -3,7 +3,7 @@ title: npm CLI

3 shortName: CLI

4 github_repo: npm/cli

5 github_branch: release/v8

6 -github_path: docs/nav.yml

6 +github_path: docs/lib/content/nav.yml

7 redirect_from:

8 - /cli

9 - /cli-documentation

content/cli/v8/using-npm/changelog.md

+16

@@ -17,6 +17,22 @@ redirect_from:

18 # Changelog

20 +## [8.19.3](https://github.com/npm/cli/compare/v8.19.2...v8.19.3) (2022-11-03)

21 +

22 +### Bug Fixes

23 +

24 +* [`26f3d0b`](https://github.com/npm/cli/commit/26f3d0b04fec438400d337c2d4ace218225b7ecb) [#5761](https://github.com/npm/cli/pull/5761) use hosted-git-info to parse registry urls (#5761) (@lukekarrys)

25 +

26 +### Documentation

27 +

28 +* [`bd92aa0`](https://github.com/npm/cli/commit/bd92aa03920aa04b20dc7087871a853c50c613e4) [#5753](https://github.com/npm/cli/pull/5753) name and version description change (#5753) (@dominikgorczyca)

29 +

30 +### Dependencies

31 +

32 +* [Workspace](https://github.com/npm/cli/compare/arborist-v5.6.2...arborist-v5.6.3): `@npmcli/arborist@5.6.3`

33 +* [Workspace](https://github.com/npm/cli/compare/libnpmexec-v4.0.13...libnpmexec-v4.0.14): `libnpmexec@4.0.14`

34 +* [Workspace](https://github.com/npm/cli/compare/libnpmfund-v3.0.4...libnpmfund-v3.0.5): `libnpmfund@3.0.5`

35 +

36 ## [8.19.2](https://github.com/npm/cli/compare/v8.19.1...v8.19.2) (2022-09-13)

38 ### Dependencies

content/cli/v8/using-npm/config.md

+1 -462

@@ -4,7 +4,7 @@ section: 7

4 description: More than you probably want to know about npm configuration

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/using-npm/config.md

7 +github_path: docs/lib/content/using-npm/config.md

8 redirect_from:

9 - /cli-documentation/misc/config

10 - /cli-documentation/using-npm/config

@@ -72,9 +72,6 @@ internal to npm, and are defaults if nothing else is specified.

73 The following shorthands are parsed on the command-line:

75 -

76 -

77 -

75 * `-a`: `--all`

76 * `--enjoy-by`: `--before`

77 * `-c`: `--call`

@@ -116,10 +113,6 @@ The following shorthands are parsed on the command-line:

113 * `--ws`: `--workspaces`

114 * `-y`: `--yes`

115

119 -

120 -

121 -

122 -

116 If the specified configuration param resolves unambiguously to a known

117 configuration parameter, then it is expanded to that configuration

118 parameter. For example:

@@ -143,9 +136,6 @@ npm ls --global --parseable --long --loglevel info

136

137 ### Config Settings

138

146 -

147 -

148 -

139 #### `_auth`

140

141 * Default: null

@@ -159,9 +149,6 @@ Warning: This should generally not be set via a command-line option. It is

149 safer to use a registry-provided authentication bearer token stored in the

150 ~/.npmrc file by running `npm login`.

151

162 -

163 -

164 -

152 #### `access`

153

154 * Default: 'restricted' for scoped packages, 'public' for unscoped packages

@@ -178,9 +165,6 @@ subsequent `npm publish` commands using the `--access` flag will not have an

165 effect to the access level. To make changes to the access level after the

166 initial publish use `npm access`.

167

181 -

182 -

183 -

168 #### `all`

169

170 * Default: false

@@ -190,9 +174,6 @@ When running `npm outdated` and `npm ls`, setting `--all` will show all

174 outdated or installed packages, rather than only those directly depended

175 upon by the current project.

176

193 -

194 -

195 -

177 #### `allow-same-version`

178

179 * Default: false

@@ -201,9 +182,6 @@ upon by the current project.

182 Prevents throwing an error when `npm version` is used to set the new version

183 to the same value as the current version.

184

204 -

205 -

206 -

185 #### `audit`

186

187 * Default: true

@@ -214,9 +192,6 @@ default registry and all registries configured for scopes. See the

192 documentation for [`npm audit`](/cli/v8/commands/npm-audit) for details on what is

193 submitted.

194

217 -

218 -

219 -

195 #### `audit-level`

196

197 * Default: null

@@ -225,9 +200,6 @@ submitted.

200 The minimum level of vulnerability for `npm audit` to exit with a non-zero

201 exit code.

202

228 -

229 -

230 -

203 #### `auth-type`

204

205 * Default: "legacy"

@@ -238,9 +210,6 @@ removed in a future version.

210

211 What authentication strategy to use with `login`.

212

241 -

242 -

243 -

213 #### `before`

214

215 * Default: null

@@ -256,9 +225,6 @@ If the requested version is a `dist-tag` and the given tag does not pass the

225 will be used. For example, `foo@latest` might install `foo@1.2` even though

226 `latest` is `2.0`.

227

259 -

260 -

261 -

228 #### `bin-links`

229

230 * Default: true

@@ -271,9 +237,6 @@ Set to false to have it not do this. This can be used to work around the

237 fact that some file systems don't support symlinks, even on ostensibly Unix

238 systems.

239

274 -

275 -

276 -

240 #### `browser`

241

242 * Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`

@@ -286,9 +249,6 @@ terminal.

249

250 Set to `true` to use default system URL opener.

251

289 -

290 -

291 -

252 #### `ca`

253

254 * Default: null

@@ -315,9 +275,6 @@ ca[]="..."

275

276 See also the `strict-ssl` config.

277

318 -

319 -

320 -

278 #### `cache`

279

280 * Default: Windows: `%LocalAppData%\npm-cache`, Posix: `~/.npm`

@@ -326,9 +283,6 @@ See also the `strict-ssl` config.

283 The location of npm's cache directory. See [`npm

284 cache`](/cli/v8/commands/npm-cache)

285

329 -

330 -

331 -

286 #### `cafile`

287

288 * Default: null

@@ -338,9 +292,6 @@ A path to a file containing one or multiple Certificate Authority signing

292 certificates. Similar to the `ca` setting, but allows for multiple CA's, as

293 well as for the CA information to be stored in a file on disk.

294

341 -

342 -

343 -

295 #### `call`

296

297 * Default: ""

@@ -354,9 +305,6 @@ npm exec --package yo --package generator-node --call "yo node"

305 ```

306

307

357 -

358 -

359 -

308 #### `cert`

309

310 * Default: null

@@ -374,9 +322,6 @@ It is _not_ the path to a certificate file, though you can set a

322 registry-scoped "certfile" path like

323 "//other-registry.tld/:certfile=/path/to/cert.pem".

324

377 -

378 -

379 -

325 #### `ci-name`

326

327 * Default: The name of the current CI system, or `null` when not on a known CI

@@ -387,9 +332,6 @@ The name of a continuous integration system. If not set explicitly, npm will

332 detect the current CI environment using the

333 [`@npmcli/ci-detect`](http://npm.im/@npmcli/ci-detect) module.

334

390 -

391 -

392 -

335 #### `cidr`

336

337 * Default: null

@@ -398,9 +340,6 @@ detect the current CI environment using the

340 This is a list of CIDR address to be used when configuring limited access

341 tokens with the `npm token create` command.

342

401 -

402 -

403 -

343 #### `color`

344

345 * Default: true unless the NO_COLOR environ is set to something other than '0'

@@ -409,9 +348,6 @@ tokens with the `npm token create` command.

348 If false, never shows colors. If `"always"` then always shows colors. If

349 true, then only prints color codes for tty file descriptors.

350

412 -

413 -

414 -

351 #### `commit-hooks`

352

353 * Default: true

@@ -419,9 +355,6 @@ true, then only prints color codes for tty file descriptors.

355

356 Run git commit hooks when using the `npm version` command.

357

422 -

423 -

424 -

358 #### `depth`

359

360 * Default: `Infinity` if `--all` is set, otherwise `1`

@@ -432,9 +365,6 @@ The depth to go when recursing packages for `npm ls`.

365 If not set, `npm ls` will show only the immediate dependencies of the root

366 project. If `--all` is set, then npm will show all dependencies by default.

367

435 -

436 -

437 -

368 #### `description`

369

370 * Default: true

@@ -442,9 +372,6 @@ project. If `--all` is set, then npm will show all dependencies by default.

372

373 Show the description in `npm search`

374

445 -

446 -

447 -

375 #### `diff`

376

377 * Default:

@@ -452,9 +379,6 @@ Show the description in `npm search`

379

380 Define arguments to compare in `npm diff`.

381

455 -

456 -

457 -

382 #### `diff-dst-prefix`

383

384 * Default: "b/"

@@ -462,9 +386,6 @@ Define arguments to compare in `npm diff`.

386

387 Destination prefix to be used in `npm diff` output.

388

465 -

466 -

467 -

389 #### `diff-ignore-all-space`

390

391 * Default: false

@@ -472,9 +393,6 @@ Destination prefix to be used in `npm diff` output.

393

394 Ignore whitespace when comparing lines in `npm diff`.

395

475 -

476 -

477 -

396 #### `diff-name-only`

397

398 * Default: false

@@ -482,9 +400,6 @@ Ignore whitespace when comparing lines in `npm diff`.

400

401 Prints only filenames when using `npm diff`.

402

485 -

486 -

487 -

403 #### `diff-no-prefix`

404

405 * Default: false

@@ -495,9 +410,6 @@ Do not show any source or destination prefix in `npm diff` output.

410 Note: this causes `npm diff` to ignore the `--diff-src-prefix` and

411 `--diff-dst-prefix` configs.

412

498 -

499 -

500 -

413 #### `diff-src-prefix`

414

415 * Default: "a/"

@@ -505,9 +417,6 @@ Note: this causes `npm diff` to ignore the `--diff-src-prefix` and

417

418 Source prefix to be used in `npm diff` output.

419

508 -

509 -

510 -

420 #### `diff-text`

421

422 * Default: false

@@ -515,9 +424,6 @@ Source prefix to be used in `npm diff` output.

424

425 Treat all files as text in `npm diff`.

426

518 -

519 -

520 -

427 #### `diff-unified`

428

429 * Default: 3

@@ -525,9 +431,6 @@ Treat all files as text in `npm diff`.

431

432 The number of lines of context to print in `npm diff`.

433

528 -

529 -

530 -

434 #### `dry-run`

435

436 * Default: false

@@ -541,9 +444,6 @@ commands that modify your local installation, eg, `install`, `update`,

444 Note: This is NOT honored by other network related commands, eg `dist-tags`,

445 `owner`, etc.

446

544 -

545 -

546 -

447 #### `editor`

448

449 * Default: The EDITOR or VISUAL environment variables, or 'notepad.exe' on

@@ -552,9 +452,6 @@ Note: This is NOT honored by other network related commands, eg `dist-tags`,

452

453 The command to run for `npm edit` and `npm config edit`.

454

555 -

556 -

557 -

455 #### `engine-strict`

456

457 * Default: false

@@ -566,9 +463,6 @@ Node.js version.

463

464 This can be overridden by setting the `--force` flag.

465

569 -

570 -

571 -

466 #### `fetch-retries`

467

468 * Default: 2

@@ -580,9 +474,6 @@ from the registry.

474 npm will retry idempotent read requests to the registry in the case of

475 network failures or 5xx HTTP errors.

476

583 -

584 -

585 -

477 #### `fetch-retry-factor`

478

479 * Default: 10

@@ -590,9 +481,6 @@ network failures or 5xx HTTP errors.

481

482 The "factor" config for the `retry` module to use when fetching packages.

483

593 -

594 -

595 -

484 #### `fetch-retry-maxtimeout`

485

486 * Default: 60000 (1 minute)

@@ -601,9 +489,6 @@ The "factor" config for the `retry` module to use when fetching packages.

489 The "maxTimeout" config for the `retry` module to use when fetching

490 packages.

491

604 -

605 -

606 -

492 #### `fetch-retry-mintimeout`

493

494 * Default: 10000 (10 seconds)

@@ -612,9 +497,6 @@ packages.

497 The "minTimeout" config for the `retry` module to use when fetching

498 packages.

499

615 -

616 -

617 -

500 #### `fetch-timeout`

501

502 * Default: 300000 (5 minutes)

@@ -622,9 +504,6 @@ packages.

504

505 The maximum amount of time to wait for HTTP requests to complete.

506

625 -

626 -

627 -

507 #### `force`

508

509 * Default: false

@@ -651,9 +530,6 @@ mistakes, unnecessary performance degradation, and malicious input.

530 If you don't have a clear idea of what you want to do, it is strongly

531 recommended that you do not use this option!

532

654 -

655 -

656 -

533 #### `foreground-scripts`

534

535 * Default: false

@@ -666,9 +542,6 @@ input, output, and error with the main npm process.

542 Note that this will generally make installs run slower, and be much noisier,

543 but can be useful for debugging.

544

669 -

670 -

671 -

545 #### `format-package-lock`

546

547 * Default: true

@@ -677,9 +550,6 @@ but can be useful for debugging.

550 Format `package-lock.json` or `npm-shrinkwrap.json` as a human readable

551 file.

552

680 -

681 -

682 -

553 #### `fund`

554

555 * Default: true

@@ -689,9 +559,6 @@ When "true" displays the message at the end of each `npm install`

559 acknowledging the number of dependencies looking for funding. See [`npm

560 fund`](/cli/v8/commands/npm-fund) for details.

561

692 -

693 -

694 -

562 #### `git`

563

564 * Default: "git"

@@ -700,9 +567,6 @@ fund`](/cli/v8/commands/npm-fund) for details.

567 The command to use for git commands. If git is installed on the computer,

568 but is not in the `PATH`, then set this to the full path to the git binary.

569

703 -

704 -

705 -

570 #### `git-tag-version`

571

572 * Default: true

@@ -711,9 +575,6 @@ but is not in the `PATH`, then set this to the full path to the git binary.

575 Tag the commit when using the `npm version` command. Setting this to false

576 results in no commit being made at all.

577

714 -

715 -

716 -

578 #### `global`

579

580 * Default: false

@@ -728,9 +589,6 @@ folder instead of the current working directory. See

589 * bin files are linked to `{prefix}/bin`

590 * man pages are linked to `{prefix}/share/man`

591

731 -

732 -

733 -

592 #### `global-style`

593

594 * Default: false

@@ -743,9 +601,6 @@ on will be flattened in their `node_modules` folders. This obviously will

601 eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`

602 will be preferred.

603

746 -

747 -

748 -

604 #### `globalconfig`

605

606 * Default: The global --prefix setting plus 'etc/npmrc'. For example,

@@ -754,9 +609,6 @@ will be preferred.

609

610 The config file to read for global config options.

611

757 -

758 -

759 -

612 #### `heading`

613

614 * Default: "npm"

@@ -764,9 +616,6 @@ The config file to read for global config options.

616

617 The string that starts all the debugging log output.

618

767 -

768 -

769 -

619 #### `https-proxy`

620

621 * Default: null

@@ -777,9 +626,6 @@ A proxy to use for outgoing https requests. If the `HTTPS_PROXY` or

626 proxy settings will be honored by the underlying `make-fetch-happen`

627 library.

628

780 -

781 -

782 -

629 #### `if-present`

630

631 * Default: false

@@ -794,9 +640,6 @@ CI setup.

640

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

642

797 -

798 -

799 -

643 #### `ignore-scripts`

644

645 * Default: false

@@ -809,9 +652,6 @@ Note that commands explicitly intended to run a particular script, such as

652 will still run their intended script if `ignore-scripts` is set, but they

653 will *not* run any pre- or post-scripts.

654

812 -

813 -

814 -

655 #### `include`

656

657 * Default:

@@ -824,9 +664,6 @@ This is the inverse of `--omit=<type>`.

664 Dependency types specified in `--include` will not be omitted, regardless of

665 the order in which omit/include are specified on the command-line.

666

827 -

828 -

829 -

667 #### `include-staged`

668

669 * Default: false

@@ -837,9 +674,6 @@ Allow installing "staged" published packages, as defined by [npm RFC PR

674

675 This is experimental, and not implemented by the npm public registry.

676

840 -

841 -

842 -

677 #### `include-workspace-root`

678

679 * Default: false

@@ -853,9 +687,6 @@ the specified workspaces, and not on the root project.

687

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

689

856 -

857 -

858 -

690 #### `init-author-email`

691

692 * Default: ""

@@ -863,9 +694,6 @@ This value is not exported to the environment for child processes.

694

695 The value `npm init` should use by default for the package author's email.

696

866 -

867 -

868 -

697 #### `init-author-name`

698

699 * Default: ""

@@ -873,9 +701,6 @@ The value `npm init` should use by default for the package author's email.

701

702 The value `npm init` should use by default for the package author's name.

703

876 -

877 -

878 -

704 #### `init-author-url`

705

706 * Default: ""

@@ -884,9 +709,6 @@ The value `npm init` should use by default for the package author's name.

709 The value `npm init` should use by default for the package author's

710 homepage.

711

887 -

888 -

889 -

712 #### `init-license`

713

714 * Default: "ISC"

@@ -894,9 +716,6 @@ homepage.

716

717 The value `npm init` should use by default for the package license.

718

897 -

898 -

899 -

719 #### `init-module`

720

721 * Default: "~/.npm-init.js"

@@ -907,9 +726,6 @@ documentation for the

726 [init-package-json](https://github.com/npm/init-package-json) module for

727 more information, or [npm init](/cli/v8/commands/npm-init).

728

910 -

911 -

912 -

729 #### `init-version`

730

731 * Default: "1.0.0"

@@ -918,9 +734,6 @@ more information, or [npm init](/cli/v8/commands/npm-init).

734 The value that `npm init` should use by default for the package version

735 number, if not already set in package.json.

736

921 -

922 -

923 -

737 #### `install-links`

738

739 * Default: false

@@ -930,9 +743,6 @@ When set file: protocol dependencies that exist outside of the project root

743 will be packed and installed as regular dependencies instead of creating a

744 symlink. This option has no effect on workspaces.

745

933 -

934 -

935 -

746 #### `json`

747

748 * Default: false

@@ -945,9 +755,6 @@ Whether or not to output JSON data, rather than the normal output.

755

756 Not supported by all npm commands.

757

948 -

949 -

950 -

758 #### `key`

759

760 * Default: null

@@ -963,9 +770,6 @@ key="-----BEGIN PRIVATE KEY-----\nXXXX\nXXXX\n-----END PRIVATE KEY-----"

770 It is _not_ the path to a key file, though you can set a registry-scoped

771 "keyfile" path like "//other-registry.tld/:keyfile=/path/to/key.pem".

772

966 -

967 -

968 -

773 #### `legacy-bundling`

774

775 * Default: false

@@ -976,9 +780,6 @@ such as the one included with node 0.8, can install the package. This

780 eliminates all automatic deduping. If used with `global-style` this option

781 will be preferred.

782

979 -

980 -

981 -

783 #### `legacy-peer-deps`

784

785 * Default: false

@@ -997,9 +798,6 @@ This differs from `--omit=peer`, in that `--omit=peer` will avoid unpacking

798 Use of `legacy-peer-deps` is not recommended, as it will not enforce the

799 `peerDependencies` contract that meta-dependencies may rely on.

800

1000 -

1001 -

1002 -

801 #### `link`

802

803 * Default: false

@@ -1007,9 +805,6 @@ Use of `legacy-peer-deps` is not recommended, as it will not enforce the

805

806 Used with `npm ls`, limiting output to only those packages that are linked.

807

1010 -

1011 -

1012 -

808 #### `local-address`

809

810 * Default: null

@@ -1018,9 +813,6 @@ Used with `npm ls`, limiting output to only those packages that are linked.

813 The IP address of the local interface to use when making connections to the

814 npm registry. Must be IPv4 in versions of Node prior to 0.12.

815

1021 -

1022 -

1023 -

816 #### `location`

817

818 * Default: "user" unless `--global` is passed, which will also set this value

@@ -1038,9 +830,6 @@ instead of the current working directory. See

830 * bin files are linked to `{prefix}/bin`

831 * man pages are linked to `{prefix}/share/man`

832

1041 -

1042 -

1043 -

833 #### `lockfile-version`

834

835 * Default: Version 2 if no lockfile or current lockfile version less than or

@@ -1063,9 +852,6 @@ and interoperability, at the expense of more bytes on disk.

852 disk than lockfile version 2, but not interoperable with older npm versions.

853 Ideal if all users are on npm version 7 and higher.

854

1066 -

1067 -

1068 -

855 #### `loglevel`

856

857 * Default: "notice"

@@ -1080,9 +866,6 @@ Any logs of a higher level than the setting are shown. The default is

866

867 See also the `foreground-scripts` config.

868

1083 -

1084 -

1085 -

869 #### `logs-dir`

870

871 * Default: A directory named `_logs` inside the cache

@@ -1091,9 +874,6 @@ See also the `foreground-scripts` config.

874 The location of npm's log directory. See [`npm logging`](/cli/v8/using-npm/logging)

875 for more information.

876

1094 -

1095 -

1096 -

877 #### `logs-max`

878

879 * Default: 10

@@ -1103,9 +883,6 @@ The maximum number of log files to store.

883

884 If set to 0, no log files will be written for the current run.

885

1106 -

1107 -

1108 -

886 #### `long`

887

888 * Default: false

@@ -1113,9 +890,6 @@ If set to 0, no log files will be written for the current run.

890

891 Show extended information in `ls`, `search`, and `help-search`.

892

1116 -

1117 -

1118 -

893 #### `maxsockets`

894

895 * Default: 15

@@ -1124,9 +898,6 @@ Show extended information in `ls`, `search`, and `help-search`.

898 The maximum number of connections to use per origin (protocol/host/port

899 combination).

900

1127 -

1128 -

1129 -

901 #### `message`

902

903 * Default: "%s"

@@ -1136,9 +907,6 @@ Commit message which is used by `npm version` when creating version commit.

907

908 Any "%s" in the message will be replaced with the version number.

909

1139 -

1140 -

1141 -

910 #### `node-options`

911

912 * Default: null

@@ -1148,9 +916,6 @@ Options to pass through to Node.js via the `NODE_OPTIONS` environment

916 variable. This does not impact how npm itself is executed but it does impact

917 how lifecycle scripts are called.

918

1151 -

1152 -

1153 -

919 #### `node-version`

920

921 * Default: Node.js `process.version` value

@@ -1158,9 +923,6 @@ how lifecycle scripts are called.

923

924 The node version to use when checking a package's `engines` setting.

925

1161 -

1162 -

1163 -

926 #### `noproxy`

927

928 * Default: The value of the NO_PROXY environment variable

@@ -1170,9 +932,6 @@ Domain extensions that should bypass any proxies.

932

933 Also accepts a comma-delimited string.

934

1173 -

1174 -

1175 -

935 #### `npm-version`

936

937 * Default: Output of `npm --version`

@@ -1180,9 +939,6 @@ Also accepts a comma-delimited string.

939

940 The npm version to use when checking a package's `engines` setting.

941

1183 -

1184 -

1185 -

942 #### `offline`

943

944 * Default: false

@@ -1191,9 +947,6 @@ The npm version to use when checking a package's `engines` setting.

947 Force offline mode: no network requests will be done during install. To

948 allow the CLI to fill in missing cache data, see `--prefer-offline`.

949

1194 -

1195 -

1196 -

950 #### `omit`

951

952 * Default: 'dev' if the `NODE_ENV` environment variable is set to

@@ -1212,9 +965,6 @@ it will be included.

965 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment

966 variable will be set to `'production'` for all lifecycle scripts.

967

1215 -

1216 -

1217 -

968 #### `omit-lockfile-registry-resolved`

969

970 * Default: false

@@ -1225,9 +975,6 @@ registry dependencies. Subsequent installs will need to resolve tarball

975 endpoints with the configured registry, likely resulting in a longer install

976 time.

977

1228 -

1229 -

1230 -

978 #### `otp`

979

980 * Default: null

@@ -1239,9 +986,6 @@ when publishing or changing package permissions with `npm access`.

986 If not set, and a registry response fails with a challenge for a one-time

987 password, npm will prompt on the command line for one.

988

1242 -

1243 -

1244 -

989 #### `pack-destination`

990

991 * Default: "."

@@ -1249,9 +993,6 @@ password, npm will prompt on the command line for one.

993

994 Directory in which `npm pack` will save tarballs.

995

1252 -

1253 -

1254 -

996 #### `package`

997

998 * Default:

@@ -1259,9 +1000,6 @@ Directory in which `npm pack` will save tarballs.

1000

1001 The package or packages to install for [`npm exec`](/cli/v8/commands/npm-exec)

1002

1262 -

1263 -

1264 -

1003 #### `package-lock`

1004

1005 * Default: true

@@ -1272,9 +1010,6 @@ will also prevent _writing_ `package-lock.json` if `save` is true.

1010

1011 This configuration does not affect `npm ci`.

1012

1275 -

1276 -

1277 -

1013 #### `package-lock-only`

1014

1015 * Default: false

@@ -1289,9 +1024,6 @@ instead of checking `node_modules` and downloading dependencies.

1024 For `list` this means the output will be based on the tree described by the

1025 `package-lock.json`, rather than the contents of `node_modules`.

1026

1292 -

1293 -

1294 -

1027 #### `parseable`

1028

1029 * Default: false

@@ -1300,9 +1032,6 @@ For `list` this means the output will be based on the tree described by the

1032 Output parseable results from commands that write to standard output. For

1033 `npm search`, this will be tab-separated table format.

1034

1303 -

1304 -

1305 -

1035 #### `prefer-offline`

1036

1037 * Default: false

@@ -1312,9 +1041,6 @@ If true, staleness checks for cached data will be bypassed, but missing data

1041 will be requested from the server. To force full offline mode, use

1042 `--offline`.

1043

1315 -

1316 -

1317 -

1044 #### `prefer-online`

1045

1046 * Default: false

@@ -1323,9 +1049,6 @@ will be requested from the server. To force full offline mode, use

1049 If true, staleness checks for cached data will be forced, making the CLI

1050 look for updates immediately even for fresh package data.

1051

1326 -

1327 -

1328 -

1052 #### `prefix`

1053

1054 * Default: In global mode, the folder where the node executable is installed.

@@ -1336,9 +1059,6 @@ look for updates immediately even for fresh package data.

1059 The location to install global items. If set on the command line, then it

1060 forces non-global commands to run in the specified folder.

1061

1339 -

1340 -

1341 -

1062 #### `preid`

1063

1064 * Default: ""

@@ -1347,9 +1067,6 @@ forces non-global commands to run in the specified folder.

1067 The "prerelease identifier" to use as a prefix for the "prerelease" part of

1068 a semver. Like the `rc` in `1.2.0-rc.8`.

1069

1350 -

1351 -

1352 -

1070 #### `progress`

1071

1072 * Default: `true` unless running in a known CI system

@@ -1360,9 +1077,6 @@ operations, if `process.stderr` is a TTY.

1077

1078 Set to `false` to suppress the progress bar.

1079

1363 -

1364 -

1365 -

1080 #### `proxy`

1081

1082 * Default: null

@@ -1372,9 +1086,6 @@ A proxy to use for outgoing http requests. If the `HTTP_PROXY` or

1086 `http_proxy` environment variables are set, proxy settings will be honored

1087 by the underlying `request` library.

1088

1375 -

1376 -

1377 -

1089 #### `read-only`

1090

1091 * Default: false

@@ -1383,9 +1094,6 @@ by the underlying `request` library.

1094 This is used to mark a token as unable to publish when configuring limited

1095 access tokens with the `npm token create` command.

1096

1386 -

1387 -

1388 -

1097 #### `rebuild-bundle`

1098

1099 * Default: true

@@ -1393,9 +1101,6 @@ access tokens with the `npm token create` command.

1101

1102 Rebuild bundled dependencies after installation.

1103

1396 -

1397 -

1398 -

1104 #### `registry`

1105

1106 * Default: "https://registry.npmjs.org/"

@@ -1403,9 +1108,6 @@ Rebuild bundled dependencies after installation.

1108

1109 The base URL of the npm registry.

1110

1406 -

1407 -

1408 -

1111 #### `replace-registry-host`

1112

1113 * Default: "npmjs"

@@ -1421,9 +1123,6 @@ registry host with the configured host every time.

1123

1124 You may also specify a bare hostname (e.g., "registry.npmjs.org").

1125

1424 -

1425 -

1426 -

1126 #### `save`

1127

1128 * Default: `true` unless when using `npm update` where it defaults to `false`

@@ -1436,9 +1135,6 @@ When used with the `npm rm` command, removes the dependency from

1135

1136 Will also prevent writing to `package-lock.json` if set to `false`.

1137

1439 -

1440 -

1441 -

1138 #### `save-bundle`

1139

1140 * Default: false

@@ -1450,9 +1146,6 @@ If a package would be saved at install time by the use of `--save`,

1146

1147 Ignored if `--save-peer` is set, since peerDependencies cannot be bundled.

1148

1453 -

1454 -

1455 -

1149 #### `save-dev`

1150

1151 * Default: false

@@ -1460,9 +1153,6 @@ Ignored if `--save-peer` is set, since peerDependencies cannot be bundled.

1153

1154 Save installed packages to a package.json file as `devDependencies`.

1155

1463 -

1464 -

1465 -

1156 #### `save-exact`

1157

1158 * Default: false

@@ -1471,9 +1161,6 @@ Save installed packages to a package.json file as `devDependencies`.

1161 Dependencies saved to package.json will be configured with an exact version

1162 rather than using npm's default semver range operator.

1163

1474 -

1475 -

1476 -

1164 #### `save-optional`

1165

1166 * Default: false

@@ -1481,9 +1168,6 @@ rather than using npm's default semver range operator.

1168

1169 Save installed packages to a package.json file as `optionalDependencies`.

1170

1484 -

1485 -

1486 -

1171 #### `save-peer`

1172

1173 * Default: false

@@ -1491,9 +1175,6 @@ Save installed packages to a package.json file as `optionalDependencies`.

1175

1176 Save installed packages to a package.json file as `peerDependencies`

1177

1494 -

1495 -

1496 -

1178 #### `save-prefix`

1179

1180 * Default: "^"

@@ -1507,9 +1188,6 @@ to `^1.2.3` which allows minor upgrades for that package, but after `npm

1188 config set save-prefix='~'` it would be set to `~1.2.3` which only allows

1189 patch upgrades.

1190

1510 -

1511 -

1512 -

1191 #### `save-prod`

1192

1193 * Default: false

@@ -1522,9 +1200,6 @@ you want to move it to be a non-optional production dependency.

1200 This is the default behavior if `--save` is true, and neither `--save-dev`

1201 or `--save-optional` are true.

1202

1525 -

1526 -

1527 -

1203 #### `scope`

1204

1205 * Default: the scope of the current project, if any, or ""

@@ -1555,9 +1230,6 @@ npm init --scope=@foo --yes

1230 ```

1231

1232

1558 -

1559 -

1560 -

1233 #### `script-shell`

1234

1235 * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows

@@ -1566,9 +1238,6 @@ npm init --scope=@foo --yes

1238 The shell to use for scripts run with the `npm exec`, `npm run` and `npm

1239 init <package-spec>` commands.

1240

1569 -

1570 -

1571 -

1241 #### `searchexclude`

1242

1243 * Default: ""

@@ -1576,9 +1245,6 @@ init <package-spec>` commands.

1245

1246 Space-separated options that limit the results from search.

1247

1579 -

1580 -

1581 -

1248 #### `searchlimit`

1249

1250 * Default: 20

@@ -1587,9 +1253,6 @@ Space-separated options that limit the results from search.

1253 Number of items to limit search results to. Will not apply at all to legacy

1254 searches.

1255

1590 -

1591 -

1592 -

1256 #### `searchopts`

1257

1258 * Default: ""

@@ -1597,9 +1260,6 @@ searches.

1260

1261 Space-separated options that are always passed to search.

1262

1600 -

1601 -

1602 -

1263 #### `searchstaleness`

1264

1265 * Default: 900

@@ -1608,9 +1268,6 @@ Space-separated options that are always passed to search.

1268 The age of the cache, in seconds, before another registry request is made if

1269 using legacy search endpoint.

1270

1611 -

1612 -

1613 -

1271 #### `shell`

1272

1273 * Default: SHELL environment variable, or "bash" on Posix, or "cmd.exe" on

@@ -1619,9 +1276,6 @@ using legacy search endpoint.

1276

1277 The shell to run for the `npm explore` command.

1278

1622 -

1623 -

1624 -

1279 #### `sign-git-commit`

1280

1281 * Default: false

@@ -1633,9 +1287,6 @@ version using `-S` to add a signature.

1287 Note that git requires you to have set up GPG keys in your git configs for

1288 this to work properly.

1289

1636 -

1637 -

1638 -

1290 #### `sign-git-tag`

1291

1292 * Default: false

@@ -1647,9 +1298,6 @@ If set to true, then the `npm version` command will tag the version using

1298 Note that git requires you to have set up GPG keys in your git configs for

1299 this to work properly.

1300

1650 -

1651 -

1652 -

1301 #### `strict-peer-deps`

1302

1303 * Default: false

@@ -1669,9 +1317,6 @@ When such and override is performed, a warning is printed, explaining the

1317 conflict and the packages involved. If `--strict-peer-deps` is set, then

1318 this warning is treated as a failure.

1319

1672 -

1673 -

1674 -

1320 #### `strict-ssl`

1321

1322 * Default: true

@@ -1682,9 +1327,6 @@ via https.

1327

1328 See also the `ca` config.

1329

1685 -

1686 -

1687 -

1330 #### `tag`

1331

1332 * Default: "latest"

@@ -1699,9 +1341,6 @@ command, if no explicit tag is given.

1341 When used by the `npm diff` command, this is the tag used to fetch the

1342 tarball that will be compared with the local files by default.

1343

1702 -

1703 -

1704 -

1344 #### `tag-version-prefix`

1345

1346 * Default: "v"

@@ -1715,9 +1354,6 @@ Because other tools may rely on the convention that npm version tags look

1354 like `v1.0.0`, _only use this property if it is absolutely necessary_. In

1355 particular, use care when overriding this setting for public packages.

1356

1718 -

1719 -

1720 -

1357 #### `timing`

1358

1359 * Default: false

@@ -1730,9 +1366,6 @@ If true, writes a debug log to `logs-dir` and timing information to

1366 You can quickly view it with this [json](https://npm.im/json) command line:

1367 `npm exec -- json -g < ~/.npm/_timing.json`.

1368

1733 -

1734 -

1735 -

1369 #### `umask`

1370

1371 * Default: 0

@@ -1753,9 +1386,6 @@ Thus, the effective default umask value on most POSIX systems is 0o22,

1386 meaning that folders and executables are created with a mode of 0o755 and

1387 other files are created with a mode of 0o644.

1388

1756 -

1757 -

1758 -

1389 #### `unicode`

1390

1391 * Default: false on windows, true on mac/unix systems with a unicode locale,

@@ -1765,9 +1395,6 @@ other files are created with a mode of 0o644.

1395 When set to true, npm uses unicode characters in the tree output. When

1396 false, it uses ascii characters instead of unicode glyphs.

1397

1768 -

1769 -

1770 -

1398 #### `update-notifier`

1399

1400 * Default: true

@@ -1776,9 +1403,6 @@ false, it uses ascii characters instead of unicode glyphs.

1403 Set to false to suppress the update notification when using an older version

1404 of npm than the latest.

1405

1779 -

1780 -

1781 -

1406 #### `usage`

1407

1408 * Default: false

@@ -1786,9 +1410,6 @@ of npm than the latest.

1410

1411 Show short usage output about the command specified.

1412

1789 -

1790 -

1791 -

1413 #### `user-agent`

1414

1415 * Default: "npm/{npm-version} node/{node-version} {platform} {arch}

@@ -1807,9 +1428,6 @@ their actual counterparts:

1428 * `{ci}` - The value of the `ci-name` config, if set, prefixed with `ci/`, or

1429 an empty string if `ci-name` is empty.

1430

1810 -

1811 -

1812 -

1431 #### `userconfig`

1432

1433 * Default: "~/.npmrc"

@@ -1821,9 +1439,6 @@ This may be overridden by the `npm_config_userconfig` environment variable

1439 or the `--userconfig` command line option, but may _not_ be overridden by

1440 settings in the `globalconfig` file.

1441

1824 -

1825 -

1826 -

1442 #### `version`

1443

1444 * Default: false

@@ -1833,9 +1448,6 @@ If true, output the npm version and exit successfully.

1448

1449 Only relevant when specified explicitly on the command line.

1450

1836 -

1837 -

1838 -

1451 #### `versions`

1452

1453 * Default: false

@@ -1847,9 +1459,6 @@ exists, and exit successfully.

1459

1460 Only relevant when specified explicitly on the command line.

1461

1850 -

1851 -

1852 -

1462 #### `viewer`

1463

1464 * Default: "man" on Posix, "browser" on Windows

@@ -1859,9 +1468,6 @@ The program to use to view help content.

1468

1469 Set to `"browser"` to view html help content in the default web browser.

1470

1862 -

1863 -

1864 -

1471 #### `which`

1472

1473 * Default: null

@@ -1869,9 +1475,6 @@ Set to `"browser"` to view html help content in the default web browser.

1475

1476 If there are multiple funding sources, which 1-indexed source URL to open.

1477

1872 -

1873 -

1874 -

1478 #### `workspace`

1479

1480 * Default:

@@ -1894,9 +1497,6 @@ brand new workspace within the project.

1497

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

1499

1897 -

1898 -

1899 -

1500 #### `workspaces`

1501

1502 * Default: null

@@ -1915,9 +1515,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.

1515

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

1517

1918 -

1919 -

1920 -

1518 #### `workspaces-update`

1519

1520 * Default: true

@@ -1926,9 +1523,6 @@ This value is not exported to the environment for child processes.

1523 If set to true, the npm cli will run an update after operations that may

1524 possibly change the workspaces installed to the `node_modules` folder.

1525

1929 -

1930 -

1931 -

1526 #### `yes`

1527

1528 * Default: null

@@ -1937,9 +1531,6 @@ possibly change the workspaces installed to the `node_modules` folder.

1531 Automatically answer "yes" to any prompts that npm might print on the

1532 command line.

1533

1940 -

1941 -

1942 -

1534 #### `also`

1535

1536 * Default: null

@@ -1948,9 +1539,6 @@ command line.

1539

1540 When set to `dev` or `development`, this is an alias for `--include=dev`.

1541

1951 -

1952 -

1953 -

1542 #### `cache-max`

1543

1544 * Default: Infinity

@@ -1959,9 +1547,6 @@ When set to `dev` or `development`, this is an alias for `--include=dev`.

1547

1548 `--cache-max=0` is an alias for `--prefer-online`

1549

1962 -

1963 -

1964 -

1550 #### `cache-min`

1551

1552 * Default: 0

@@ -1970,9 +1555,6 @@ When set to `dev` or `development`, this is an alias for `--include=dev`.

1555

1556 `--cache-min=9999 (or bigger)` is an alias for `--prefer-offline`.

1557

1973 -

1974 -

1975 -

1558 #### `dev`

1559

1560 * Default: false

@@ -1981,9 +1563,6 @@ When set to `dev` or `development`, this is an alias for `--include=dev`.

1563

1564 Alias for `--include=dev`.

1565

1984 -

1985 -

1986 -

1566 #### `init.author.email`

1567

1568 * Default: ""

@@ -1992,9 +1571,6 @@ Alias for `--include=dev`.

1571

1572 Alias for `--init-author-email`

1573

1995 -

1996 -

1997 -

1574 #### `init.author.name`

1575

1576 * Default: ""

@@ -2003,9 +1579,6 @@ Alias for `--init-author-email`

1579

1580 Alias for `--init-author-name`

1581

2006 -

2007 -

2008 -

1582 #### `init.author.url`

1583

1584 * Default: ""

@@ -2014,9 +1587,6 @@ Alias for `--init-author-name`

1587

1588 Alias for `--init-author-url`

1589

2017 -

2018 -

2019 -

1590 #### `init.license`

1591

1592 * Default: "ISC"

@@ -2025,9 +1595,6 @@ Alias for `--init-author-url`

1595

1596 Alias for `--init-license`

1597

2028 -

2029 -

2030 -

1598 #### `init.module`

1599

1600 * Default: "~/.npm-init.js"

@@ -2036,9 +1603,6 @@ Alias for `--init-license`

1603

1604 Alias for `--init-module`

1605

2039 -

2040 -

2041 -

1606 #### `init.version`

1607

1608 * Default: "1.0.0"

@@ -2047,9 +1611,6 @@ Alias for `--init-module`

1611

1612 Alias for `--init-version`

1613

2050 -

2051 -

2052 -

1614 #### `only`

1615

1616 * Default: null

@@ -2058,9 +1619,6 @@ Alias for `--init-version`

1619

1620 When set to `prod` or `production`, this is an alias for `--omit=dev`.

1621

2061 -

2062 -

2063 -

1622 #### `optional`

1623

1624 * Default: null

@@ -2072,9 +1630,6 @@ Default value does install optional deps unless otherwise omitted.

1630

1631 Alias for --include=optional or --omit=optional

1632

2075 -

2076 -

2077 -

1633 #### `production`

1634

1635 * Default: null

@@ -2083,9 +1638,6 @@ Alias for --include=optional or --omit=optional

1638

1639 Alias for `--omit=dev`

1640

2086 -

2087 -

2088 -

1641 #### `shrinkwrap`

1642

1643 * Default: true

@@ -2094,9 +1646,6 @@ Alias for `--omit=dev`

1646

1647 Alias for --package-lock

1648

2097 -

2098 -

2099 -

1649 #### `sso-poll-frequency`

1650

1651 * Default: 500

@@ -2107,9 +1656,6 @@ Alias for --package-lock

1656 When used with SSO-enabled `auth-type`s, configures how regularly the

1657 registry should be polled while the user is completing authentication.

1658

2110 -

2111 -

2112 -

1659 #### `sso-type`

1660

1661 * Default: "oauth"

@@ -2119,9 +1665,6 @@ registry should be polled while the user is completing authentication.

1665

1666 If `--auth-type=sso`, the type of SSO type to use.

1667

2122 -

2123 -

2124 -

1668 #### `tmp`

1669

1670 * Default: The value returned by the Node.js `os.tmpdir()` method

@@ -2134,10 +1677,6 @@ If `--auth-type=sso`, the type of SSO type to use.

1677 Historically, the location where temporary files were stored. No longer

1678 relevant.

1679

2137 -

2138 -

2139 -

2140 -

1680 ### See also

1681

1682 * [npm config](/cli/v8/commands/npm-config)

content/cli/v8/using-npm/dependency-selectors.md

+1 -1

@@ -4,7 +4,7 @@ section: 7

4 description: Dependency Selector Syntax & Querying

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/using-npm/dependency-selectors.md

7 +github_path: docs/lib/content/using-npm/dependency-selectors.md

8 redirect_from:

9 - /cli-documentation/misc/dependency-selectors

10 - /cli-documentation/using-npm/dependency-selectors

content/cli/v8/using-npm/developers.md

+1 -1

@@ -4,7 +4,7 @@ section: 7

4 description: Developer Guide

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/using-npm/developers.md

7 +github_path: docs/lib/content/using-npm/developers.md

8 redirect_from:

9 - /cli-documentation/misc/developers

10 - /cli-documentation/using-npm/developers

content/cli/v8/using-npm/index.mdx

+1 -1

@@ -3,7 +3,7 @@ title: Using npm

3 shortName: Using

4 github_repo: npm/cli

5 github_branch: release/v8

6 -github_path: docs/nav.yml

6 +github_path: docs/lib/content/nav.yml

7 redirect_from:

8 - /cli-documentation/misc

9 - /cli-documentation/misc/index

content/cli/v8/using-npm/logging.md

+1 -1

@@ -4,7 +4,7 @@ section: 7

4 description: Why, What & How We Log

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/using-npm/logging.md

7 +github_path: docs/lib/content/using-npm/logging.md

8 redirect_from:

9 - /cli-documentation/misc/logging

10 - /cli-documentation/using-npm/logging

content/cli/v8/using-npm/orgs.md

+1 -1

@@ -4,7 +4,7 @@ section: 7

4 description: Working with Teams & Orgs

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/using-npm/orgs.md

7 +github_path: docs/lib/content/using-npm/orgs.md

8 redirect_from:

9 - /cli-documentation/misc/orgs

10 - /cli-documentation/using-npm/orgs

content/cli/v8/using-npm/package-spec.md

+1 -1

@@ -4,7 +4,7 @@ section: 7

4 description: Package name specifier

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/using-npm/package-spec.md

7 +github_path: docs/lib/content/using-npm/package-spec.md

8 redirect_from:

9 - /cli-documentation/misc/package-spec

10 - /cli-documentation/using-npm/package-spec

content/cli/v8/using-npm/registry.md

+1 -1

@@ -4,7 +4,7 @@ section: 7

4 description: The JavaScript Package Registry

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/using-npm/registry.md

7 +github_path: docs/lib/content/using-npm/registry.md

8 redirect_from:

9 - /cli-documentation/misc/registry

10 - /cli-documentation/using-npm/registry

content/cli/v8/using-npm/removal.md

+1 -1

@@ -4,7 +4,7 @@ section: 7

4 description: Cleaning the Slate

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/using-npm/removal.md

7 +github_path: docs/lib/content/using-npm/removal.md

8 redirect_from:

9 - /cli-documentation/misc/removal

10 - /cli-documentation/misc/removing-npm

content/cli/v8/using-npm/scope.md

+1 -1

@@ -4,7 +4,7 @@ section: 7

4 description: Scoped packages

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/using-npm/scope.md

7 +github_path: docs/lib/content/using-npm/scope.md

8 redirect_from:

9 - /cli-documentation/misc/npm-scope

10 - /cli-documentation/misc/scope

content/cli/v8/using-npm/scripts.md

+1 -1

@@ -4,7 +4,7 @@ section: 7

4 description: How npm handles the "scripts" field

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/using-npm/scripts.md

7 +github_path: docs/lib/content/using-npm/scripts.md

8 redirect_from:

9 - /cli-documentation/misc/scripts

10 - /cli-documentation/using-npm/scripts

content/cli/v8/using-npm/workspaces.md

+1 -1

@@ -4,7 +4,7 @@ section: 7

4 description: Working with workspaces

5 github_repo: npm/cli

6 github_branch: release/v8

7 -github_path: docs/content/using-npm/workspaces.md

7 +github_path: docs/lib/content/using-npm/workspaces.md

8 redirect_from:

9 - /cli-documentation/misc/workspaces

10 - /cli-documentation/using-npm/workspaces

src/theme/nav.yml

+1 -1

@@ -784,7 +784,7 @@

784 - title: Changelog

785 url: /cli/v7/using-npm/changelog

786 description: Changelog notes for each version

787 - - title: Version 8.19.2 (Latest Release)

787 + - title: Version 8.19.3 (Latest Release)

788 shortName: v8

789 url: /cli/v8

790 default: true