@cryptotaxi247 / documentation / commits / cfec7e1

CLI documentation update from CI

CI User committed Aug 20, 2021 at 02:25 UTC cfec7e138d0ef2c35beb8324631af19f6058444e

63 files changed +1314 -4

cli/v7

+1 -1

@@ -1 +1 @@

1 -Subproject commit 59b9851d1649b8f78203cae187b1337f2441219d

1 +Subproject commit 9b0c0344ed1109eaab4dcfade7e33f523ec8ff67

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

@@ -96,6 +96,7 @@ Management of teams and team memberships is done with the `npm team` command.

97

98

99 +

100 #### `registry`

101

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

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

104

105 The base URL of the npm registry.

106

107 +

108 +

109 +

110 #### `otp`

111

112 * Default: null

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

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

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

120

121 +

122 +

123 +

124

125

126 ### See Also

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

@@ -47,6 +47,7 @@ your existing record.

48

49

50 +

51 #### `registry`

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

@@ -54,6 +55,9 @@ your existing record.

56 The base URL of the npm registry.

58 +

59 +

60 +

61 #### `scope`

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

@@ -84,6 +88,9 @@ npm init --scope=@foo --yes

88 ```

91 +

92 +

93 +

94

96 ### See Also

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

+25

@@ -201,6 +201,7 @@ $ npm audit --audit-level=moderate

201

202

203

204 +

205 #### `audit-level`

206

207 * Default: null

@@ -209,6 +210,9 @@ $ npm audit --audit-level=moderate

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

211 exit code.

212

213 +

214 +

215 +

216 #### `dry-run`

217

218 * Default: false

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

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

227 `owner`, etc.

228

229 +

230 +

231 +

232 #### `force`

233

234 * Default: false

@@ -247,6 +254,9 @@ mistakes, unnecessary performance degradation, and malicious input.

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

255 recommended that you do not use this option!

256

257 +

258 +

259 +

260 #### `json`

261

262 * Default: false

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

269

270 Not supported by all npm commands.

271

272 +

273 +

274 +

275 #### `package-lock-only`

276

277 * Default: false

@@ -273,6 +286,9 @@ instead of checking `node_modules` and downloading dependencies.

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

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

288

289 +

290 +

291 +

292 #### `omit`

293

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

@@ -291,6 +307,9 @@ it will be included.

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

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

309

310 +

311 +

312 +

313 #### `workspace`

314

315 * Default:

@@ -313,6 +332,9 @@ brand new workspace within the project.

332

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

334

335 +

336 +

337 +

338 #### `workspaces`

339

340 * Default: false

@@ -323,6 +345,9 @@ workspaces.

345

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

347

348 +

349 +

350 +

351

352

353 ### See Also

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

@@ -30,6 +30,7 @@ Print the folder where npm will install executables.

31

32

33 +

34 #### `global`

36 * Default: false

@@ -44,6 +45,9 @@ folder instead of the current working directory. See

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

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

48 +

49 +

50 +

51

53 ### See Also

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

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

34

35

36 +

37 #### `browser`

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

@@ -45,6 +46,9 @@ terminal.

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

49 +

50 +

51 +

52 #### `registry`

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

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

57 The base URL of the npm registry.

59 +

60 +

61 +

62

64 ### See Also

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

@@ -87,6 +87,7 @@ verify`.

88

89

90 +

91 #### `cache`

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

@@ -95,6 +96,9 @@ verify`.

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

97 cache`](/cli/v7/commands/npm-cache)

99 +

100 +

101 +

102

103

104 ### See Also

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

+10

@@ -79,6 +79,7 @@ cache:

80

81

82 +

83 #### `audit`

85 * Default: true

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

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

91 submitted.

93 +

94 +

95 +

96 #### `ignore-scripts`

98 * Default: false

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

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

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

107

108 +

109 +

110 +

111 #### `script-shell`

112

113 * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows

@@ -109,6 +116,9 @@ will *not* run any pre- or post-scripts.

116 The shell to use for scripts run with the `npm exec`, `npm run` and `npm

117 init <pkg>` commands.

118

119 +

120 +

121 +

122

123

124 ### See Also

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

+16

@@ -107,6 +107,7 @@ global config.

107

108

109

110 +

111 #### `json`

112

113 * Default: false

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

120

121 Not supported by all npm commands.

122

123 +

124 +

125 +

126 #### `global`

127

128 * Default: false

@@ -133,6 +137,9 @@ 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

140 +

141 +

142 +

143 #### `editor`

144

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

@@ -141,6 +148,9 @@ folder instead of the current working directory. See

148

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

150

151 +

152 +

153 +

154 #### `location`

155

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

@@ -149,6 +159,9 @@ The command to run for `npm edit` and `npm config edit`.

159

160 When passed to `npm config` this refers to which config file to use.

161

162 +

163 +

164 +

165 #### `long`

166

167 * Default: false

@@ -156,6 +169,9 @@ When passed to `npm config` this refers to which config file to use.

169

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

171

172 +

173 +

174 +

175

176

177 ### See Also

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

+37

@@ -86,6 +86,7 @@ Using `npm find-dupes` will run the command in `--dry-run` mode.

87

88

89 +

90 #### `global-style`

92 * Default: false

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

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

100 will be preferred.

101

102 +

103 +

104 +

105 #### `legacy-bundling`

106

107 * Default: false

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

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

113 will be preferred.

114

115 +

116 +

117 +

118 #### `strict-peer-deps`

119

120 * Default: false

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

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

135 this warning is treated as a failure.

136

137 +

138 +

139 +

140 #### `package-lock`

141

142 * Default: true

@@ -139,6 +149,9 @@ When package package-locks are disabled, automatic pruning of extraneous

149 modules will also be disabled. To remove extraneous modules with

150 package-locks disabled use `npm prune`.

151

152 +

153 +

154 +

155 #### `omit`

156

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

@@ -157,6 +170,9 @@ it will be included.

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

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

172

173 +

174 +

175 +

176 #### `ignore-scripts`

177

178 * Default: false

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

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

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

187

188 +

189 +

190 +

191 #### `audit`

192

193 * Default: true

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

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

199 submitted.

200

201 +

202 +

203 +

204 #### `bin-links`

205

206 * Default: true

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

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

214 systems.

215

216 +

217 +

218 +

219 #### `fund`

220

221 * Default: true

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

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

226 fund`](/cli/v7/commands/npm-fund) for details.

227

228 +

229 +

230 +

231 #### `dry-run`

232

233 * Default: false

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

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

242 `owner`, etc.

243

244 +

245 +

246 +

247 #### `workspace`

248

249 * Default:

@@ -235,6 +266,9 @@ brand new workspace within the project.

266

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

268

269 +

270 +

271 +

272 #### `workspaces`

273

274 * Default: false

@@ -245,6 +279,9 @@ workspaces.

279

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

281

282 +

283 +

284 +

285

286

287 ### See Also

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

@@ -54,6 +54,7 @@ format an empty string.

55

56

57 +

58 #### `registry`

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

@@ -61,6 +62,9 @@ format an empty string.

63 The base URL of the npm registry.

65 +

66 +

67 +

68 #### `otp`

70 * Default: null

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

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

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

79 +

80 +

81 +

82

84 ### See Also

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

+37

@@ -165,6 +165,7 @@ located within the folder `./lib/` and changed lines of code within the

165

166

167

168 +

169 #### `diff`

170

171 * Default:

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

173

174 Define arguments to compare in `npm diff`.

175

176 +

177 +

178 +

179 #### `diff-name-only`

180

181 * Default: false

@@ -179,6 +183,9 @@ Define arguments to compare in `npm diff`.

183

184 Prints only filenames when using `npm diff`.

185

186 +

187 +

188 +

189 #### `diff-unified`

190

191 * Default: 3

@@ -186,6 +193,9 @@ Prints only filenames when using `npm diff`.

193

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

195

196 +

197 +

198 +

199 #### `diff-ignore-all-space`

200

201 * Default: false

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

203

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

205

206 +

207 +

208 +

209 #### `diff-no-prefix`

210

211 * Default: false

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

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

217 `--diff-dst-prefix` configs.

218

219 +

220 +

221 +

222 #### `diff-src-prefix`

223

224 * Default: "a/"

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

226

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

228

229 +

230 +

231 +

232 #### `diff-dst-prefix`

233

234 * Default: "b/"

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

236

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

238

239 +

240 +

241 +

242 #### `diff-text`

243

244 * Default: false

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

246

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

248

249 +

250 +

251 +

252 #### `global`

253

254 * Default: false

@@ -238,6 +263,9 @@ folder instead of the current working directory. See

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

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

265

266 +

267 +

268 +

269 #### `tag`

270

271 * Default: "latest"

@@ -252,6 +280,9 @@ command, if no explicit tag is given.

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

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

282

283 +

284 +

285 +

286 #### `workspace`

287

288 * Default:

@@ -274,6 +305,9 @@ brand new workspace within the project.

305

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

307

308 +

309 +

310 +

311 #### `workspaces`

312

313 * Default: false

@@ -284,6 +318,9 @@ workspaces.

318

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

320

321 +

322 +

323 +

324

325 ## See Also

326

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

@@ -102,6 +102,7 @@ not begin with a number or the letter `v`.

102

103

104

105 +

106 #### `workspace`

107

108 * Default:

@@ -124,6 +125,9 @@ brand new workspace within the project.

125

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

127

128 +

129 +

130 +

131 #### `workspaces`

132

133 * Default: false

@@ -134,6 +138,9 @@ workspaces.

138

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

140

141 +

142 +

143 +

144

145

146 ### See Also

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

+13

@@ -34,6 +34,7 @@ the `name` property.

35

36

37 +

38 #### `browser`

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

@@ -46,6 +47,9 @@ terminal.

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

50 +

51 +

52 +

53 #### `registry`

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

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

58 The base URL of the npm registry.

60 +

61 +

62 +

63 #### `workspace`

65 * Default:

@@ -75,6 +82,9 @@ brand new workspace within the project.

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

85 +

86 +

87 +

88 #### `workspaces`

90 * Default: false

@@ -85,6 +95,9 @@ workspaces.

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

98 +

99 +

100 +

101

102

103 ### See Also

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

@@ -116,6 +116,7 @@ reset the cache.

116

117

118

119 +

120 #### `registry`

121

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

@@ -123,6 +124,9 @@ reset the cache.

124

125 The base URL of the npm registry.

126

127 +

128 +

129 +

130

131

132 ### See Also

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

@@ -39,6 +39,7 @@ changes to your locally installed copy.

40

41

42 +

43 #### `editor`

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

@@ -47,6 +48,9 @@ changes to your locally installed copy.

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

51 +

52 +

53 +

54

56 ### See Also

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

+13

@@ -134,6 +134,7 @@ $ npm exec -- foo@latest bar --package=@npmcli/foo

134

135

136

137 +

138 #### `package`

139

140 * Default:

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

142

143 The package to install for [`npm exec`](/cli/v7/commands/npm-exec)

144

145 +

146 +

147 +

148 #### `call`

149

150 * Default: ""

@@ -154,6 +158,9 @@ npm exec --package yo --package generator-node --call "yo node"

158 ```

