Skip to content

Commit f6a3346

Browse files
author
CI User
committed
CLI documentation update from CI
1 parent 122de68 commit f6a3346

File tree

16 files changed

+29
-32
lines changed

16 files changed

+29
-32
lines changed

cli/v7

Submodule v7 updated 47 files

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ github_path: docs/content/commands/npm-cache.md
1717
### Synopsis
1818

1919
```bash
20-
npm cache add <tarball file>
21-
npm cache add <folder>
22-
npm cache add <tarball url>
23-
npm cache add <name>@<version>
20+
npm cache add <tarball file>...
21+
npm cache add <folder>...
22+
npm cache add <tarball url>...
23+
npm cache add <name>@<version>...
2424

2525
npm cache clean
2626
aliases: npm cache clear, npm cache rm
@@ -35,7 +35,7 @@ Note: This command is unaware of workspaces.
3535
Used to add, list, or clean the npm cache folder.
3636

3737
* add:
38-
Add the specified package to the local cache. This command is primarily
38+
Add the specified packages to the local cache. This command is primarily
3939
intended to be used internally by npm, but it can provide a way to
4040
add data to the local installation cache explicitly.
4141

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ npm ci
2222

2323
### Description
2424

25-
This command is similar to [`npm install`](/cli-commands/install), except
25+
This command is similar to [`npm install`](/cli/v7/commands/npm-install), except
2626
it's meant to be used in automated environments such as test platforms,
2727
continuous integration, and deployment -- or any situation where you want
2828
to make sure you're doing a clean install of your dependencies.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Using `npm find-dupes` will run the command in `--dry-run` mode.
8484

8585
### See Also
8686

87-
* [npm find-dupes](/cli-commands/find-dupes)
88-
* [npm ls](/cli-commands/ls)
89-
* [npm update](/cli-commands/update)
90-
* [npm install](/cli-commands/install)
87+
* [npm find-dupes](/cli/v7/commands/npm-find-dupes)
88+
* [npm ls](/cli/v7/commands/npm-ls)
89+
* [npm update](/cli/v7/commands/npm-update)
90+
* [npm install](/cli/v7/commands/npm-install)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,5 +54,5 @@ format an empty string.
5454

5555
* [npm publish](/cli/v7/commands/npm-publish)
5656
* [npm registry](/cli/v7/using-npm/registry)
57-
* [npm owner](/cli-commands/owner)
58-
* [npm owner](/cli-commands/adduser)
57+
* [npm owner](/cli/v7/commands/npm-owner)
58+
* [npm owner](/cli/v7/commands/npm-adduser)

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,5 +54,4 @@ The shell to run for the `npm explore` command.
5454
* [npm folders](/cli/v7/configuring-npm/folders)
5555
* [npm edit](/cli/v7/commands/npm-edit)
5656
* [npm rebuild](/cli/v7/commands/npm-rebuild)
57-
* [npm build](/cli/v7/commands/npm-build)
5857
* [npm install](/cli/v7/commands/npm-install)

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ duplications, without actually changing the package tree.
2727

2828
### See Also
2929

30-
* [npm dedupe](/cli-commands/dedupe)
31-
* [npm ls](/cli-commands/ls)
32-
* [npm update](/cli-commands/update)
33-
* [npm install](/cli-commands/install)
30+
* [npm dedupe](/cli/v7/commands/npm-dedupe)
31+
* [npm ls](/cli/v7/commands/npm-ls)
32+
* [npm update](/cli/v7/commands/npm-update)
33+
* [npm install](/cli/v7/commands/npm-install)
3434

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -549,7 +549,6 @@ the specific folder structures that npm creates.
549549
* [npm link](/cli/v7/commands/npm-link)
550550
* [npm rebuild](/cli/v7/commands/npm-rebuild)
551551
* [npm scripts](/cli/v7/using-npm/scripts)
552-
* [npm build](/cli/v7/commands/npm-build)
553552
* [npm config](/cli/v7/commands/npm-config)
554553
* [npmrc](/cli/v7/configuring-npm/npmrc)
555554
* [npm registry](/cli/v7/using-npm/registry)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ This removes a package version from the registry, deleting its entry and
4444
removing the tarball.
4545

4646
The npm registry will return an error if you are not [logged
47-
in](/cli/v7/commands/npm-login).
47+
in](/cli/v7/commands/npm-adduser).
4848

4949
If you do not specify a version or if you remove all of a package's
5050
versions then the registry will remove the root package entry entirely.
@@ -62,4 +62,4 @@ passed.
6262
* [npm registry](/cli/v7/using-npm/registry)
6363
* [npm adduser](/cli/v7/commands/npm-adduser)
6464
* [npm owner](/cli/v7/commands/npm-owner)
65-
* [npm login](/cli/v7/commands/npm-login)
65+
* [npm login](/cli/v7/commands/npm-adduser)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ npm view express contributors.name contributors.email
8383

8484
"Person" fields are shown as a string if they would be shown as an
8585
object. So, for example, this will show the list of `npm` contributors in
86-
the shortened string format. (See [`package.json`](/cli/v7/configuring-npm/package.json) for more on this.)
86+
the shortened string format. (See [`package.json`](/cli/v7/configuring-npm/package-json) for more on this.)
8787

8888
```bash
8989
npm view npm contributors

