@cryptotaxi247 / documentation-1 / commits / d477c0b

CLI documentation update from CI

CI User committed Feb 25, 2022 at 02:28 UTC d477c0bf6f6091fb18b69cd299c81ab9ba14f5c0
66 files changed +743 -147
cli/v8
+1 -1
@@ -1 +1 @@
1 -Subproject commit dd63e21a0e192f5a7e797d6c89595fd09dbfd7b9
1 +Subproject commit 2db3eff44d7bb86b956207cc63d279806fd14ed0
content/cli/v8/commands/npm-access.md
+9 -3
@@ -17,21 +17,27 @@ github_path: docs/content/commands/npm-access.md
17
18 ### Synopsis
19
20 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
21 +<!-- automatically generated, do not edit manually -->
22 +<!-- see lib/commands/access.js -->
23 +
24 ```bash
25 npm access public [<package>]
26 npm access restricted [<package>]
23 -
27 npm access grant <read-only|read-write> <scope:team> [<package>]
28 npm access revoke <scope:team> [<package>]
26 -
29 npm access 2fa-required [<package>]
30 npm access 2fa-not-required [<package>]
29 -
31 npm access ls-packages [<user>|<scope>|<scope:team>]
32 npm access ls-collaborators [<package> [<user>]]
33 npm access edit [<package>]
34 ```
35
36 +<!-- automatically generated, do not edit manually -->
37 +<!-- see lib/commands/access.js -->
38 +
39 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
40 +
41 ### Description
42
43 Used to set access controls on private packages.
content/cli/v8/commands/npm-adduser.md
+10 -1
@@ -16,12 +16,21 @@ github_path: docs/content/commands/npm-adduser.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/adduser.js -->
22 +
23 ```bash
20 -npm adduser [--registry=url] [--scope=@orgname] [--auth-type=legacy]
24 +npm adduser
25
26 aliases: login, add-user
27 ```
28
29 +<!-- automatically generated, do not edit manually -->
30 +<!-- see lib/commands/adduser.js -->
31 +
32 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
33 +
34 Note: This command is unaware of workspaces.
35
36 ### Description
content/cli/v8/commands/npm-audit.md
+10 -4
@@ -16,13 +16,19 @@ github_path: docs/content/commands/npm-audit.md
16
17 ### Synopsis
18
19 -```bash
20 -npm audit [--json] [--production] [--audit-level=(low|moderate|high|critical)]
21 -npm audit fix [--force|--package-lock-only|--dry-run|--production|--only=(dev|prod)]
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/audit.js -->
22
23 -common options: [--production] [--only=(dev|prod)]
23 +```bash
24 +npm audit [fix]
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/audit.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 ### Description
33
34 The audit command submits a description of the dependencies configured in
content/cli/v8/commands/npm-bin.md
+10 -1
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-bin.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/bin.js -->
22 +
23 ```bash
20 -npm bin [-g|--global]
24 +npm bin
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/bin.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 Note: This command is unaware of workspaces.
33
34 ### Description
content/cli/v8/commands/npm-bugs.md
+11 -2
@@ -16,12 +16,21 @@ github_path: docs/content/commands/npm-bugs.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/bugs.js -->
22 +
23 ```bash
20 -npm bugs [<pkgname> [<pkgname> ...]]
24 +npm bugs [<pkgname>]
25
22 -aliases: issues
26 +alias: issues
27 ```
28
29 +<!-- automatically generated, do not edit manually -->
30 +<!-- see lib/commands/bugs.js -->
31 +
32 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
33 +
34 ### Description
35
36 This command tries to guess at the likely location of a package's bug
content/cli/v8/commands/npm-cache.md
+16 -8
@@ -16,18 +16,26 @@ github_path: docs/content/commands/npm-cache.md
16
17 ### Synopsis
18
19 -```bash
20 -npm cache add <tarball file>...
21 -npm cache add <folder>...
22 -npm cache add <tarball url>...
23 -npm cache add <name>@<version>...
24 -
25 -npm cache clean
26 -aliases: npm cache clear, npm cache rm
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/cache.js -->
22
23 +```bash
24 +npm cache add <tarball file>
25 +npm cache add <folder>
26 +npm cache add <tarball url>
27 +npm cache add <git url>
28 +npm cache add <name>@<version>
29 +npm cache clean [<key>]
30 +npm cache ls [<name>@<version>]
31 npm cache verify
32 ```
33
34 +<!-- automatically generated, do not edit manually -->
35 +<!-- see lib/commands/cache.js -->
36 +
37 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
38 +
39 Note: This command is unaware of workspaces.
40
41 ### Description
content/cli/v8/commands/npm-ci.md
+11
@@ -16,10 +16,21 @@ github_path: docs/content/commands/npm-ci.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/ci.js -->
22 +
23 ```bash
24 npm ci
25 +
26 +aliases: clean-install, ic, install-clean, isntall-clean
27 ```
28
29 +<!-- automatically generated, do not edit manually -->
30 +<!-- see lib/commands/ci.js -->
31 +
32 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
33 +
34 ### Description
35
36 This command is similar to [`npm install`](/cli/v8/commands/npm-install), except
content/cli/v8/commands/npm-completion.md
+10 -1
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-completion.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/completion.js -->
22 +
23 ```bash
20 -source <(npm completion)
24 +npm completion
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/completion.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 Note: This command is unaware of workspaces.
33
34 ### Description
content/cli/v8/commands/npm-config.md
+9 -2
@@ -16,18 +16,25 @@ github_path: docs/content/commands/npm-config.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/config.js -->
22 +
23 ```bash
24 npm config set <key>=<value> [<key>=<value> ...]
25 npm config get [<key> [<key> ...]]
26 npm config delete <key> [<key> ...]
27 npm config list [--json]
28 npm config edit
25 -npm set <key>=<value> [<key>=<value> ...]
26 -npm get [<key> [<key> ...]]
29
30 alias: c
31 ```
32
33 +<!-- automatically generated, do not edit manually -->
34 +<!-- see lib/commands/config.js -->
35 +
36 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
37 +
38 Note: This command is unaware of workspaces.
39
40 ### Description
content/cli/v8/commands/npm-dedupe.md
+28 -2
@@ -16,13 +16,21 @@ github_path: docs/content/commands/npm-dedupe.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/dedupe.js -->
22 +
23 ```bash
24 npm dedupe
21 -npm ddp
25
23 -aliases: ddp
26 +alias: ddp
27 ```
28
29 +<!-- automatically generated, do not edit manually -->
30 +<!-- see lib/commands/dedupe.js -->
31 +
32 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
33 +
34 ### Description
35
36 Searches the local package tree and attempts to simplify the overall
@@ -155,6 +163,24 @@ When package package-locks are disabled, automatic pruning of extraneous
163 modules will also be disabled. To remove extraneous modules with
164 package-locks disabled use `npm prune`.
165
166 +This configuration does not affect `npm ci`.
167 +
168 +<!-- automatically generated, do not edit manually -->
169 +<!-- see lib/utils/config/definitions.js -->
170 +
171 +#### `save`
172 +
173 +* Default: `true` unless when using `npm update` or `npm dedupe` where it
174 + defaults to `false`
175 +* Type: Boolean
176 +
177 +Save installed packages to a `package.json` file as dependencies.
178 +
179 +When used with the `npm rm` command, removes the dependency from
180 +`package.json`.
181 +
182 +Will also prevent writing to `package-lock.json` if set to `false`.
183 +
184 <!-- automatically generated, do not edit manually -->
185 <!-- see lib/utils/config/definitions.js -->
186
content/cli/v8/commands/npm-deprecate.md
+10 -1
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-deprecate.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/deprecate.js -->
22 +
23 ```bash
20 -npm deprecate <pkg>[@<version range>] <message>
24 +npm deprecate <pkg>[@<version>] <message>
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/deprecate.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 Note: This command is unaware of workspaces.
33
34 ### Description
content/cli/v8/commands/npm-diff.md
+9 -4
@@ -16,14 +16,19 @@ github_path: docs/content/commands/npm-diff.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/diff.js -->
22 +
23 ```bash
24 npm diff [...<paths>]
21 -npm diff --diff=<pkg-name> [...<paths>]
22 -npm diff --diff=<version-a> [--diff=<version-b>] [...<paths>]
23 -npm diff --diff=<spec-a> [--diff=<spec-b>] [...<paths>]
24 -npm diff [--diff-ignore-all-space] [--diff-name-only] [...<paths>]
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/diff.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 ### Description
33
34 Similar to its `git diff` counterpart, this command will print diff patches
content/cli/v8/commands/npm-dist-tag.md
+10 -1
@@ -16,14 +16,23 @@ github_path: docs/content/commands/npm-dist-tag.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/dist-tag.js -->
22 +
23 ```bash
24 npm dist-tag add <pkg>@<version> [<tag>]
25 npm dist-tag rm <pkg> <tag>
26 npm dist-tag ls [<pkg>]
27
24 -aliases: dist-tags
28 +alias: dist-tags
29 ```
30
31 +<!-- automatically generated, do not edit manually -->
32 +<!-- see lib/commands/dist-tag.js -->
33 +
34 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
35 +
36 ### Description
37
38 Add, remove, and enumerate distribution tags on a package:
content/cli/v8/commands/npm-docs.md
+10 -1
@@ -16,12 +16,21 @@ github_path: docs/content/commands/npm-docs.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/docs.js -->
22 +
23 ```bash
24 npm docs [<pkgname> [<pkgname> ...]]
25
22 -aliases: home
26 +alias: home
27 ```
28
29 +<!-- automatically generated, do not edit manually -->
30 +<!-- see lib/commands/docs.js -->
31 +
32 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
33 +
34 ### Description
35
36 This command tries to guess at the likely location of a package's
content/cli/v8/commands/npm-doctor.md
+9
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-doctor.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/doctor.js -->
22 +
23 ```bash
24 npm doctor
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/doctor.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 Note: This command is unaware of workspaces.
33
34 ### Description
content/cli/v8/commands/npm-edit.md
+10 -1
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-edit.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/edit.js -->
22 +
23 ```bash
20 -npm edit <pkg>
24 +npm edit <pkg>[/<subpkg>...]
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/edit.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 Note: This command is unaware of workspaces.
33
34 ### Description
content/cli/v8/commands/npm-exec.md
+9 -12
@@ -16,26 +16,23 @@ github_path: docs/content/commands/npm-exec.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/exec.js -->
22 +
23 ```bash
24 npm exec -- <pkg>[@<version>] [args...]
25 npm exec --package=<pkg>[@<version>] -- <cmd> [args...]
26 npm exec -c '<cmd> [args...]'
27 npm exec --package=foo -c '<cmd> [args...]'
24 -npm exec [--ws] [-w <workspace-name] [args...]
28
26 -npx <pkg>[@<specifier>] [args...]
27 -npx -p <pkg>[@<specifier>] <cmd> [args...]
28 -npx -c '<cmd> [args...]'
29 -npx -p <pkg>[@<specifier>] -c '<cmd> [args...]'
30 -Run without --call or positional args to open interactive subshell
29 +alias: x
30 +```
31
32 -alias: npm x, npx
32 +<!-- automatically generated, do not edit manually -->
33 +<!-- see lib/commands/exec.js -->
34
34 -common options:
35 ---package=<pkg> (may be specified multiple times)
36 --p is a shorthand for --package only when using npx executable
37 --c <cmd> --call=<cmd> (may not be mixed with positional arguments)
38 -```
35 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
36
37 ### Description
38
content/cli/v8/commands/npm-explain.md
+9
@@ -16,12 +16,21 @@ github_path: docs/content/commands/npm-explain.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/explain.js -->
22 +
23 ```bash
24 npm explain <folder | specifier>
25
26 alias: why
27 ```
28
29 +<!-- automatically generated, do not edit manually -->
30 +<!-- see lib/commands/explain.js -->
31 +
32 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
33 +
34 ### Description
35
36 This command will print the chain of dependencies causing a given package
content/cli/v8/commands/npm-explore.md
+9
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-explore.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/explore.js -->
22 +
23 ```bash
24 npm explore <pkg> [ -- <command>]
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/explore.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 Note: This command is unaware of workspaces.
33
34 ### Description
content/cli/v8/commands/npm-find-dupes.md
+11
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-find-dupes.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/find-dupes.js -->
22 +
23 ```bash
24 npm find-dupes
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/find-dupes.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 ### Description
33
34 Runs `npm dedupe` in `--dry-run` mode, making npm only output the
@@ -92,6 +101,8 @@ When package package-locks are disabled, automatic pruning of extraneous
101 modules will also be disabled. To remove extraneous modules with
102 package-locks disabled use `npm prune`.
103
104 +This configuration does not affect `npm ci`.
105 +
106 <!-- automatically generated, do not edit manually -->
107 <!-- see lib/utils/config/definitions.js -->
108
content/cli/v8/commands/npm-fund.md
+10 -2
@@ -16,11 +16,19 @@ github_path: docs/content/commands/npm-fund.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/fund.js -->
22 +
23 ```bash
20 -npm fund [<pkg>]
21 -npm fund [-w <workspace-name>]
24 +npm fund [[<@scope>/]<pkg>]
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/fund.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 ### Description
33
34 This command retrieves information on how to fund the dependencies of a
content/cli/v8/commands/npm-help-search.md
+9
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-help-search.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/help-search.js -->
22 +
23 ```bash
24 npm help-search <text>
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/help-search.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 Note: This command is unaware of workspaces.
33
34 ### Description
content/cli/v8/commands/npm-help.md
+11
@@ -16,10 +16,21 @@ github_path: docs/content/commands/npm-help.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/help.js -->
22 +
23 ```bash
24 npm help <term> [<terms..>]
25 +
26 +alias: hlep
27 ```
28
29 +<!-- automatically generated, do not edit manually -->
30 +<!-- see lib/commands/help.js -->
31 +
32 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
33 +
34 Note: This command is unaware of workspaces.
35
36 ### Description
content/cli/v8/commands/npm-hook.md
+11 -2
@@ -16,13 +16,22 @@ github_path: docs/content/commands/npm-hook.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/hook.js -->
22 +
23 ```bash
24 +npm hook add <pkg> <url> <secret> [--type=<type>]
25 npm hook ls [pkg]
21 -npm hook add <entity> <url> <secret>
22 -npm hook update <id> <url> [secret]
26 npm hook rm <id>
27 +npm hook update <id> <url> <secret>
28 ```
29
30 +<!-- automatically generated, do not edit manually -->
31 +<!-- see lib/commands/hook.js -->
32 +
33 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
34 +
35 Note: This command is unaware of workspaces.
36
37 ### Description
content/cli/v8/commands/npm-init.md
+23 -4
@@ -16,13 +16,23 @@ github_path: docs/content/commands/npm-init.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/init.js -->
22 +
23 ```bash
20 -npm init [--yes|-y|--scope]
21 -npm init <@scope> (same as `npm exec <@scope>/create`)
22 -npm init [<@scope>/]<name> (same as `npm exec [<@scope>/]create-<name>`)
23 -npm init [-w <dir>] [args...]
24 +npm init [--force|-f|--yes|-y|--scope]
25 +npm init <@scope> (same as `npx <@scope>/create`)
26 +npm init [<@scope>/]<name> (same as `npx [<@scope>/]create-<name>`)
27 +
28 +aliases: create, innit
29 ```
30
31 +<!-- automatically generated, do not edit manually -->
32 +<!-- see lib/commands/init.js -->
33 +
34 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
35 +
36 ### Description
37
38 `npm init <initializer>` can be used to set up a new or existing npm
@@ -48,6 +58,15 @@ strictly additive, so it will keep any fields and values that were already
58 set. You can also use `-y`/`--yes` to skip the questionnaire altogether. If
59 you pass `--scope`, it will create a scoped package.
60
61 +*Note:* if a user already has the `create-<initializer>` package
62 +globally installed, that will be what `npm init` uses. If you want npm
63 +to use the latest version, or another specific version you must specify
64 +it:
65 +
66 +* `npm init foo@latest` # fetches and runs the latest `create-foo` from
67 + the registry
68 +* `npm init foo@1.2.3` # runs `create-foo@1.2.3` specifically
69 +
70 #### Forwarding additional options
71
72 Any additional options will be passed directly to the command, so `npm init
content/cli/v8/commands/npm-install-ci-test.md
+10 -1
@@ -16,12 +16,21 @@ github_path: docs/content/commands/npm-install-ci-test.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/install-ci-test.js -->
22 +
23 ```bash
24 npm install-ci-test
25
22 -alias: npm cit
26 +alias: cit
27 ```
28
29 +<!-- automatically generated, do not edit manually -->
30 +<!-- see lib/commands/install-ci-test.js -->
31 +
32 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
33 +
34 ### Description
35
36 This command runs `npm ci` followed immediately by `npm test`.
content/cli/v8/commands/npm-install-test.md
+26 -11
@@ -16,20 +16,30 @@ github_path: docs/content/commands/npm-install-test.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/install-test.js -->
22 +
23 ```bash
20 -npm install-test (with no args, in package dir)
21 -npm install-test [<@scope>/]<name>
22 -npm install-test [<@scope>/]<name>@<tag>
23 -npm install-test [<@scope>/]<name>@<version>
24 -npm install-test [<@scope>/]<name>@<version range>
24 +npm install-test [<@scope>/]<pkg>
25 +npm install-test [<@scope>/]<pkg>@<tag>
26 +npm install-test [<@scope>/]<pkg>@<version>
27 +npm install-test [<@scope>/]<pkg>@<version range>
28 +npm install-test <alias>@npm:<name>
29 +npm install-test <folder>
30 npm install-test <tarball file>
31 npm install-test <tarball url>
27 -npm install-test <folder>
32 +npm install-test <git:// url>
33 +npm install-test <github username>/<github project>
34
29 -alias: npm it
30 -common options: [--save|--save-dev|--save-optional] [--save-exact] [--dry-run]
35 +alias: it
36 ```
37
38 +<!-- automatically generated, do not edit manually -->
39 +<!-- see lib/commands/install-test.js -->
40 +
41 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
42 +
43 ### Description
44
45 This command runs an `npm install` followed immediately by an `npm test`. It
@@ -42,13 +52,16 @@ takes exactly the same arguments as `npm install`.
52 <!-- see lib/utils/config/definitions.js -->
53 #### `save`
54
45 -* Default: true
55 +* Default: `true` unless when using `npm update` or `npm dedupe` where it
56 + defaults to `false`
57 * Type: Boolean
58
48 -Save installed packages to a package.json file as dependencies.
59 +Save installed packages to a `package.json` file as dependencies.
60
61 When used with the `npm rm` command, removes the dependency from
51 -package.json.
62 +`package.json`.
63 +
64 +Will also prevent writing to `package-lock.json` if set to `false`.
65
66 <!-- automatically generated, do not edit manually -->
67 <!-- see lib/utils/config/definitions.js -->
@@ -143,6 +156,8 @@ When package package-locks are disabled, automatic pruning of extraneous
156 modules will also be disabled. To remove extraneous modules with
157 package-locks disabled use `npm prune`.
158
159 +This configuration does not affect `npm ci`.
160 +
161 <!-- automatically generated, do not edit manually -->
162 <!-- see lib/utils/config/definitions.js -->
163
content/cli/v8/commands/npm-install.md
+25 -13
@@ -17,23 +17,30 @@ github_path: docs/content/commands/npm-install.md
17
18 ### Synopsis
19
20 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
21 +<!-- automatically generated, do not edit manually -->
22 +<!-- see lib/commands/install.js -->
23 +
24 ```bash
21 -npm install (with no args, in package dir)
22 -npm install [<@scope>/]<name>
23 -npm install [<@scope>/]<name>@<tag>
24 -npm install [<@scope>/]<name>@<version>
25 -npm install [<@scope>/]<name>@<version range>
25 +npm install [<@scope>/]<pkg>
26 +npm install [<@scope>/]<pkg>@<tag>
27 +npm install [<@scope>/]<pkg>@<version>
28 +npm install [<@scope>/]<pkg>@<version range>
29 npm install <alias>@npm:<name>
27 -npm install <git-host>:<git-user>/<repo-name>
28 -npm install <git repo url>
30 +npm install <folder>
31 npm install <tarball file>
32 npm install <tarball url>
31 -npm install <folder>
33 +npm install <git:// url>
34 +npm install <github username>/<github project>
35
33 -aliases: npm i, npm add
34 -common options: [-P|--save-prod|-D|--save-dev|-O|--save-optional|--save-peer] [-E|--save-exact] [-B|--save-bundle] [--no-save] [--dry-run]
36 +aliases: i, in, ins, inst, insta, instal, isnt, isnta, isntal, add
37 ```
38
39 +<!-- automatically generated, do not edit manually -->
40 +<!-- see lib/commands/install.js -->
41 +
42 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
43 +
44 ### Description
45
46 This command installs a package and any packages that it depends on. If the
@@ -436,13 +443,16 @@ These are some of the most common options related to installation.
443 <!-- see lib/utils/config/definitions.js -->
444 #### `save`
445
439 -* Default: true
446 +* Default: `true` unless when using `npm update` or `npm dedupe` where it
447 + defaults to `false`
448 * Type: Boolean
449
442 -Save installed packages to a package.json file as dependencies.
450 +Save installed packages to a `package.json` file as dependencies.
451
452 When used with the `npm rm` command, removes the dependency from
445 -package.json.
453 +`package.json`.
454 +
455 +Will also prevent writing to `package-lock.json` if set to `false`.
456
457 <!-- automatically generated, do not edit manually -->
458 <!-- see lib/utils/config/definitions.js -->
@@ -537,6 +547,8 @@ When package package-locks are disabled, automatic pruning of extraneous
547 modules will also be disabled. To remove extraneous modules with
548 package-locks disabled use `npm prune`.
549
550 +This configuration does not affect `npm ci`.
551 +
552 <!-- automatically generated, do not edit manually -->
553 <!-- see lib/utils/config/definitions.js -->
554
content/cli/v8/commands/npm-link.md
+18 -4
@@ -16,13 +16,22 @@ github_path: docs/content/commands/npm-link.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/link.js -->
22 +
23 ```bash
24 npm link (in package dir)
25 npm link [<@scope>/]<pkg>[@<version>]
26
23 -alias: npm ln
27 +alias: ln
28 ```
29
30 +<!-- automatically generated, do not edit manually -->
31 +<!-- see lib/commands/link.js -->
32 +
33 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
34 +
35 ### Description
36
37 This is handy for installing your own stuff, so that you can work on it and
@@ -126,13 +135,16 @@ workspace(s).
135 <!-- see lib/utils/config/definitions.js -->
136 #### `save`
137
129 -* Default: true
138 +* Default: `true` unless when using `npm update` or `npm dedupe` where it
139 + defaults to `false`
140 * Type: Boolean
141
132 -Save installed packages to a package.json file as dependencies.
142 +Save installed packages to a `package.json` file as dependencies.
143
144 When used with the `npm rm` command, removes the dependency from
135 -package.json.
145 +`package.json`.
146 +
147 +Will also prevent writing to `package-lock.json` if set to `false`.
148
149 <!-- automatically generated, do not edit manually -->
150 <!-- see lib/utils/config/definitions.js -->
@@ -227,6 +239,8 @@ When package package-locks are disabled, automatic pruning of extraneous
239 modules will also be disabled. To remove extraneous modules with
240 package-locks disabled use `npm prune`.
241
242 +This configuration does not affect `npm ci`.
243 +
244 <!-- automatically generated, do not edit manually -->
245 <!-- see lib/utils/config/definitions.js -->
246
content/cli/v8/commands/npm-logout.md
+10 -1
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-logout.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/logout.js -->
22 +
23 ```bash
20 -npm logout [--registry=<url>] [--scope=<@scope>]
24 +npm logout
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/logout.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 Note: This command is unaware of workspaces.
33
34 ### Description
content/cli/v8/commands/npm-ls.md
+10 -1
@@ -16,12 +16,21 @@ github_path: docs/content/commands/npm-ls.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/ls.js -->
22 +
23 ```bash
24 npm ls [[<@scope>/]<pkg> ...]
25
22 -aliases: list, la, ll
26 +alias: list
27 ```
28
29 +<!-- automatically generated, do not edit manually -->
30 +<!-- see lib/commands/ls.js -->
31 +
32 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
33 +
34 ### Description
35
36 This command will print to stdout all the versions of packages that are
content/cli/v8/commands/npm-org.md
+14 -3
@@ -16,12 +16,23 @@ github_path: docs/content/commands/npm-org.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/org.js -->
22 +
23 ```bash
20 -npm org set <orgname> <username> [developer | admin | owner]
21 -npm org rm <orgname> <username>
22 -npm org ls <orgname> [<username>]
24 +npm org set orgname username [developer | admin | owner]
25 +npm org rm orgname username
26 +npm org ls orgname [<username>]
27 +
28 +alias: ogr
29 ```
30
31 +<!-- automatically generated, do not edit manually -->
32 +<!-- see lib/commands/org.js -->
33 +
34 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
35 +
36 Note: This command is unaware of workspaces.
37
38 ### Example
content/cli/v8/commands/npm-outdated.md
+9
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-outdated.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/outdated.js -->
22 +
23 ```bash
24 npm outdated [[<@scope>/]<pkg> ...]
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/outdated.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 ### Description
33
34 This command will check the registry to see if any (or, specific) installed
content/cli/v8/commands/npm-owner.md
+10 -1
@@ -16,14 +16,23 @@ github_path: docs/content/commands/npm-owner.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/owner.js -->
22 +
23 ```bash
24 npm owner add <user> [<@scope>/]<pkg>
25 npm owner rm <user> [<@scope>/]<pkg>
26 npm owner ls [<@scope>/]<pkg>
27
24 -aliases: author
28 +alias: author
29 ```
30
31 +<!-- automatically generated, do not edit manually -->
32 +<!-- see lib/commands/owner.js -->
33 +
34 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
35 +
36 Note: This command is unaware of workspaces.
37
38 ### Description
content/cli/v8/commands/npm-pack.md
+10 -1
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-pack.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/pack.js -->
22 +
23 ```bash
20 -npm pack [[<@scope>/]<pkg>...] [--dry-run] [--json]
24 +npm pack [[<@scope>/]<pkg>...]
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/pack.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 ### Configuration
33
34 <!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
content/cli/v8/commands/npm-ping.md
+10 -1
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-ping.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/ping.js -->
22 +
23 ```bash
20 -npm ping [--registry <registry>]
24 +npm ping
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/ping.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 Note: This command is unaware of workspaces.
33
34 ### Description
content/cli/v8/commands/npm-pkg.md
+12 -3
@@ -16,12 +16,21 @@ github_path: docs/content/commands/npm-pkg.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/pkg.js -->
22 +
23 ```bash
20 -npm pkg get [<field> [.<subfield> ...]]
21 -npm pkg set <field>=<value> [.<subfield>=<value> ...]
22 -npm pkg delete <field> [.<subfield> ...]
24 +npm pkg set <key>=<value> [<key>=<value> ...]
25 +npm pkg get [<key> [<key> ...]]
26 +npm pkg delete <key> [<key> ...]
27 ```
28
29 +<!-- automatically generated, do not edit manually -->
30 +<!-- see lib/commands/pkg.js -->
31 +
32 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
33 +
34 ### Description
35
36 A command that automates the management of `package.json` files.
content/cli/v8/commands/npm-prefix.md
+9
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-prefix.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/prefix.js -->
22 +
23 ```bash
24 npm prefix [-g]
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/prefix.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 Note: This command is unaware of workspaces.
33
34 ### Description
content/cli/v8/commands/npm-profile.md
+12 -4
@@ -16,14 +16,22 @@ github_path: docs/content/commands/npm-profile.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/profile.js -->
22 +
23 ```bash
20 -npm profile get [--json|--parseable] [<property>]
21 -npm profile set [--json|--parseable] <property> <value>
22 -npm profile set password
23 -npm profile enable-2fa [auth-and-writes|auth-only]
24 +npm profile enable-2fa [auth-only|auth-and-writes]
25 npm profile disable-2fa
26 +npm profile get [<key>]
27 +npm profile set <key> <value>
28 ```
29
30 +<!-- automatically generated, do not edit manually -->
31 +<!-- see lib/commands/profile.js -->
32 +
33 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
34 +
35 Note: This command is unaware of workspaces.
36
37 ### Description
content/cli/v8/commands/npm-prune.md
+10 -1
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-prune.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/prune.js -->
22 +
23 ```bash
20 -npm prune [[<@scope>/]<pkg>...] [--production] [--dry-run] [--json]
24 +npm prune [[<@scope>/]<pkg>...]
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/prune.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 ### Description
33
34 This command removes "extraneous" packages. If a package name is provided,
content/cli/v8/commands/npm-publish.md
+10 -4
@@ -16,13 +16,19 @@ github_path: docs/content/commands/npm-publish.md
16
17 ### Synopsis
18
19 -```bash
20 -npm publish [<tarball>|<folder>] [--tag <tag>] [--access <public|restricted>] [--otp otpcode] [--dry-run]
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/publish.js -->
22
22 -Publishes '.' if no argument supplied
23 -Sets tag 'latest' if no --tag specified
23 +```bash
24 +npm publish [<folder>]
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/publish.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 ### Description
33
34 Publishes a package to the registry so that it can be installed by name.
content/cli/v8/commands/npm-rebuild.md
+9
@@ -16,12 +16,21 @@ github_path: docs/content/commands/npm-rebuild.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/rebuild.js -->
22 +
23 ```bash
24 npm rebuild [[<@scope>/]<name>[@<version>] ...]
25
26 alias: rb
27 ```
28
29 +<!-- automatically generated, do not edit manually -->
30 +<!-- see lib/commands/rebuild.js -->
31 +
32 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
33 +
34 ### Description
35
36 This command runs the `npm build` command on the matched folders. This is
content/cli/v8/commands/npm-repo.md
+9
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-repo.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/repo.js -->
22 +
23 ```bash
24 npm repo [<pkgname> [<pkgname> ...]]
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/repo.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 ### Description
33
34 This command tries to guess at the likely location of a package's
content/cli/v8/commands/npm-restart.md
+9
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-restart.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/restart.js -->
22 +
23 ```bash
24 npm restart [-- <args>]
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/restart.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 ### Description
33
34 This restarts a project. It is equivalent to running `npm run-script
content/cli/v8/commands/npm-root.md
+10 -1
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-root.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/root.js -->
22 +
23 ```bash
20 -npm root [-g]
24 +npm root
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/root.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 ### Description
33
34 Print the effective `node_modules` folder to standard out.
content/cli/v8/commands/npm-run-script.md
+10 -3
@@ -16,14 +16,21 @@ github_path: docs/content/commands/npm-run-script.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/run-script.js -->
22 +
23 ```bash
20 -npm run-script <command> [--if-present] [--silent] [-- <args>]
21 -npm run-script <command> [--workspace=<workspace-name>]
22 -npm run-script <command> [--workspaces]
24 +npm run-script <command> [-- <args>]
25
26 aliases: run, rum, urn
27 ```
28
29 +<!-- automatically generated, do not edit manually -->
30 +<!-- see lib/commands/run-script.js -->
31 +
32 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
33 +
34 ### Description
35
36 This runs an arbitrary command from a package's `"scripts"` object. If no
content/cli/v8/commands/npm-search.md
+10 -1
@@ -16,12 +16,21 @@ github_path: docs/content/commands/npm-search.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/search.js -->
22 +
23 ```bash
20 -npm search [-l|--long] [--json] [--parseable] [--no-description] [search terms ...]
24 +npm search [search terms ...]
25
26 aliases: s, se, find
27 ```
28
29 +<!-- automatically generated, do not edit manually -->
30 +<!-- see lib/commands/search.js -->
31 +
32 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
33 +
34 Note: This command is unaware of workspaces.
35
36 ### Description
content/cli/v8/commands/npm-set-script.md
+9
@@ -17,10 +17,19 @@ github_path: docs/content/commands/npm-set-script.md
17 ### Synopsis
18 An npm command that lets you create a task in the `scripts` section of the `package.json`.
19
20 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
21 +<!-- automatically generated, do not edit manually -->
22 +<!-- see lib/commands/set-script.js -->
23 +
24 ```bash
25 npm set-script [<script>] [<command>]
26 ```
27
28 +<!-- automatically generated, do not edit manually -->
29 +<!-- see lib/commands/set-script.js -->
30 +
31 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
32 +
33
34 **Example:**
35
content/cli/v8/commands/npm-shrinkwrap.md
+9
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-shrinkwrap.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/shrinkwrap.js -->
22 +
23 ```bash
24 npm shrinkwrap
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/shrinkwrap.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 Note: This command is unaware of workspaces.
33
34 ### Description
content/cli/v8/commands/npm-star.md
+9
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-star.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/star.js -->
22 +
23 ```bash
24 npm star [<pkg>...]
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/star.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 Note: This command is unaware of workspaces.
33
34 ### Description
content/cli/v8/commands/npm-stars.md
+10
@@ -15,10 +15,20 @@ github_path: docs/content/commands/npm-stars.md
15 ---
16
17 ### Synopsis
18 +
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/stars.js -->
22 +
23 ```bash
24 npm stars [<user>]
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/stars.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 Note: This command is unaware of workspaces.
33
34 ### Description
content/cli/v8/commands/npm-start.md
+9
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-start.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/start.js -->
22 +
23 ```bash
24 npm start [-- <args>]
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/start.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 ### Description
33
34 This runs a predefined command specified in the `"start"` property of
content/cli/v8/commands/npm-stop.md
+9
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-stop.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/stop.js -->
22 +
23 ```bash
24 npm stop [-- <args>]
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/stop.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 ### Description
33
34 This runs a predefined command specified in the "stop" property of a
content/cli/v8/commands/npm-team.md
+13 -6
@@ -16,16 +16,23 @@ github_path: docs/content/commands/npm-team.md
16
17 ### Synopsis
18
19 -```bash
20 -npm team create <scope:team>
21 -npm team destroy <scope:team>
22 -
23 -npm team add <scope:team> <user>
24 -npm team rm <scope:team> <user>
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/team.js -->
22
23 +```bash
24 +npm team create <scope:team> [--otp <otpcode>]
25 +npm team destroy <scope:team> [--otp <otpcode>]
26 +npm team add <scope:team> <user> [--otp <otpcode>]
27 +npm team rm <scope:team> <user> [--otp <otpcode>]
28 npm team ls <scope>|<scope:team>
29 ```
30
31 +<!-- automatically generated, do not edit manually -->
32 +<!-- see lib/commands/team.js -->
33 +
34 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
35 +
36 Note: This command is unaware of workspaces.
37
38 ### Description
content/cli/v8/commands/npm-test.md
+10 -1
@@ -16,12 +16,21 @@ github_path: docs/content/commands/npm-test.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/test.js -->
22 +
23 ```bash
24 npm test [-- <args>]
25
22 -aliases: t, tst
26 +aliases: tst, t
27 ```
28
29 +<!-- automatically generated, do not edit manually -->
30 +<!-- see lib/commands/test.js -->
31 +
32 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
33 +
34 ### Description
35
36 This runs a predefined command specified in the `"test"` property of
content/cli/v8/commands/npm-token.md
+13 -3
@@ -15,12 +15,22 @@ github_path: docs/content/commands/npm-token.md
15 ---
16
17 ### Synopsis
18 +
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/token.js -->
22 +
23 ```bash
19 - npm token list [--json|--parseable]
20 - npm token create [--read-only] [--cidr=1.1.1.1/24,2.2.2.2/16]
21 - npm token revoke <id|token>
24 +npm token list
25 +npm token revoke <id|token>
26 +npm token create [--read-only] [--cidr=list]
27 ```
28
29 +<!-- automatically generated, do not edit manually -->
30 +<!-- see lib/commands/token.js -->
31 +
32 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
33 +
34 Note: This command is unaware of workspaces.
35
36 ### Description
content/cli/v8/commands/npm-uninstall.md
+17 -5
@@ -16,12 +16,21 @@ github_path: docs/content/commands/npm-uninstall.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/uninstall.js -->
22 +
23 ```bash
20 -npm uninstall [<@scope>/]<pkg>[@<version>]... [-S|--save|--no-save]
24 +npm uninstall [<@scope>/]<pkg>...
25
22 -aliases: remove, rm, r, un, unlink
26 +aliases: un, unlink, remove, rm, r
27 ```
28
29 +<!-- automatically generated, do not edit manually -->
30 +<!-- see lib/commands/uninstall.js -->
31 +
32 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
33 +
34 ### Description
35
36 This uninstalls a package, completely removing everything npm installed
@@ -71,13 +80,16 @@ npm uninstall lodash --no-save
80 <!-- see lib/utils/config/definitions.js -->
81 #### `save`
82
74 -* Default: true
83 +* Default: `true` unless when using `npm update` or `npm dedupe` where it
84 + defaults to `false`
85 * Type: Boolean
86
77 -Save installed packages to a package.json file as dependencies.
87 +Save installed packages to a `package.json` file as dependencies.
88
89 When used with the `npm rm` command, removes the dependency from
80 -package.json.
90 +`package.json`.
91 +
92 +Will also prevent writing to `package-lock.json` if set to `false`.
93
94 <!-- automatically generated, do not edit manually -->
95 <!-- see lib/utils/config/definitions.js -->
content/cli/v8/commands/npm-unstar.md
+9
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-unstar.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/unstar.js -->
22 +
23 ```bash
24 npm unstar [<pkg>...]
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/unstar.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 Note: This command is unaware of workspaces.
33
34 ### Description
content/cli/v8/commands/npm-update.md
+29 -2
@@ -16,12 +16,21 @@ github_path: docs/content/commands/npm-update.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/update.js -->
22 +
23 ```bash
20 -npm update [-g] [<pkg>...]
24 +npm update [<pkg>...]
25
22 -aliases: up, upgrade
26 +aliases: up, upgrade, udpate
27 ```
28
29 +<!-- automatically generated, do not edit manually -->
30 +<!-- see lib/commands/update.js -->
31 +
32 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
33 +
34 ### Description
35
36 This command will update all the packages listed to the latest version
@@ -249,6 +258,24 @@ When package package-locks are disabled, automatic pruning of extraneous
258 modules will also be disabled. To remove extraneous modules with
259 package-locks disabled use `npm prune`.
260
261 +This configuration does not affect `npm ci`.
262 +
263 +<!-- automatically generated, do not edit manually -->
264 +<!-- see lib/utils/config/definitions.js -->
265 +
266 +#### `save`
267 +
268 +* Default: `true` unless when using `npm update` or `npm dedupe` where it
269 + defaults to `false`
270 +* Type: Boolean
271 +
272 +Save installed packages to a `package.json` file as dependencies.
273 +
274 +When used with the `npm rm` command, removes the dependency from
275 +`package.json`.
276 +
277 +Will also prevent writing to `package-lock.json` if set to `false`.
278 +
279 <!-- automatically generated, do not edit manually -->
280 <!-- see lib/utils/config/definitions.js -->
281
content/cli/v8/commands/npm-version.md
+11 -4
@@ -16,14 +16,21 @@ github_path: docs/content/commands/npm-version.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/version.js -->
22 +
23 ```bash
20 -npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease [--preid=<prerelease-id>] | from-git]
24 +npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git]
25
22 -'npm [-v | --version]' to print npm version
23 -'npm view <pkg> version' to view a package's published version
24 -'npm ls' to inspect current package/dependency versions
26 +alias: verison
27 ```
28
29 +<!-- automatically generated, do not edit manually -->
30 +<!-- see lib/commands/version.js -->
31 +
32 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
33 +
34 ### Configuration
35
36 <!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
content/cli/v8/commands/npm-view.md
+11 -2
@@ -16,12 +16,21 @@ github_path: docs/content/commands/npm-view.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/view.js -->
22 +
23 ```bash
20 -npm view [<@scope>/]<name>[@<version>] [<field>[.<subfield>]...]
24 +npm view [<@scope>/]<pkg>[@<version>] [<field>[.subfield]...]
25
22 -aliases: info, show, v
26 +aliases: v, info, show
27 ```
28
29 +<!-- automatically generated, do not edit manually -->
30 +<!-- see lib/commands/view.js -->
31 +
32 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
33 +
34 ### Description
35
36 This command shows data about a package and prints it to stdout.
content/cli/v8/commands/npm-whoami.md
+10 -1
@@ -16,10 +16,19 @@ github_path: docs/content/commands/npm-whoami.md
16
17 ### Synopsis
18
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/whoami.js -->
22 +
23 ```bash
20 -npm whoami [--registry <registry>]
24 +npm whoami
25 ```
26
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/whoami.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31 +
32 Note: This command is unaware of workspaces.
33
34 ### Description
content/cli/v8/commands/npm.md
+2 -3
@@ -15,9 +15,8 @@ github_path: docs/content/commands/npm.md
15
16 ### Synopsis
17
18 -```bash
19 -npm <command> [args]
20 -```
18 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
20
21 ### Version
22
content/cli/v8/commands/npx.md
+11 -13
@@ -9,23 +9,21 @@ github_path: docs/content/commands/npx.md
9
10 ### Synopsis
11
12 -```bash
13 -npm exec -- <pkg>[@<version>] [args...]
14 -npm exec --package=<pkg>[@<version>] -- <cmd> [args...]
15 -npm exec -c '<cmd> [args...]'
16 -npm exec --package=foo -c '<cmd> [args...]'
12 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
13 +<!-- automatically generated, do not edit manually -->
14 +<!-- see lib/commands/exec.js -->
15
18 -npx <pkg>[@<specifier>] [args...]
19 -npx -p <pkg>[@<specifier>] <cmd> [args...]
16 +```bash
17 +npx -- <pkg>[@<version>] [args...]
18 +npx --package=<pkg>[@<version>] -- <cmd> [args...]
19 npx -c '<cmd> [args...]'
21 -npx -p <pkg>[@<specifier>] -c '<cmd> [args...]'
20 +npx --package=foo -c '<cmd> [args...]'
21 +```
22
23 -alias: npm x, npx
23 +<!-- automatically generated, do not edit manually -->
24 +<!-- see lib/commands/exec.js -->
25
25 ---package=<pkg> (may be specified multiple times)
26 --p is a shorthand for --package only when using npx executable
27 --c <cmd> --call=<cmd> (may not be mixed with positional arguments)
28 -```
26 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
27
28 ### Description
29
content/cli/v8/using-npm/scripts.md
+5
@@ -352,6 +352,11 @@ file.
352 preinstall or install script. If you are doing this, please consider if
353 there is another option. The only valid use of `install` or `preinstall`
354 scripts is for compilation which must be done on the target architecture.
355 +* Scripts are run from the root of the package folder, regardless of what the
356 + current working directory is when `npm` is invoked. If you want your
357 + script to use different behavior based on what subdirectory you're in, you
358 + can use the `INIT_CWD` environment variable, which holds the full path you
359 + were in when you ran `npm run`.
360
361 ### See Also
362