159

160

161 +

162 +

163 +

164 #### `workspace`

165

166 * Default:

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

183

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

185

186 +

187 +

188 +

189 #### `workspaces`

190

191 * Default: false

@@ -186,6 +196,9 @@ workspaces.

196

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

198

199 +

200 +

201 +

202

203

204 ### Examples

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

@@ -66,6 +66,7 @@ node_modules/nyc/node_modules/find-up

66 ### Configuration

67

68

69 +

70 #### `json`

72 * Default: false

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

80 Not supported by all npm commands.

82 +

83 +

84 +

85 #### `workspace`

87 * Default:

@@ -100,6 +104,9 @@ brand new workspace within the project.

104

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

106

107 +

108 +

109 +

110

111

112 ### See Also

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

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

44

45

46 +

47 #### `shell`

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

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

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

55 +

56 +

57 +

58

60 ### See Also

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

+34

@@ -29,6 +29,7 @@ duplications, without actually changing the package tree.

30

31

32 +

33 #### `global-style`

35 * Default: false

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

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

43 will be preferred.

45 +

46 +

47 +

48 #### `legacy-bundling`

50 * Default: false

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

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

56 will be preferred.

58 +

59 +

60 +

61 #### `strict-peer-deps`

63 * Default: false

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

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

78 this warning is treated as a failure.

80 +

81 +

82 +

83 #### `package-lock`

85 * Default: true

@@ -82,6 +92,9 @@ When package package-locks are disabled, automatic pruning of extraneous

92 modules will also be disabled. To remove extraneous modules with

93 package-locks disabled use `npm prune`.

95 +

96 +

97 +

98 #### `omit`

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

@@ -100,6 +113,9 @@ it will be included.

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

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

115

116 +

117 +

118 +

119 #### `ignore-scripts`

120

121 * Default: false

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

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

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

130

131 +

132 +

133 +

134 #### `audit`

135

136 * Default: true

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

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

142 submitted.

143

144 +

145 +

146 +

147 #### `bin-links`

148

149 * Default: true

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

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

157 systems.

158

159 +

160 +

161 +

162 #### `fund`

163

164 * Default: true

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

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

169 fund`](/cli/v7/commands/npm-fund) for details.

170

171 +

172 +

173 +

174 #### `workspace`

175

176 * Default:

@@ -165,6 +193,9 @@ brand new workspace within the project.

193

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

195

196 +

197 +

198 +

199 #### `workspaces`

200

201 * Default: false

@@ -175,6 +206,9 @@ workspaces.

206

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

208

209 +

210 +

211 +

212

213

214 ### See Also

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

+16

@@ -76,6 +76,7 @@ test-workspaces-fund@1.0.0

77

78

79 +

80 #### `json`

82 * Default: false

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

90 Not supported by all npm commands.

92 +

93 +

94 +

95 #### `browser`

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

@@ -100,6 +104,9 @@ terminal.

104

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

106

107 +

108 +

109 +

110 #### `unicode`

111

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

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

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

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

118

119 +

120 +

121 +

122 #### `workspace`

123

124 * Default:

@@ -131,6 +141,9 @@ brand new workspace within the project.

141

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

143

144 +

145 +

146 +

147 #### `which`

148

149 * Default: null

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

151

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

153

154 +

155 +

156 +

157

158

159 ## See Also

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

@@ -37,6 +37,7 @@ directly.

38

39

40 +

41 #### `long`

43 * Default: false

@@ -44,6 +45,9 @@ directly.

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

48 +

49 +

50 +

51

53 ### See Also

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

@@ -35,6 +35,7 @@ topic, so unique matches are equivalent to specifying a topic name.

36

37

38 +

39 #### `viewer`

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

@@ -44,6 +45,9 @@ The program to use to view help content.

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

48 +

49 +

50 +

51

53 ### See Also

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

@@ -97,6 +97,7 @@ $ npm hook rm id-deadbeef

98

99

100 +

101 #### `registry`

102

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

@@ -104,6 +105,9 @@ $ npm hook rm id-deadbeef

105

106 The base URL of the npm registry.

107

108 +

109 +

110 +

111 #### `otp`

112

113 * Default: null

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

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

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

121

122 +

123 +

124 +

125

126

127 ### See Also

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

+13

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

157

158

159

160 +

161 #### `yes`

162

163 * Default: null

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

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

167 command line.

168

169 +

170 +

171 +

172 #### `force`

173

174 * Default: false

@@ -190,6 +194,9 @@ mistakes, unnecessary performance degradation, and malicious input.

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

195 recommended that you do not use this option!

196

197 +

198 +

199 +

200 #### `workspace`

201

202 * Default:

@@ -212,6 +219,9 @@ brand new workspace within the project.

219

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

221

222 +

223 +

224 +

225 #### `workspaces`

226

227 * Default: false

@@ -222,6 +232,9 @@ workspaces.

232

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

234

235 +

236 +

237 +

238

239

240 ### See Also

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

+10

@@ -30,6 +30,7 @@ This command runs `npm ci` followed immediately by `npm test`.

31

32

33 +

34 #### `audit`

36 * Default: true

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

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

42 submitted.

44 +

45 +

46 +

47 #### `ignore-scripts`

49 * Default: false

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

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

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

59 +

60 +

61 +

62 #### `script-shell`

64 * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows

@@ -60,6 +67,9 @@ will *not* run any pre- or post-scripts.

67 The shell to use for scripts run with the `npm exec`, `npm run` and `npm

68 init <pkg>` commands.

70 +

71 +

72 +

73

75 ### See Also

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

+46

@@ -39,6 +39,7 @@ takes exactly the same arguments as `npm install`.

40

41

42 +

43 #### `save`

45 * Default: true

@@ -49,6 +50,9 @@ Save installed packages to a package.json file as dependencies.

50 When used with the `npm rm` command, removes the dependency from

51 package.json.

53 +

54 +

55 +

56 #### `save-exact`

58 * Default: false

@@ -57,6 +61,9 @@ package.json.

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

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

64 +

65 +

66 +

67 #### `global`

69 * Default: false

@@ -71,6 +78,9 @@ folder instead of the current working directory. See

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

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

81 +

82 +

83 +

84 #### `global-style`

86 * Default: false

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

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

94 will be preferred.

96 +

97 +

98 +

99 #### `legacy-bundling`

100

101 * Default: false

@@ -93,6 +106,9 @@ 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

109 +

110 +

111 +

112 #### `strict-peer-deps`

113

114 * Default: false

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

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

129 this warning is treated as a failure.

130

131 +

132 +

133 +

134 #### `package-lock`

135

136 * Default: true

@@ -124,6 +143,9 @@ When package package-locks are disabled, automatic pruning of extraneous

143 modules will also be disabled. To remove extraneous modules with

144 package-locks disabled use `npm prune`.

145

146 +

147 +

148 +

149 #### `omit`

150

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

@@ -142,6 +164,9 @@ it will be included.

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

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

166

167 +

168 +

169 +

170 #### `ignore-scripts`

171

172 * Default: false

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

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

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

181

182 +

183 +

184 +

185 #### `audit`

186

187 * Default: true

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

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

193 submitted.

194

195 +

196 +

197 +

198 #### `bin-links`

199

200 * Default: true

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

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

208 systems.

209

210 +

211 +

212 +

213 #### `fund`

214

215 * Default: true

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

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

220 fund`](/cli/v7/commands/npm-fund) for details.

221

222 +

223 +

224 +

225 #### `dry-run`

226

227 * Default: false

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

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

236 `owner`, etc.

237

238 +

239 +

240 +

241 #### `workspace`

242

243 * Default:

@@ -220,6 +260,9 @@ brand new workspace within the project.

260

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

262

263 +

264 +

265 +

266 #### `workspaces`

267

268 * Default: false

@@ -230,6 +273,9 @@ workspaces.

273

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

275

276 +

277 +

278 +

279

280

281 ### See Also

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

+46

@@ -424,6 +424,7 @@ These are some of the most common options related to installation.

424

425

426

427 +

428 #### `save`

429

430 * Default: true

@@ -434,6 +435,9 @@ Save installed packages to a package.json file as dependencies.

435 When used with the `npm rm` command, removes the dependency from

436 package.json.

437

438 +

439 +

440 +

441 #### `save-exact`

442

443 * Default: false

@@ -442,6 +446,9 @@ package.json.

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

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

448

449 +

450 +

451 +

452 #### `global`

453

454 * Default: false

@@ -456,6 +463,9 @@ folder instead of the current working directory. See

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

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

465

466 +

467 +

468 +

469 #### `global-style`

470

471 * Default: false

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

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

479 will be preferred.

480

481 +

482 +

483 +

484 #### `legacy-bundling`

485

486 * Default: false

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

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

492 will be preferred.

493

494 +

495 +

496 +

497 #### `strict-peer-deps`

498

499 * Default: false

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

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

514 this warning is treated as a failure.

515

516 +

517 +

518 +

519 #### `package-lock`

520

521 * Default: true

@@ -509,6 +528,9 @@ When package package-locks are disabled, automatic pruning of extraneous

528 modules will also be disabled. To remove extraneous modules with

529 package-locks disabled use `npm prune`.

530

531 +

532 +

533 +

534 #### `omit`

535

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

@@ -527,6 +549,9 @@ it will be included.

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

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

551

552 +

553 +

554 +

555 #### `ignore-scripts`

556

557 * Default: false

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

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

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

566

567 +

568 +

569 +

570 #### `audit`

571

572 * Default: true

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

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

578 submitted.

579

580 +

581 +

582 +

583 #### `bin-links`

584

585 * Default: true

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

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

593 systems.

594

595 +

596 +

597 +

598 #### `fund`

599

600 * Default: true

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

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