content/cli/v7/commands/npm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ following help topics:
116116
Create an account or log in. When you do this, npm will store
117117
credentials in the user config file config file.
118118
* publish:
119-
Use the [`npm publish`](/cli/v7/commands/npm-publish`) command to upload your
119+
Use the [`npm publish`](/cli/v7/commands/npm-publish) command to upload your
120120
code to the registry.
121121

122122
#### Configuration

content/cli/v7/configuring-npm/folders.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ not be included in the package tarball.
213213
214214
This allows a package maintainer to install all of their dependencies
215215
(and dev dependencies) locally, but only re-publish those items that
216-
cannot be found elsewhere. See [`package.json`](/cli/v7/configuring-npm/package.json) for more information.
216+
cannot be found elsewhere. See [`package.json`](/cli/v7/configuring-npm/package-json) for more information.
217217
218218
### See also
219219

content/cli/v7/configuring-npm/package-json.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,7 @@ tarball or git URL.
576576
**Please do not put test harnesses or transpilers or other "development"
577577
time tools in your `dependencies` object.** See `devDependencies`, below.
578578

579-
See [semver](/cli/v7/using-npm/semver#versions) for more details about specifying version ranges.
579+
See [semver](https://github.com/npm/node-semver#versions) for more details about specifying version ranges.
580580

581581
* `version` Must match `version` exactly
582582
* `>version` Must be greater than `version`

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1261,7 +1261,8 @@ Show short usage output about the command specified.
12611261

12621262
#### `user-agent`
12631263

1264-
* Default: "npm/{npm-version} node/{node-version} {platform} {arch} {ci}"
1264+
* Default: "npm/{npm-version} node/{node-version} {platform} {arch}
1265+
workspaces/{workspaces} {ci}"
12651266
* Type: String
12661267

12671268
Sets the User-Agent request header. The following fields are replaced with
@@ -1271,6 +1272,8 @@ their actual counterparts:
12711272
* `{node-version}` - The Node.js version in use
12721273
* `{platform}` - The value of `process.platform`
12731274
* `{arch}` - The value of `process.arch`
1275+
* `{workspaces}` - Set to `true` if the `workspaces` or `workspace` options
1276+
are set.
12741277
* `{ci}` - The value of the `ci-name` config, if set, prefixed with `ci/`, or
12751278
an empty string if `ci-name` is empty.
12761279

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

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -126,11 +126,6 @@ The advantage of doing these things at `prepublish` time is that they can be don
126126

127127
* `prepare`
128128

129-
#### [`npm env`](/cli/v7/commands/npm-env)
130-
131-
* `env` (You can override the default behavior of `npm env` by defining
132-
a custom `env` entry in your `scripts` object)
133-
134129
#### [`npm install`](/cli/v7/commands/npm-install)
135130

136131
These also run when you run `npm install -g <pkg-name>`
@@ -187,7 +182,7 @@ If there is a `restart` script defined, these events are run, otherwise
187182
* `restart`
188183
* `postrestart`
189184

190-
#### [`npm run <user defined>`](/cli/v7/commands/npm-run)
185+
#### [`npm run <user defined>`](/cli/v7/commands/npm-run-script)
191186

192187
* `pre<user-defined>`
193188
* `<user-defined>`

package-lock.json

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)