605 fund`](/cli/v7/commands/npm-fund) for details.

606

607 +

608 +

609 +

610 #### `dry-run`

611

612 * Default: false

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

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

621 `owner`, etc.

622

623 +

624 +

625 +

626 #### `workspace`

627

628 * Default:

@@ -605,6 +645,9 @@ brand new workspace within the project.

645

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

647

648 +

649 +

650 +

651 #### `workspaces`

652

653 * Default: false

@@ -615,6 +658,9 @@ workspaces.

658

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

660

661 +

662 +

663 +

664

665

666 ### Algorithm

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

+46

@@ -123,6 +123,7 @@ workspace(s).

123

124

125

126 +

127 #### `save`

128

129 * Default: true

@@ -133,6 +134,9 @@ Save installed packages to a package.json file as dependencies.

134 When used with the `npm rm` command, removes the dependency from

135 package.json.

136

137 +

138 +

139 +

140 #### `save-exact`

141

142 * Default: false

@@ -141,6 +145,9 @@ package.json.

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

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

147

148 +

149 +

150 +

151 #### `global`

152

153 * Default: false

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

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

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

164

165 +

166 +

167 +

168 #### `global-style`

169

170 * Default: false

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

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

178 will be preferred.

179

180 +

181 +

182 +

183 #### `legacy-bundling`

184

185 * Default: false

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

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

191 will be preferred.

192

193 +

194 +

195 +

196 #### `strict-peer-deps`

197

198 * Default: false

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

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

213 this warning is treated as a failure.

214

215 +

216 +

217 +

218 #### `package-lock`

219

220 * Default: true

@@ -208,6 +227,9 @@ When package package-locks are disabled, automatic pruning of extraneous

227 modules will also be disabled. To remove extraneous modules with

228 package-locks disabled use `npm prune`.

229

230 +

231 +

232 +

233 #### `omit`

234

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

@@ -226,6 +248,9 @@ it will be included.

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

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

250

251 +

252 +

253 +

254 #### `ignore-scripts`

255

256 * Default: false

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

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

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

265

266 +

267 +

268 +

269 #### `audit`

270

271 * Default: true

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

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

277 submitted.

278

279 +

280 +

281 +

282 #### `bin-links`

283

284 * Default: true

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

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

292 systems.

293

294 +

295 +

296 +

297 #### `fund`

298

299 * Default: true

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

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

304 fund`](/cli/v7/commands/npm-fund) for details.

305

306 +

307 +

308 +

309 #### `dry-run`

310

311 * Default: false

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

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

320 `owner`, etc.

321

322 +

323 +

324 +

325 #### `workspace`

326

327 * Default:

@@ -304,6 +344,9 @@ brand new workspace within the project.

344

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

346

347 +

348 +

349 +

350 #### `workspaces`

351

352 * Default: false

@@ -314,6 +357,9 @@ workspaces.

357

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

359

360 +

361 +

362 +

363

364

365 ### See Also

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

@@ -39,6 +39,7 @@ connected to that scope, if set.

40

41

42 +

43 #### `registry`

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

@@ -46,6 +47,9 @@ connected to that scope, if set.

48 The base URL of the npm registry.

50 +

51 +

52 +

53 #### `scope`

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

@@ -76,6 +80,9 @@ npm init --scope=@foo --yes

80 ```

83 +

84 +

85 +

86

88 ### See Also

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

+37

@@ -85,6 +85,7 @@ least the default human-readable `npm ls` output in npm v8.

86

87

88 +

89 #### `all`

91 * Default: false

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

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

96 upon by the current project.

98 +

99 +

100 +

101 #### `json`

102

103 * Default: false

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

110

111 Not supported by all npm commands.

112

113 +

114 +

115 +

116 #### `long`

117

118 * Default: false

@@ -113,6 +120,9 @@ Not supported by all npm commands.

120

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

122

123 +

124 +

125 +

126 #### `parseable`

127

128 * Default: false

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

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

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

133

134 +

135 +

136 +

137 #### `global`

138

139 * Default: false

@@ -135,6 +148,9 @@ folder instead of the current working directory. See

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

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

150

151 +

152 +

153 +

154 #### `depth`

155

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

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

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

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

163

164 +

165 +

166 +

167 #### `omit`

168

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

@@ -163,6 +182,9 @@ 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

185 +

186 +

187 +

188 #### `link`

189

190 * Default: false

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

192

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

194

195 +

196 +

197 +

198 #### `package-lock-only`

199

200 * Default: false

@@ -184,6 +209,9 @@ instead of checking `node_modules` and downloading dependencies.

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

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

211

212 +

213 +

214 +

215 #### `unicode`

216

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

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

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

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

223

224 +

225 +

226 +

227 #### `workspace`

228

229 * Default:

@@ -215,6 +246,9 @@ brand new workspace within the project.

246

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

248

249 +

250 +

251 +

252 #### `workspaces`

253

254 * Default: false

@@ -225,6 +259,9 @@ workspaces.

259

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

261

262 +

263 +

264 +

265

266

267 ### See Also

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

+13

@@ -72,6 +72,7 @@ listing them, and finding specific ones and their roles.

73

74

75 +

76 #### `registry`

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

@@ -79,6 +80,9 @@ listing them, and finding specific ones and their roles.

81 The base URL of the npm registry.

83 +

84 +

85 +

86 #### `otp`

88 * Default: null

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

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

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

97 +

98 +

99 +

100 #### `json`

101

102 * Default: false

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

109

110 Not supported by all npm commands.

111

112 +

113 +

114 +

115 #### `parseable`

116

117 * Default: false

@@ -110,6 +120,9 @@ Not supported by all npm commands.

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

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

122

123 +

124 +

125 +

126

127

128 ### See Also

content/cli/v7/commands/npm-outdated.md

+19

@@ -98,6 +98,7 @@ A few things to note:

99

100

101 +

102 #### `all`

103

104 * Default: false

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

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

109 upon by the current project.

110

111 +

112 +

113 +

114 #### `json`

115

116 * Default: false

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

123

124 Not supported by all npm commands.

125

126 +

127 +

128 +

129 #### `long`

130

131 * Default: false

@@ -126,6 +133,9 @@ Not supported by all npm commands.

133

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

135

136 +

137 +

138 +

139 #### `parseable`

140

141 * Default: false

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

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

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

146

147 +

148 +

149 +

150 #### `global`

151

152 * Default: false

@@ -148,6 +161,9 @@ folder instead of the current working directory. See

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

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

163

164 +

165 +

166 +

167 #### `workspace`

168

169 * Default:

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

186

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

188

189 +

190 +

191 +

192

193

194 ### See Also

content/cli/v7/commands/npm-owner.md

@@ -49,6 +49,7 @@ on the command line when changing ownership with `--otp`.

50

51

52 +

53 #### `registry`

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

@@ -56,6 +57,9 @@ on the command line when changing ownership with `--otp`.

58 The base URL of the npm registry.

60 +

61 +

62 +

63 #### `otp`

65 * Default: null

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

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

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

74 +

75 +

76 +

77

79 ### See Also

content/cli/v7/commands/npm-pack.md

+16

@@ -24,6 +24,7 @@ npm pack [[<@scope>/]<pkg>...] [--dry-run] [--json]

25

26

27 +

28 #### `dry-run`

30 * Default: false

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

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

39 `owner`, etc.

41 +

42 +

43 +

44 #### `json`

46 * Default: false

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

54 Not supported by all npm commands.

56 +

57 +

58 +

59 #### `pack-destination`

61 * Default: "."

@@ -56,6 +63,9 @@ Not supported by all npm commands.

64 Directory in which `npm pack` will save tarballs.

66 +

67 +

68 +

69 #### `workspace`

71 * Default:

@@ -78,6 +88,9 @@ brand new workspace within the project.

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

91 +

92 +

93 +

94 #### `workspaces`

96 * Default: false

@@ -88,6 +101,9 @@ workspaces.

101

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

103

104 +

105 +

106 +

107

108

109 ### Description

content/cli/v7/commands/npm-ping.md

@@ -39,6 +39,7 @@ Ping error: {*Detail about error}

40

41

42 +

43 #### `registry`

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

@@ -46,6 +47,9 @@ Ping error: {*Detail about error}

48 The base URL of the npm registry.

50 +

51 +

52 +

53

55 ### See Also

content/cli/v7/commands/npm-pkg.md

+13

@@ -176,6 +176,7 @@ npm pkg get name version --ws

176

177

178

179 +

180 #### `force`

181

182 * Default: false

@@ -201,6 +202,9 @@ mistakes, unnecessary performance degradation, and malicious input.

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

203 recommended that you do not use this option!

204

205 +

206 +

207 +

208 #### `json`

209

210 * Default: false

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

217

218 Not supported by all npm commands.

219

220 +

221 +

222 +

223 #### `workspace`

224

225 * Default:

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

242

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

244

245 +

246 +

247 +

248 #### `workspaces`

249

250 * Default: false

@@ -245,6 +255,9 @@ workspaces.

255

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

257

258 +

259 +

260 +

261

262 ## See Also

263

content/cli/v7/commands/npm-prefix.md

@@ -47,6 +47,7 @@ npm prefix -g

48

49

50 +

51 #### `global`

53 * Default: false

@@ -61,6 +62,9 @@ folder instead of the current working directory. See

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

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

65 +

66 +

67 +

68

70 ### See Also

content/cli/v7/commands/npm-profile.md

+13

@@ -87,6 +87,7 @@ Some of these commands may not be available on non npmjs.com registries.

88

89

90 +

91 #### `registry`

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

@@ -94,6 +95,9 @@ Some of these commands may not be available on non npmjs.com registries.

96 The base URL of the npm registry.

98 +

99 +

100 +

101 #### `json`

102

103 * Default: false

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

110

111 Not supported by all npm commands.

112

113 +

114 +

115 +

116 #### `parseable`

117

118 * Default: false

@@ -114,6 +121,9 @@ Not supported by all npm commands.

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

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

123

124 +

125 +

126 +

127 #### `otp`

128

129 * Default: null

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

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

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

137

138 +

139 +

140 +

141

142

143 ### See Also

content/cli/v7/commands/npm-prune.md

+16

@@ -47,6 +47,7 @@ this command can help clean up any resulting garbage.

48

49

50 +

51 #### `omit`

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

@@ -65,6 +66,9 @@ it will be included.

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

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

69 +

70 +

71 +

72 #### `dry-run`

74 * Default: false

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

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

83 `owner`, etc.

85 +

86 +

87 +

88 #### `json`

90 * Default: false

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

98 Not supported by all npm commands.

100 +

101 +

102 +

103 #### `workspace`

104

105 * Default:

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

122

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

124

125 +

126 +

127 +

128 #### `workspaces`

129

130 * Default: false

@@ -122,6 +135,9 @@ workspaces.

135

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

137

138 +

139 +

140 +

141

142

143 ### See Also

content/cli/v7/commands/npm-publish.md

+23 -3

@@ -118,6 +118,7 @@ built.

118

119

120

121 +

122 #### `tag`

123

124 * Default: "latest"

@@ -132,6 +133,9 @@ command, if no explicit tag is given.

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

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

135

136 +

137 +

138 +

139 #### `access`

140

141 * Default: 'restricted' for scoped packages, 'public' for unscoped packages

@@ -143,9 +147,13 @@ set `--access=public`. The only valid values for `access` are `public` and

147 `restricted`. Unscoped packages _always_ have an access level of `public`.

148

149 Note: Using the `--access` flag on the `npm publish` command will only set

146 -the package access level on the initial publish of the package. Any subsequent `npm publish`

147 -commands using the `--access` flag will not have an effect to the access level.

148 -To make changes to the access level after the initial publish use `npm access`.

150 +the package access level on the initial publish of the package. Any

151 +subsequent `npm publish` commands using the `--access` flag will not have an

152 +effect to the access level. To make changes to the access level after the

153 +initial publish use `npm access`.

154 +

155 +

156 +

157

158 #### `dry-run`

159

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

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

169 `owner`, etc.

170

171 +

172 +

173 +

174 #### `otp`

175

176 * Default: null

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

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

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

184

185 +

186 +

187 +

188 #### `workspace`

189

190 * Default:

@@ -193,6 +207,9 @@ brand new workspace within the project.

207

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

209

210 +

211 +

212 +

213 #### `workspaces`

214

215 * Default: false

@@ -203,6 +220,9 @@ workspaces.

220

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

222

223 +

224 +

225 +

226

227

228 ### See Also

content/cli/v7/commands/npm-rebuild.md

+16

@@ -38,6 +38,7 @@ will be rebuilt.

39

40

41 +

42 #### `global`

44 * Default: false

@@ -52,6 +53,9 @@ folder instead of the current working directory. See

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

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

56 +

57 +

58 +

59 #### `bin-links`

61 * Default: true

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

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

69 systems.

71 +

72 +

73 +

74 #### `ignore-scripts`

76 * Default: false

@@ -76,6 +83,9 @@ 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.

86 +

87 +

88 +

89 #### `workspace`

91 * Default:

@@ -98,6 +108,9 @@ brand new workspace within the project.

108

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

110

111 +

112 +

113 +

114 #### `workspaces`

115

116 * Default: false

@@ -108,6 +121,9 @@ workspaces.

121

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

123

124 +

125 +

126 +

127

128

129 ### See Also

content/cli/v7/commands/npm-repo.md

+10

@@ -31,6 +31,7 @@ in the current folder and use the `repository` property.

32

33

34 +

35 #### `browser`

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

@@ -43,6 +44,9 @@ terminal.

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

47 +

48 +

49 +

50 #### `workspace`

52 * Default:

@@ -65,6 +69,9 @@ brand new workspace within the project.

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

72 +

73 +

74 +

75 #### `workspaces`

77 * Default: false

@@ -75,6 +82,9 @@ workspaces.

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

85 +

86 +

87 +

88

90 ### See Also

content/cli/v7/commands/npm-restart.md

@@ -48,6 +48,7 @@ If it does _not_ have a `"restart"` script specified, but it does have

49

50

51 +

52 #### `ignore-scripts`

54 * Default: false

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

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

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

64 +

65 +

66 +

67 #### `script-shell`

69 * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows

@@ -68,6 +72,9 @@ will *not* run any pre- or post-scripts.

72 The shell to use for scripts run with the `npm exec`, `npm run` and `npm

73 init <pkg>` commands.

75 +

76 +

77 +

78

80 ### See Also

content/cli/v7/commands/npm-root.md

@@ -37,6 +37,7 @@ echo "Global packages installed in: ${global_node_modules}"

38

39

40 +

41 #### `global`

43 * Default: false

@@ -51,6 +52,9 @@ folder instead of the current working directory. See

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

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

55 +

56 +

57 +

58

60 ### See Also

content/cli/v7/commands/npm-run-script.md

+16

@@ -148,6 +148,7 @@ packages.

148

149

150

151 +

152 #### `workspace`

153

154 * Default:

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

171

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

173

174 +

175 +

176 +

177 #### `workspaces`

178

179 * Default: false

@@ -180,6 +184,9 @@ workspaces.

184

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

186

187 +

188 +

189 +

190 #### `if-present`

191

192 * Default: false

@@ -192,6 +199,9 @@ it's present and fail if the script fails. This is useful, for example, when

199 running scripts that may only apply for some builds in an otherwise generic

200 CI setup.

201

202 +

203 +

204 +

205 #### `ignore-scripts`

206

207 * Default: false

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

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

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

216

217 +

218 +

219 +

220 #### `script-shell`

221

222 * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows

@@ -212,6 +225,9 @@ will *not* run any pre- or post-scripts.

225 The shell to use for scripts run with the `npm exec`, `npm run` and `npm

226 init <pkg>` commands.

227

228 +

229 +

230 +

231

232

233 ### See Also

content/cli/v7/commands/npm-search.md

+34

@@ -51,6 +51,7 @@ expression characters in most shells.)

52

53

54 +

55 #### `long`

57 * Default: false

@@ -58,6 +59,9 @@ expression characters in most shells.)

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

62 +

63 +

64 +

65 #### `json`

67 * Default: false

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

75 Not supported by all npm commands.

77 +

78 +

79 +

80 #### `color`

82 * Default: true unless the NO_COLOR environ is set to something other than '0'

@@ -78,6 +85,9 @@ Not supported by all npm commands.

85 If false, never shows colors. If `"always"` then always shows colors. If

86 true, then only prints color codes for tty file descriptors.

88 +

89 +

90 +

91 #### `parseable`

93 * Default: false

@@ -86,6 +96,9 @@ true, then only prints color codes for tty file descriptors.

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

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

99 +

100 +

101 +

102 #### `description`

103

104 * Default: true

@@ -93,6 +106,9 @@ Output parseable results from commands that write to standard output. For

106

107 Show the description in `npm search`

108

109 +

110 +

111 +

112 #### `searchopts`

113

114 * Default: ""

@@ -100,6 +116,9 @@ Show the description in `npm search`

116

117 Space-separated options that are always passed to search.

118

119 +

120 +

121 +

122 #### `searchexclude`

123

124 * Default: ""

@@ -107,6 +126,9 @@ Space-separated options that are always passed to search.

126

127 Space-separated options that limit the results from search.

128

129 +

130 +

131 +

132 #### `registry`

133

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

@@ -114,6 +136,9 @@ Space-separated options that limit the results from search.

136

137 The base URL of the npm registry.

138

139 +

140 +

141 +

142 #### `prefer-online`

143

144 * Default: false

@@ -122,6 +147,9 @@ The base URL of the npm registry.

147 If true, staleness checks for cached data will be forced, making the CLI

148 look for updates immediately even for fresh package data.

149

150 +

151 +

152 +

153 #### `prefer-offline`

154

155 * Default: false

@@ -131,6 +159,9 @@ If true, staleness checks for cached data will be bypassed, but missing data

159 will be requested from the server. To force full offline mode, use

160 `--offline`.

161

162 +

163 +

164 +

165 #### `offline`

166

167 * Default: false

@@ -139,6 +170,9 @@ will be requested from the server. To force full offline mode, use

170 Force offline mode: no network requests will be done during install. To

171 allow the CLI to fill in missing cache data, see `--prefer-offline`.

172

173 +

174 +

175 +

176

177

178 ### See Also

content/cli/v7/commands/npm-set-script.md

@@ -40,6 +40,7 @@ npm set-script [<script>] [<command>]

41

42

43 +

44 #### `workspace`

46 * Default:

@@ -62,6 +63,9 @@ brand new workspace within the project.

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

66 +

67 +

68 +

69 #### `workspaces`

71 * Default: false

@@ -72,6 +76,9 @@ workspaces.

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

79 +

80 +

81 +

82

84 ### See Also

content/cli/v7/commands/npm-star.md

@@ -47,6 +47,7 @@ You can see all your starred packages using [`npm stars`](/cli/v7/commands/npm-s

48

49

50 +

51 #### `registry`

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

@@ -54,6 +55,9 @@ You can see all your starred packages using [`npm stars`](/cli/v7/commands/npm-s

56 The base URL of the npm registry.

58 +

59 +

60 +

61 #### `unicode`

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

@@ -63,6 +67,9 @@ The base URL of the npm registry.

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

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

70 +

71 +

72 +

73

75 ### See Also

content/cli/v7/commands/npm-stars.md

@@ -33,6 +33,7 @@ you will most certainly enjoy this command.

34

35

36 +

37 #### `registry`

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

@@ -40,6 +41,9 @@ you will most certainly enjoy this command.

42 The base URL of the npm registry.

44 +

45 +

46 +

47

49 ### See Also

content/cli/v7/commands/npm-start.md

@@ -59,6 +59,7 @@ npm start

60

61

62 +

63 #### `ignore-scripts`

65 * Default: false

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

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

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

75 +

76 +

77 +

78 #### `script-shell`

80 * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows

@@ -79,6 +83,9 @@ will *not* run any pre- or post-scripts.

83 The shell to use for scripts run with the `npm exec`, `npm run` and `npm

84 init <pkg>` commands.

86 +

87 +

88 +

89

91 ### See Also

content/cli/v7/commands/npm-stop.md

@@ -52,6 +52,7 @@ npm stop

53

54

55 +

56 #### `ignore-scripts`

58 * Default: false

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

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

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

68 +

69 +

70 +

71 #### `script-shell`

73 * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows

@@ -72,6 +76,9 @@ will *not* run any pre- or post-scripts.

76 The shell to use for scripts run with the `npm exec`, `npm run` and `npm

77 init <pkg>` commands.

79 +

80 +

81 +

82

84 ### See Also

content/cli/v7/commands/npm-team.md

+13

@@ -115,6 +115,7 @@ use the `npm access` command to grant or revoke the appropriate permissions.

115

116

117

118 +

119 #### `registry`

120

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

@@ -122,6 +123,9 @@ use the `npm access` command to grant or revoke the appropriate permissions.

123

124 The base URL of the npm registry.

125

126 +

127 +

128 +

129 #### `otp`

130

131 * Default: null

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

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

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

139

140 +

141 +

142 +

143 #### `parseable`

144

145 * Default: false

@@ -141,6 +148,9 @@ password, npm will prompt on the command line for one.

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

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

150

151 +

152 +

153 +

154 #### `json`

155

156 * Default: false

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

163

164 Not supported by all npm commands.

165

166 +

167 +

168 +

169

170

171 ### See Also

content/cli/v7/commands/npm-test.md

@@ -49,6 +49,7 @@ npm test

50

51

52 +

53 #### `ignore-scripts`

55 * Default: false

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

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

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

65 +

66 +

67 +

68 #### `script-shell`

70 * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows

@@ -69,6 +73,9 @@ will *not* run any pre- or post-scripts.

73 The shell to use for scripts run with the `npm exec`, `npm run` and `npm

74 init <pkg>` commands.

76 +

77 +

78 +

79

81 ### See Also

content/cli/v7/commands/npm-token.md

+13

@@ -88,6 +88,7 @@ This lets you list, create and revoke authentication tokens.

89

90

91 +

92 #### `read-only`

94 * Default: false

@@ -96,6 +97,9 @@ This lets you list, create and revoke authentication tokens.

97 This is used to mark a token as unable to publish when configuring limited

98 access tokens with the `npm token create` command.

100 +

101 +

102 +

103 #### `cidr`

104

105 * Default: null

@@ -104,6 +108,9 @@ access tokens with the `npm token create` command.

108 This is a list of CIDR address to be used when configuring limited access

109 tokens with the `npm token create` command.

110

111 +

112 +

113 +

114 #### `registry`

115

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

@@ -111,6 +118,9 @@ tokens with the `npm token create` command.

118

119 The base URL of the npm registry.

120

121 +

122 +

123 +

124 #### `otp`

125

126 * Default: null

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

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

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

134

135 +

136 +

137 +

138

139

140 ### See Also

content/cli/v7/commands/npm-uninstall.md

+10

@@ -68,6 +68,7 @@ npm uninstall lodash --no-save

69

70

71 +

72 #### `save`

74 * Default: true

@@ -78,6 +79,9 @@ Save installed packages to a package.json file as dependencies.

79 When used with the `npm rm` command, removes the dependency from

80 package.json.

82 +

83 +

84 +

85 #### `workspace`

87 * Default:

@@ -100,6 +104,9 @@ brand new workspace within the project.

104

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

106

107 +

108 +

109 +

110 #### `workspaces`

111

112 * Default: false

@@ -110,6 +117,9 @@ workspaces.

117

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

119

120 +

121 +

122 +

123

124

125 ### See Also

content/cli/v7/commands/npm-unpublish.md

+13

@@ -59,6 +59,7 @@ passed.

60

61

62 +

63 #### `dry-run`

65 * Default: false

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

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

74 `owner`, etc.

76 +

77 +

78 +

79 #### `force`

81 * Default: false

@@ -97,6 +101,9 @@ mistakes, unnecessary performance degradation, and malicious input.

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

102 recommended that you do not use this option!

103

104 +

105 +

106 +

107 #### `workspace`

108

109 * Default:

@@ -119,6 +126,9 @@ brand new workspace within the project.

126

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

128

129 +

130 +

131 +

132 #### `workspaces`

133

134 * Default: false

@@ -129,6 +139,9 @@ workspaces.

139

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

141

142 +

143 +

144 +

145

146

147 ### See Also

content/cli/v7/commands/npm-unstar.md

+10

@@ -43,6 +43,7 @@ You can see all your starred packages using [`npm stars`](/cli/v7/commands/npm-s

44

45

46 +

47 #### `registry`

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

@@ -50,6 +51,9 @@ You can see all your starred packages using [`npm stars`](/cli/v7/commands/npm-s

52 The base URL of the npm registry.

54 +

55 +

56 +

57 #### `unicode`

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

@@ -59,6 +63,9 @@ The base URL of the npm registry.

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

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

66 +

67 +

68 +

69 #### `otp`

71 * Default: null

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

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

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

80 +

81 +

82 +

83

85 ### See Also

content/cli/v7/commands/npm-update.md

+40

@@ -163,6 +163,7 @@ be _downgraded_.

163

164

165

166 +

167 #### `global`

168

169 * Default: false

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

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

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

180

181 +

182 +

183 +

184 #### `global-style`

185

186 * Default: false

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

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

194 will be preferred.

195

196 +

197 +

198 +

199 #### `legacy-bundling`

200

201 * Default: false

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

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

207 will be preferred.

208

209 +

210 +

211 +

212 #### `strict-peer-deps`

213

214 * Default: false

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

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

229 this warning is treated as a failure.

230

231 +

232 +

233 +

234 #### `package-lock`

235

236 * Default: true

@@ -230,6 +243,9 @@ When package package-locks are disabled, automatic pruning of extraneous

243 modules will also be disabled. To remove extraneous modules with

244 package-locks disabled use `npm prune`.

245

246 +

247 +

248 +

249 #### `omit`

250

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

@@ -248,6 +264,9 @@ it will be included.

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

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

266

267 +

268 +

269 +

270 #### `ignore-scripts`

271

272 * Default: false

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

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

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

281

282 +

283 +

284 +

285 #### `audit`

286

287 * Default: true

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

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

293 submitted.

294

295 +

296 +

297 +

298 #### `bin-links`

299

300 * Default: true

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

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

308 systems.

309

310 +

311 +

312 +

313 #### `fund`

314

315 * Default: true

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

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

320 fund`](/cli/v7/commands/npm-fund) for details.

321

322 +

323 +

324 +

325 #### `dry-run`

326

327 * Default: false

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

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

336 `owner`, etc.

337

338 +

339 +

340 +

341 #### `workspace`

342

343 * Default:

@@ -326,6 +360,9 @@ brand new workspace within the project.

360

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

362

363 +

364 +

365 +

366 #### `workspaces`

367

368 * Default: false

@@ -336,6 +373,9 @@ workspaces.

373

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

375

376 +

377 +

378 +

379

380

381 ### See Also

content/cli/v7/commands/npm-version.md

+25

29

30

31 +

32 #### `allow-same-version`

34 * Default: false

37 Prevents throwing an error when `npm version` is used to set the new version

38 to the same value as the current version.

40 +

41 +

42 +

43 #### `commit-hooks`

45 * Default: true

@@ -43,6 +47,9 @@ to the same value as the current version.

48 Run git commit hooks when using the `npm version` command.

50 +

51 +

52 +

53 #### `git-tag-version`

55 * Default: true

@@ -50,6 +57,9 @@ Run git commit hooks when using the `npm version` command.

58 Tag the commit when using the `npm version` command.

60 +

61 +

62 +

63 #### `json`

65 * Default: false

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

73 Not supported by all npm commands.

75 +

76 +

77 +

78 #### `preid`

80 * Default: ""

@@ -70,6 +83,9 @@ Not supported by all npm commands.

83 The "prerelease identifier" to use as a prefix for the "prerelease" part of

84 a semver. Like the `rc` in `1.2.0-rc.8`.

86 +

87 +

88 +

89 #### `sign-git-tag`

91 * Default: false

@@ -81,6 +97,9 @@ If set to true, then the `npm version` command will tag the version using

97 Note that git requires you to have set up GPG keys in your git configs for

98 this to work properly.

100 +

101 +

102 +

103 #### `workspace`

104

105 * Default:

@@ -103,6 +122,9 @@ brand new workspace within the project.

122

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

124

125 +

126 +

127 +

128 #### `workspaces`

129

130 * Default: false

@@ -113,6 +135,9 @@ workspaces.

135

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

137

138 +

139 +

140 +

141

142

143 ### Description

content/cli/v7/commands/npm-view.md

+10

@@ -108,6 +108,7 @@ npm view connect versions

108

109

110

111 +

112 #### `json`

113

114 * Default: false

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

121

122 Not supported by all npm commands.

123

124 +

125 +

126 +

127 #### `workspace`

128

129 * Default:

@@ -142,6 +146,9 @@ brand new workspace within the project.

146

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

148

149 +

150 +

151 +

152 #### `workspaces`

153

154 * Default: false

@@ -152,6 +159,9 @@ workspaces.

159

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

161

162 +

163 +

164 +

165

166

167 ### Output

content/cli/v7/commands/npm-whoami.md

@@ -37,6 +37,7 @@ If logged into a registry that uses Basic Auth, then simply print the

38

39

40 +

41 #### `registry`

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

@@ -44,6 +45,9 @@ If logged into a registry that uses Basic Auth, then simply print the

46 The base URL of the npm registry.

48 +

49 +

50 +

51

53 ### See Also

content/cli/v7/using-npm/config.md

+438

@@ -69,6 +69,7 @@ The following shorthands are parsed on the command-line:

70

71

72 +

73 * `-a`: `--all`

74 * `--enjoy-by`: `--before`

75 * `-c`: `--call`

@@ -109,6 +110,8 @@ The following shorthands are parsed on the command-line:

110 * `--ws`: `--workspaces`

111 * `-y`: `--yes`

112

113 +

114 +

115

116

117 If the specified configuration param resolves unambiguously to a known

@@ -136,6 +139,7 @@ npm ls --global --parseable --long --loglevel info

139

140

141

142 +

143 #### `_auth`

144

145 * Default: null

@@ -147,6 +151,9 @@ Warning: This should generally not be set via a command-line option. It is

151 safer to use a registry-provided authentication bearer token stored in the

152 ~/.npmrc file by running `npm login`.

153

154 +

155 +

156 +

157 #### `access`

158

159 * Default: 'restricted' for scoped packages, 'public' for unscoped packages

@@ -157,6 +164,15 @@ If you want your scoped package to be publicly viewable (and installable)

164 set `--access=public`. The only valid values for `access` are `public` and

165 `restricted`. Unscoped packages _always_ have an access level of `public`.

166

167 +Note: Using the `--access` flag on the `npm publish` command will only set

168 +the package access level on the initial publish of the package. Any

169 +subsequent `npm publish` commands using the `--access` flag will not have an

170 +effect to the access level. To make changes to the access level after the

171 +initial publish use `npm access`.

172 +

173 +

174 +

175 +

176 #### `all`

177

178 * Default: false

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

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

183 upon by the current project.

184

185 +

186 +

187 +

188 #### `allow-same-version`

189

190 * Default: false

@@ -174,6 +193,9 @@ upon by the current project.

193 Prevents throwing an error when `npm version` is used to set the new version

194 to the same value as the current version.

195

196 +

197 +

198 +

199 #### `audit`

200

201 * Default: true

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

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

207 submitted.

208

209 +

210 +

211 +

212 #### `audit-level`

213

214 * Default: null

@@ -192,6 +217,9 @@ submitted.

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

218 exit code.

219

220 +

221 +

222 +

223 #### `before`

224

225 * Default: null

@@ -207,6 +235,9 @@ If the requested version is a `dist-tag` and the given tag does not pass the

235 will be used. For example, `foo@latest` might install `foo@1.2` even though

236 `latest` is `2.0`.

237

238 +

239 +

240 +

241 #### `bin-links`

242

243 * Default: true

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

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

251 systems.

252

253 +

254 +

255 +

256 #### `browser`

257

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

@@ -231,6 +265,9 @@ terminal.

265

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

267

268 +

269 +

270 +

271 #### `ca`

272

273 * Default: null

@@ -257,6 +294,9 @@ ca[]="..."

294

295 See also the `strict-ssl` config.

296

297 +

298 +

299 +

300 #### `cache`

301

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

@@ -265,6 +305,9 @@ See also the `strict-ssl` config.

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

306 cache`](/cli/v7/commands/npm-cache)

307

308 +

309 +

310 +

311 #### `cafile`

312

313 * Default: null

@@ -274,6 +317,9 @@ A path to a file containing one or multiple Certificate Authority signing

317 certificates. Similar to the `ca` setting, but allows for multiple CA's, as

318 well as for the CA information to be stored in a file on disk.

319

320 +

321 +

322 +

323 #### `call`

324

325 * Default: ""

@@ -287,6 +333,9 @@ npm exec --package yo --package generator-node --call "yo node"

333 ```

334

335

336 +

337 +

338 +

339 #### `cert`

340

341 * Default: null

@@ -303,6 +352,9 @@ cert="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"

352 It is _not_ the path to a certificate file (and there is no "certfile"

353 option).

354

355 +

356 +

357 +

358 #### `ci-name`

359

360 * Default: The name of the current CI system, or `null` when not on a known CI

@@ -313,6 +365,9 @@ The name of a continuous integration system. If not set explicitly, npm will

365 detect the current CI environment using the

366 [`@npmcli/ci-detect`](http://npm.im/@npmcli/ci-detect) module.

367

368 +

369 +

370 +

371 #### `cidr`

372

373 * Default: null

@@ -321,6 +376,9 @@ detect the current CI environment using the

376 This is a list of CIDR address to be used when configuring limited access

377 tokens with the `npm token create` command.

378

379 +

380 +

381 +

382 #### `color`

383

384 * Default: true unless the NO_COLOR environ is set to something other than '0'

@@ -329,6 +387,9 @@ tokens with the `npm token create` command.

387 If false, never shows colors. If `"always"` then always shows colors. If

388 true, then only prints color codes for tty file descriptors.

389

390 +

391 +

392 +

393 #### `commit-hooks`

394

395 * Default: true

@@ -336,6 +397,9 @@ true, then only prints color codes for tty file descriptors.

397

398 Run git commit hooks when using the `npm version` command.

399

400 +

401 +

402 +

403 #### `depth`

404

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

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

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

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

412

413 +

414 +

415 +

416 #### `description`

417

418 * Default: true

@@ -353,6 +420,9 @@ project. If `--all` is set, then npm will show all dependencies by default.

420

421 Show the description in `npm search`

422

423 +

424 +

425 +

426 #### `diff`

427

428 * Default:

@@ -360,6 +430,9 @@ Show the description in `npm search`

430

431 Define arguments to compare in `npm diff`.

432

433 +

434 +

435 +

436 #### `diff-dst-prefix`

437

438 * Default: "b/"

@@ -367,6 +440,9 @@ Define arguments to compare in `npm diff`.

440

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

442

443 +

444 +

445 +

446 #### `diff-ignore-all-space`

447

448 * Default: false

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

450

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

452

453 +

454 +

455 +

456 #### `diff-name-only`

457

458 * Default: false

@@ -381,6 +460,9 @@ Ignore whitespace when comparing lines in `npm diff`.

460

461 Prints only filenames when using `npm diff`.

462

463 +

464 +

465 +

466 #### `diff-no-prefix`

467

468 * Default: false

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

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

474 `--diff-dst-prefix` configs.

475

476 +

477 +

478 +

479 #### `diff-src-prefix`

480

481 * Default: "a/"

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

483

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

485

486 +

487 +

488 +

489 #### `diff-text`

490

491 * Default: false

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

493

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

495

496 +

497 +

498 +

499 #### `diff-unified`

500

501 * Default: 3

@@ -412,6 +503,9 @@ Treat all files as text in `npm diff`.

503

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

505

506 +

507 +

508 +

509 #### `dry-run`

510

511 * Default: false

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

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

520 `owner`, etc.

521

522 +

523 +

524 +

525 #### `editor`

526

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

@@ -433,6 +530,9 @@ Note: This is NOT honored by other network related commands, eg `dist-tags`,

530

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

532

533 +

534 +

535 +

536 #### `engine-strict`

537

538 * Default: false

@@ -444,6 +544,9 @@ Node.js version.

544

545 This can be overridden by setting the `--force` flag.

546

547 +

548 +

549 +

550 #### `fetch-retries`

551

552 * Default: 2

@@ -455,6 +558,9 @@ from the registry.

558 npm will retry idempotent read requests to the registry in the case of

559 network failures or 5xx HTTP errors.

560

561 +

562 +

563 +

564 #### `fetch-retry-factor`

565

566 * Default: 10

@@ -462,6 +568,9 @@ network failures or 5xx HTTP errors.

568

569 The "factor" config for the `retry` module to use when fetching packages.

570

571 +

572 +

573 +

574 #### `fetch-retry-maxtimeout`

575

576 * Default: 60000 (1 minute)

@@ -470,6 +579,9 @@ The "factor" config for the `retry` module to use when fetching packages.

579 The "maxTimeout" config for the `retry` module to use when fetching

580 packages.

581

582 +

583 +

584 +

585 #### `fetch-retry-mintimeout`

586

587 * Default: 10000 (10 seconds)

@@ -478,6 +590,9 @@ packages.

590 The "minTimeout" config for the `retry` module to use when fetching

591 packages.

592

593 +

594 +

595 +

596 #### `fetch-timeout`

597

598 * Default: 300000 (5 minutes)

@@ -485,6 +600,9 @@ packages.

600

601 The maximum amount of time to wait for HTTP requests to complete.

602

603 +

604 +

605 +

606 #### `force`

607

608 * Default: false

@@ -510,6 +628,9 @@ mistakes, unnecessary performance degradation, and malicious input.

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

629 recommended that you do not use this option!

630

631 +

632 +

633 +

634 #### `foreground-scripts`

635

636 * Default: false

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

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

644 but can be useful for debugging.

645

646 +

647 +

648 +

649 #### `format-package-lock`

650

651 * Default: true

@@ -530,6 +654,9 @@ but can be useful for debugging.

654 Format `package-lock.json` or `npm-shrinkwrap.json` as a human readable

655 file.

656

657 +

658 +

659 +

660 #### `fund`

661

662 * Default: true

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

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

667 fund`](/cli/v7/commands/npm-fund) for details.

668

669 +

670 +

671 +

672 #### `git`

673

674 * Default: "git"

@@ -547,6 +677,9 @@ fund`](/cli/v7/commands/npm-fund) for details.

677 The command to use for git commands. If git is installed on the computer,

678 but is not in the `PATH`, then set this to the full path to the git binary.

679

680 +

681 +

682 +

683 #### `git-tag-version`

684

685 * Default: true

@@ -554,6 +687,9 @@ but is not in the `PATH`, then set this to the full path to the git binary.

687

688 Tag the commit when using the `npm version` command.

689

690 +

691 +

692 +

693 #### `global`

694

695 * Default: false

@@ -568,6 +704,9 @@ folder instead of the current working directory. See

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

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

706

707 +

708 +

709 +

710 #### `global-style`

711

712 * Default: false

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

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

720 will be preferred.

721

722 +

723 +

724 +

725 #### `globalconfig`

726

727 * Default: The global --prefix setting plus 'etc/npmrc'. For example,

@@ -588,6 +730,9 @@ will be preferred.

730

731 The config file to read for global config options.

732

733 +

734 +

735 +

736 #### `heading`

737

738 * Default: "npm"

@@ -595,6 +740,9 @@ The config file to read for global config options.

740

741 The string that starts all the debugging log output.

742

743 +

744 +

745 +

746 #### `https-proxy`

747

748 * Default: null

@@ -605,6 +753,9 @@ A proxy to use for outgoing https requests. If the `HTTPS_PROXY` or

753 proxy settings will be honored by the underlying `make-fetch-happen`

754 library.

755

756 +

757 +

758 +

759 #### `if-present`

760

761 * Default: false

@@ -617,6 +768,9 @@ it's present and fail if the script fails. This is useful, for example, when

768 running scripts that may only apply for some builds in an otherwise generic

769 CI setup.

770

771 +

772 +

773 +

774 #### `ignore-scripts`

775

776 * Default: false

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

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

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

785

786 +

787 +

788 +

789 #### `include`

790

791 * Default:

@@ -641,6 +798,9 @@ This is the inverse of `--omit=<type>`.

798 Dependency types specified in `--include` will not be omitted, regardless of

799 the order in which omit/include are specified on the command-line.

800

801 +

802 +

803 +

804 #### `include-staged`

805

806 * Default: false

@@ -651,6 +811,9 @@ Allow installing "staged" published packages, as defined by [npm RFC PR

811

812 This is experimental, and not implemented by the npm public registry.

813

814 +

815 +

816 +

817 #### `init-author-email`

818

819 * Default: ""

@@ -658,6 +821,9 @@ This is experimental, and not implemented by the npm public registry.

821

822 The value `npm init` should use by default for the package author's email.

823

824 +

825 +

826 +

827 #### `init-author-name`

828

829 * Default: ""

@@ -665,6 +831,9 @@ The value `npm init` should use by default for the package author's email.

831

832 The value `npm init` should use by default for the package author's name.

833

834 +

835 +

836 +

837 #### `init-author-url`

838

839 * Default: ""

@@ -673,6 +842,9 @@ The value `npm init` should use by default for the package author's name.

842 The value `npm init` should use by default for the package author's

843 homepage.

844

845 +

846 +

847 +

848 #### `init-license`

849

850 * Default: "ISC"

@@ -680,6 +852,9 @@ homepage.

852

853 The value `npm init` should use by default for the package license.

854

855 +

856 +

857 +

858 #### `init-module`

859

860 * Default: "~/.npm-init.js"

@@ -690,6 +865,9 @@ documentation for the

865 [init-package-json](https://github.com/npm/init-package-json) module for

866 more information, or [npm init](/cli/v7/commands/npm-init).

867

868 +

869 +

870 +

871 #### `init-version`

872

873 * Default: "1.0.0"

@@ -698,6 +876,9 @@ more information, or [npm init](/cli/v7/commands/npm-init).

876 The value that `npm init` should use by default for the package version

877 number, if not already set in package.json.

878

879 +

880 +

881 +

882 #### `json`

883

884 * Default: false

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

891

892 Not supported by all npm commands.

893

894 +

895 +

896 +

897 #### `key`

898

899 * Default: null

@@ -724,6 +908,9 @@ key="-----BEGIN PRIVATE KEY-----\nXXXX\nXXXX\n-----END PRIVATE KEY-----"

908

909 It is _not_ the path to a key file (and there is no "keyfile" option).

910

911 +

912 +

913 +

914 #### `legacy-bundling`

915

916 * Default: false

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

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

922 will be preferred.

923

924 +

925 +

926 +

927 #### `legacy-peer-deps`

928

929 * Default: false

@@ -752,6 +942,9 @@ This differs from `--omit=peer`, in that `--omit=peer` will avoid unpacking

942 Use of `legacy-peer-deps` is not recommended, as it will not enforce the

943 `peerDependencies` contract that meta-dependencies may rely on.

944

945 +

946 +

947 +

948 #### `link`

949

950 * Default: false

@@ -759,6 +952,9 @@ Use of `legacy-peer-deps` is not recommended, as it will not enforce the

952

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

954

955 +

956 +

957 +

958 #### `local-address`

959

960 * Default: null

@@ -767,6 +963,9 @@ Used with `npm ls`, limiting output to only those packages that are linked.

963 The IP address of the local interface to use when making connections to the

964 npm registry. Must be IPv4 in versions of Node prior to 0.12.

965

966 +

967 +

968 +

969 #### `location`

970

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

@@ -775,6 +974,9 @@ npm registry. Must be IPv4 in versions of Node prior to 0.12.

974

975 When passed to `npm config` this refers to which config file to use.

976

977 +

978 +

979 +

980 #### `loglevel`

981

982 * Default: "notice"

@@ -789,6 +991,9 @@ Any logs of a higher level than the setting are shown. The default is

991

992 See also the `foreground-scripts` config.

993

994 +

995 +

996 +

997 #### `logs-max`

998

999 * Default: 10

@@ -796,6 +1001,9 @@ See also the `foreground-scripts` config.

1001

1002 The maximum number of log files to store.

1003

1004 +

1005 +

1006 +

1007 #### `long`

1008

1009 * Default: false

@@ -803,6 +1011,9 @@ The maximum number of log files to store.

1011

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

1013

1014 +

1015 +

1016 +

1017 #### `maxsockets`

1018

1019 * Default: 15

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

1022 The maximum number of connections to use per origin (protocol/host/port

1023 combination).

1024

1025 +

1026 +

1027 +

1028 #### `message`

1029

1030 * Default: "%s"

@@ -820,6 +1034,9 @@ Commit message which is used by `npm version` when creating version commit.

1034

1035 Any "%s" in the message will be replaced with the version number.

1036

1037 +

1038 +

1039 +

1040 #### `node-options`

1041

1042 * Default: null

@@ -829,6 +1046,9 @@ Options to pass through to Node.js via the `NODE_OPTIONS` environment

1046 variable. This does not impact how npm itself is executed but it does impact

1047 how lifecycle scripts are called.

1048

1049 +

1050 +

1051 +

1052 #### `node-version`

1053

1054 * Default: Node.js `process.version` value

@@ -836,6 +1056,9 @@ how lifecycle scripts are called.

1056

1057 The node version to use when checking a package's `engines` setting.

1058

1059 +

1060 +

1061 +

1062 #### `noproxy`

1063

1064 * Default: The value of the NO_PROXY environment variable

@@ -845,6 +1068,9 @@ Domain extensions that should bypass any proxies.

1068

1069 Also accepts a comma-delimited string.

1070

1071 +

1072 +

1073 +

1074 #### `npm-version`

1075

1076 * Default: Output of `npm --version`

@@ -852,6 +1078,9 @@ Also accepts a comma-delimited string.

1078

1079 The npm version to use when checking a package's `engines` setting.

1080

1081 +

1082 +

1083 +

1084 #### `offline`

1085

1086 * Default: false

@@ -860,6 +1089,9 @@ The npm version to use when checking a package's `engines` setting.

1089 Force offline mode: no network requests will be done during install. To

1090 allow the CLI to fill in missing cache data, see `--prefer-offline`.

1091

1092 +

1093 +

1094 +

1095 #### `omit`

1096

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

@@ -878,6 +1110,9 @@ it will be included.

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

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

1112

1113 +

1114 +

1115 +

1116 #### `otp`

1117

1118 * Default: null

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

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

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

1126

1127 +

1128 +

1129 +

1130 #### `pack-destination`

1131

1132 * Default: "."

@@ -896,6 +1134,9 @@ password, npm will prompt on the command line for one.

1134

1135 Directory in which `npm pack` will save tarballs.

1136

1137 +

1138 +

1139 +

1140 #### `package`

1141

1142 * Default:

@@ -903,6 +1144,9 @@ Directory in which `npm pack` will save tarballs.

1144

1145 The package to install for [`npm exec`](/cli/v7/commands/npm-exec)

1146

1147 +

1148 +

1149 +

1150 #### `package-lock`

1151

1152 * Default: true

@@ -915,6 +1159,9 @@ When package package-locks are disabled, automatic pruning of extraneous

1159 modules will also be disabled. To remove extraneous modules with

1160 package-locks disabled use `npm prune`.

1161

1162 +

1163 +

1164 +

1165 #### `package-lock-only`

1166

1167 * Default: false

@@ -929,6 +1176,9 @@ instead of checking `node_modules` and downloading dependencies.

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

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

1178

1179 +

1180 +

1181 +

1182 #### `parseable`

1183

1184 * Default: false

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

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

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

1189

1190 +

1191 +

1192 +

1193 #### `prefer-offline`

1194

1195 * Default: false

@@ -946,6 +1199,9 @@ If true, staleness checks for cached data will be bypassed, but missing data

1199 will be requested from the server. To force full offline mode, use

1200 `--offline`.

1201

1202 +

1203 +

1204 +

1205 #### `prefer-online`

1206

1207 * Default: false

@@ -954,6 +1210,9 @@ will be requested from the server. To force full offline mode, use

1210 If true, staleness checks for cached data will be forced, making the CLI

1211 look for updates immediately even for fresh package data.

1212

1213 +

1214 +

1215 +

1216 #### `prefix`

1217

1218 * Default: In global mode, the folder where the node executable is installed.

@@ -964,6 +1223,9 @@ look for updates immediately even for fresh package data.

1223 The location to install global items. If set on the command line, then it

1224 forces non-global commands to run in the specified folder.

1225

1226 +

1227 +

1228 +

1229 #### `preid`

1230

1231 * Default: ""

@@ -972,6 +1234,9 @@ forces non-global commands to run in the specified folder.

1234 The "prerelease identifier" to use as a prefix for the "prerelease" part of

1235 a semver. Like the `rc` in `1.2.0-rc.8`.

1236

1237 +

1238 +

1239 +

1240 #### `progress`

1241

1242 * Default: `true` unless running in a known CI system

@@ -982,6 +1247,9 @@ operations, if `process.stderr` is a TTY.

1247

1248 Set to `false` to suppress the progress bar.

1249

1250 +

1251 +

1252 +

1253 #### `proxy`

1254

1255 * Default: null

@@ -991,6 +1259,9 @@ A proxy to use for outgoing http requests. If the `HTTP_PROXY` or

1259 `http_proxy` environment variables are set, proxy settings will be honored

1260 by the underlying `request` library.

1261

1262 +

1263 +

1264 +

1265 #### `read-only`

1266

1267 * Default: false

@@ -999,6 +1270,9 @@ by the underlying `request` library.

1270 This is used to mark a token as unable to publish when configuring limited

1271 access tokens with the `npm token create` command.

1272

1273 +

1274 +

1275 +

1276 #### `rebuild-bundle`

1277

1278 * Default: true

@@ -1006,6 +1280,9 @@ access tokens with the `npm token create` command.

1280

1281 Rebuild bundled dependencies after installation.

1282

1283 +

1284 +

1285 +

1286 #### `registry`

1287

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

@@ -1013,6 +1290,9 @@ Rebuild bundled dependencies after installation.

1290

1291 The base URL of the npm registry.

1292

1293 +

1294 +

1295 +

1296 #### `save`

1297

1298 * Default: true

@@ -1023,6 +1303,9 @@ Save installed packages to a package.json file as dependencies.

1303 When used with the `npm rm` command, removes the dependency from

1304 package.json.

1305

1306 +

1307 +

1308 +

1309 #### `save-bundle`

1310

1311 * Default: false

@@ -1034,6 +1317,9 @@ If a package would be saved at install time by the use of `--save`,

1317

1318 Ignore if `--save-peer` is set, since peerDependencies cannot be bundled.

1319

1320 +

1321 +

1322 +

1323 #### `save-dev`

1324

1325 * Default: false

@@ -1041,6 +1327,9 @@ Ignore if `--save-peer` is set, since peerDependencies cannot be bundled.

1327

1328 Save installed packages to a package.json file as `devDependencies`.

1329

1330 +

1331 +

1332 +

1333 #### `save-exact`

1334

1335 * Default: false

@@ -1049,6 +1338,9 @@ Save installed packages to a package.json file as `devDependencies`.

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

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

1340

1341 +

1342 +

1343 +

1344 #### `save-optional`

1345

1346 * Default: false

@@ -1056,6 +1348,9 @@ rather than using npm's default semver range operator.

1348

1349 Save installed packages to a package.json file as `optionalDependencies`.

1350

1351 +

1352 +

1353 +

1354 #### `save-peer`

1355

1356 * Default: false

@@ -1063,6 +1358,9 @@ Save installed packages to a package.json file as `optionalDependencies`.

1358

1359 Save installed packages. to a package.json file as `peerDependencies`

1360

1361 +

1362 +

1363 +

1364 #### `save-prefix`

1365

1366 * Default: "^"

@@ -1076,6 +1374,9 @@ to `^1.2.3` which allows minor upgrades for that package, but after `npm

1374 config set save-prefix='~'` it would be set to `~1.2.3` which only allows

1375 patch upgrades.

1376

1377 +

1378 +

1379 +

1380 #### `save-prod`

1381

1382 * Default: false

@@ -1088,6 +1389,9 @@ you want to move it to be a non-optional production dependency.

1389 This is the default behavior if `--save` is true, and neither `--save-dev`

1390 or `--save-optional` are true.

1391

1392 +

1393 +

1394 +

1395 #### `scope`

1396

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

@@ -1118,6 +1422,9 @@ npm init --scope=@foo --yes

1422 ```

1423

1424

1425 +

1426 +

1427 +

1428 #### `script-shell`

1429

1430 * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows

@@ -1126,6 +1433,9 @@ npm init --scope=@foo --yes

1433 The shell to use for scripts run with the `npm exec`, `npm run` and `npm

1434 init <pkg>` commands.

1435

1436 +

1437 +

1438 +

1439 #### `searchexclude`

1440

1441 * Default: ""

@@ -1133,6 +1443,9 @@ init <pkg>` commands.

1443

1444 Space-separated options that limit the results from search.

1445

1446 +

1447 +

1448 +

1449 #### `searchlimit`

1450

1451 * Default: 20

@@ -1141,6 +1454,9 @@ Space-separated options that limit the results from search.

1454 Number of items to limit search results to. Will not apply at all to legacy

1455 searches.

1456

1457 +

1458 +

1459 +

1460 #### `searchopts`

1461

1462 * Default: ""

@@ -1148,6 +1464,9 @@ searches.

1464

1465 Space-separated options that are always passed to search.

1466

1467 +

1468 +

1469 +

1470 #### `searchstaleness`

1471

1472 * Default: 900

@@ -1156,6 +1475,9 @@ Space-separated options that are always passed to search.

1475 The age of the cache, in seconds, before another registry request is made if

1476 using legacy search endpoint.

1477

1478 +

1479 +

1480 +

1481 #### `shell`

1482

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

@@ -1164,6 +1486,9 @@ using legacy search endpoint.

1486

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

1488

1489 +

1490 +

1491 +

1492 #### `sign-git-commit`

1493

1494 * Default: false

@@ -1175,6 +1500,9 @@ version using `-S` to add a signature.

1500 Note that git requires you to have set up GPG keys in your git configs for

1501 this to work properly.

1502

1503 +

1504 +

1505 +

1506 #### `sign-git-tag`

1507

1508 * Default: false

@@ -1186,6 +1514,9 @@ If set to true, then the `npm version` command will tag the version using

1514 Note that git requires you to have set up GPG keys in your git configs for

1515 this to work properly.

1516

1517 +

1518 +

1519 +

1520 #### `strict-peer-deps`

1521

1522 * Default: false

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

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

1537 this warning is treated as a failure.

1538

1539 +

1540 +

1541 +

1542 #### `strict-ssl`

1543

1544 * Default: true

@@ -1215,6 +1549,9 @@ via https.

1549

1550 See also the `ca` config.

1551

1552 +

1553 +

1554 +

1555 #### `tag`

1556

1557 * Default: "latest"

@@ -1229,6 +1566,9 @@ command, if no explicit tag is given.

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

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

1568

1569 +

1570 +

1571 +

1572 #### `tag-version-prefix`

1573

1574 * Default: "v"

@@ -1242,6 +1582,9 @@ Because other tools may rely on the convention that npm version tags look

1582 like `v1.0.0`, _only use this property if it is absolutely necessary_. In

1583 particular, use care when overriding this setting for public packages.

1584

1585 +

1586 +

1587 +

1588 #### `timing`

1589

1590 * Default: false

@@ -1254,6 +1597,9 @@ successfully. `_timing.json` is a newline delimited list of JSON objects.

1597 You can quickly view it with this [json](https://npm.im/json) command line:

1598 `npm exec -- json -g < ~/.npm/_timing.json`.

1599

1600 +

1601 +

1602 +

1603 #### `umask`

1604

1605 * Default: 0

@@ -1274,6 +1620,9 @@ Thus, the effective default umask value on most POSIX systems is 0o22,

1620 meaning that folders and executables are created with a mode of 0o755 and

1621 other files are created with a mode of 0o644.

1622

1623 +

1624 +

1625 +

1626 #### `unicode`

1627

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

@@ -1283,6 +1632,9 @@ other files are created with a mode of 0o644.

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

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

1634

1635 +

1636 +

1637 +

1638 #### `update-notifier`

1639

1640 * Default: true

@@ -1291,6 +1643,9 @@ false, it uses ascii characters instead of unicode glyphs.

1643 Set to false to suppress the update notification when using an older version

1644 of npm than the latest.

1645

1646 +

1647 +

1648 +

1649 #### `usage`

1650

1651 * Default: false

@@ -1298,6 +1653,9 @@ of npm than the latest.

1653

1654 Show short usage output about the command specified.

1655

1656 +

1657 +

1658 +

1659 #### `user-agent`

1660

1661 * Default: "npm/{npm-version} node/{node-version} {platform} {arch}

@@ -1316,6 +1674,9 @@ their actual counterparts:

1674 * `{ci}` - The value of the `ci-name` config, if set, prefixed with `ci/`, or

1675 an empty string if `ci-name` is empty.

1676

1677 +

1678 +

1679 +

1680 #### `userconfig`

1681

1682 * Default: "~/.npmrc"

@@ -1327,6 +1688,9 @@ This may be overridden by the `npm_config_userconfig` environment variable

1688 or the `--userconfig` command line option, but may _not_ be overridden by

1689 settings in the `globalconfig` file.

1690

1691 +

1692 +

1693 +

1694 #### `version`

1695

1696 * Default: false

@@ -1336,6 +1700,9 @@ If true, output the npm version and exit successfully.

1700

1701 Only relevant when specified explicitly on the command line.

1702

1703 +

1704 +

1705 +

1706 #### `versions`

1707

1708 * Default: false

@@ -1347,6 +1714,9 @@ exists, and exit successfully.

1714

1715 Only relevant when specified explicitly on the command line.

1716

1717 +

1718 +

1719 +

1720 #### `viewer`

1721

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

@@ -1356,6 +1726,9 @@ The program to use to view help content.

1726

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

1728

1729 +

1730 +

1731 +

1732 #### `which`

1733

1734 * Default: null

@@ -1363,6 +1736,9 @@ Set to `"browser"` to view html help content in the default web browser.

1736

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

1738

1739 +

1740 +

1741 +

1742 #### `workspace`

1743

1744 * Default:

@@ -1385,6 +1761,9 @@ brand new workspace within the project.

1761

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

1763

1764 +

1765 +

1766 +

1767 #### `workspaces`

1768

1769 * Default: false

@@ -1395,6 +1774,9 @@ workspaces.

1774

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

1776

1777 +

1778 +

1779 +

1780 #### `yes`

1781

1782 * Default: null

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

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

1786 command line.

1787

1788 +

1789 +

1790 +

1791 #### `also`

1792

1793 * Default: null

@@ -1411,6 +1796,9 @@ command line.

1796

1797 When set to `dev` or `development`, this is an alias for `--include=dev`.

1798

1799 +

1800 +

1801 +

1802 #### `auth-type`

1803

1804 * Default: "legacy"

@@ -1420,6 +1808,9 @@ When set to `dev` or `development`, this is an alias for `--include=dev`.

1808

1809 What authentication strategy to use with `adduser`/`login`.

1810

1811 +

1812 +

1813 +

1814 #### `cache-max`

1815

1816 * Default: Infinity

@@ -1428,6 +1819,9 @@ What authentication strategy to use with `adduser`/`login`.

1819

1820 `--cache-max=0` is an alias for `--prefer-online`

1821

1822 +

1823 +

1824 +

1825 #### `cache-min`

1826

1827 * Default: 0

@@ -1436,6 +1830,9 @@ What authentication strategy to use with `adduser`/`login`.

1830

1831 `--cache-min=9999 (or bigger)` is an alias for `--prefer-offline`.

1832

1833 +

1834 +

1835 +

1836 #### `dev`

1837

1838 * Default: false

@@ -1444,6 +1841,9 @@ What authentication strategy to use with `adduser`/`login`.

1841

1842 Alias for `--include=dev`.

1843

1844 +

1845 +

1846 +

1847 #### `init.author.email`

1848

1849 * Default: ""

@@ -1452,6 +1852,9 @@ Alias for `--include=dev`.

1852

1853 Alias for `--init-author-email`

1854

1855 +

1856 +

1857 +

1858 #### `init.author.name`

1859

1860 * Default: ""

@@ -1460,6 +1863,9 @@ Alias for `--init-author-email`

1863

1864 Alias for `--init-author-name`

1865

1866 +

1867 +

1868 +

1869 #### `init.author.url`

1870

1871 * Default: ""

@@ -1468,6 +1874,9 @@ Alias for `--init-author-name`

1874

1875 Alias for `--init-author-url`

1876

1877 +

1878 +

1879 +

1880 #### `init.license`

1881

1882 * Default: "ISC"

@@ -1476,6 +1885,9 @@ Alias for `--init-author-url`

1885

1886 Alias for `--init-license`

1887

1888 +

1889 +

1890 +

1891 #### `init.module`

1892

1893 * Default: "~/.npm-init.js"

@@ -1484,6 +1896,9 @@ Alias for `--init-license`

1896

1897 Alias for `--init-module`

1898

1899 +

1900 +

1901 +

1902 #### `init.version`

1903

1904 * Default: "1.0.0"

@@ -1492,6 +1907,9 @@ Alias for `--init-module`

1907

1908 Alias for `--init-version`

1909

1910 +

1911 +

1912 +

1913 #### `only`

1914

1915 * Default: null

@@ -1500,6 +1918,9 @@ Alias for `--init-version`

1918

1919 When set to `prod` or `production`, this is an alias for `--omit=dev`.

1920

1921 +

1922 +

1923 +

1924 #### `optional`

1925

1926 * Default: null

@@ -1511,6 +1932,9 @@ Default value does install optional deps unless otherwise omitted.

1932

1933 Alias for --include=optional or --omit=optional

1934

1935 +

1936 +

1937 +

1938 #### `production`

1939

1940 * Default: null

@@ -1519,6 +1943,9 @@ Alias for --include=optional or --omit=optional

1943

1944 Alias for `--omit=dev`

1945

1946 +

1947 +

1948 +

1949 #### `shrinkwrap`

1950

1951 * Default: true

@@ -1527,6 +1954,9 @@ Alias for `--omit=dev`

1954

1955 Alias for --package-lock

1956

1957 +

1958 +

1959 +

1960 #### `sso-poll-frequency`

1961

1962 * Default: 500

@@ -1537,6 +1967,9 @@ Alias for --package-lock

1967 When used with SSO-enabled `auth-type`s, configures how regularly the

1968 registry should be polled while the user is completing authentication.

1969

1970 +

1971 +

1972 +

1973 #### `sso-type`

1974

1975 * Default: "oauth"

@@ -1546,6 +1979,9 @@ registry should be polled while the user is completing authentication.

1979

1980 If `--auth-type=sso`, the type of SSO type to use.

1981

1982 +

1983 +

1984 +

1985 #### `tmp`

1986

1987 * Default: The value returned by the Node.js `os.tmpdir()` method

@@ -1558,6 +1994,8 @@ If `--auth-type=sso`, the type of SSO type to use.

1994 Historically, the location where temporary files were stored. No longer

1995 relevant.

1996

1997 +

1998 +

1999

2000

2001 ### See also