Skip to content

update some CLI ref commands for 3.1 #17101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 18, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
update CLI ref commands for 3.1
  • Loading branch information
mairaw committed Feb 15, 2020
commit c141bacab867762be2de12cd5d00c4b13dfdf1cb
2 changes: 0 additions & 2 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,6 @@
/docs/core/run-time-config/** @gewarren
# Tools
/docs/core/tools/** @tdykstra
# Tools - CLI ref
/docs/core/tools/dotnet-** @mairaw
# Tutorials
/docs/core/tutorials/** @tdykstra

Expand Down
2 changes: 0 additions & 2 deletions docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,6 @@
"docs/core/run-time-config/**/**.md": "gewarren",
"docs/core/testing/**/**.md": "billwagner",
"docs/core/tools/**/**.md": "tdykstra",
"docs/core/tools/dotnet-**.md": "mairaw",
"docs/core/tutorials/**/**.md": "tdykstra",
"docs/core/versions/**/**.md": "billwagner",
"docs/core/whats-new/**/**.md": "Thraka",
Expand Down Expand Up @@ -272,7 +271,6 @@
"docs/core/run-time-config/**/**.md": "gewarren",
"docs/core/testing/**/**.md": "wiwagn",
"docs/core/tools/**/**.md": "tdykstra",
"docs/core/tools/dotnet-**.md": "mairaw",
"docs/core/tutorials/**/**.md": "tdykstra",
"docs/core/versions/**/**.md": "wiwagn",
"docs/core/whats-new/**/**.md": "adegeo",
Expand Down
8 changes: 2 additions & 6 deletions docs/core/tools/dotnet-add-package.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
---
title: dotnet add package command
description: The 'dotnet add package' command provides a convenient option to add a NuGet package reference to a project.
ms.date: 06/26/2019
ms.date: 02/14/2020
---
# dotnet add package

**This article applies to:** ✔️ .NET Core 1.x SDK and later versions

<!-- todo: uncomment when all CLI commands are reviewed
[!INCLUDE [topic-appliesto-net-core-all](../../../includes/topic-appliesto-net-core-all.md)]
-->
**This article applies to:** ✔️ .NET Core 2.x SDK and later versions

## Name

Expand Down
4 changes: 2 additions & 2 deletions docs/core/tools/dotnet-add-reference.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: dotnet add reference command
description: The dotnet add reference command provides a convenient option to add project to project references.
ms.date: 06/26/2019
ms.date: 02/14/2020
---
# dotnet add reference

**This article applies to:** ✔️ .NET Core 1.x SDK and later versions
**This article applies to:** ✔️ .NET Core 2.x SDK and later versions

<!-- todo: uncomment when all CLI commands are reviewed
[!INCLUDE [topic-appliesto-net-core-all](../../../includes/topic-appliesto-net-core-all.md)]
Expand Down
6 changes: 1 addition & 5 deletions docs/core/tools/dotnet-build-server.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
---
title: dotnet build-server command
description: The dotnet build-server command interacts with servers started by a build.
ms.date: 04/24/2019
ms.date: 02/14/2020
---
# dotnet build-server

**This article applies to:** ✔️ .NET Core 2.1 SDK and later versions

<!-- todo: uncomment when all CLI commands are reviewed
[!INCLUDE [topic-appliesto-net-core-21plus](../../../includes/topic-appliesto-net-core-21plus.md)]
-->

## Name

`dotnet build-server` - Interacts with servers started by a build.
Expand Down
14 changes: 5 additions & 9 deletions docs/core/tools/dotnet-build.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
---
title: dotnet build command
description: The dotnet build command builds a project and all of its dependencies.
ms.date: 10/14/2019
ms.date: 02/14/2020
---
# dotnet build

**This article applies to:** ✔️ .NET Core 1.x SDK and later versions

<!-- todo: uncomment when all CLI commands are reviewed
[!INCLUDE [topic-appliesto-net-core-all](../../../includes/topic-appliesto-net-core-all.md)]
-->
**This article applies to:** ✔️ .NET Core 2.x SDK and later versions

## Name

Expand Down Expand Up @@ -69,7 +65,7 @@ The project or solution file to build. If a project or solution file isn't speci

## Options

- **`-c|--configuration {Debug|Release}`**
- **`-c|--configuration <CONFIGURATION>`**

Defines the build configuration. The default for most projects is `Debug`, but you can override the build configuration settings in your project.

Expand All @@ -79,7 +75,7 @@ The project or solution file to build. If a project or solution file isn't speci

- **`--force`**

Forces all dependencies to be resolved even if the last restore was successful. Specifying this flag is the same as deleting the *project.assets.json* file. Available since .NET Core 2.0 SDK.
Forces all dependencies to be resolved even if the last restore was successful. Specifying this flag is the same as deleting the *project.assets.json* file.

- **`-h|--help`**

Expand All @@ -99,7 +95,7 @@ The project or solution file to build. If a project or solution file isn't speci

- **`--no-restore`**

Doesn't execute an implicit restore during build. Available since .NET Core 2.0 SDK.
Doesn't execute an implicit restore during build.

- **`--nologo`**

Expand Down
12 changes: 4 additions & 8 deletions docs/core/tools/dotnet-clean.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
---
title: dotnet clean command
description: The dotnet clean command cleans the current directory.
ms.date: 06/26/2019
ms.date: 02/14/2020
---
# dotnet clean

**This article applies to:** ✔️ .NET Core 1.x SDK and later versions

<!-- todo: uncomment when all CLI commands are reviewed
[!INCLUDE [topic-appliesto-net-core-all](../../../includes/topic-appliesto-net-core-all.md)]
-->
**This article applies to:** ✔️ .NET Core 2.x SDK and later versions

## Name

Expand All @@ -35,7 +31,7 @@ The MSBuild project or solution to clean. If a project or solution file is not s

## Options

* **`-c|--configuration {Debug|Release}`**
* **`-c|--configuration <CONFIGURATION>`**

Defines the build configuration. The default value is `Debug`. This option is only required when cleaning if you specified it during build time.

Expand All @@ -61,7 +57,7 @@ The MSBuild project or solution to clean. If a project or solution file is not s

* **`-r|--runtime <RUNTIME_IDENTIFIER>`**

Cleans the output folder of the specified runtime. This is used when a [self-contained deployment](../deploying/index.md#publish-self-contained) was created. Option available since .NET Core 2.0 SDK.
Cleans the output folder of the specified runtime. This is used when a [self-contained deployment](../deploying/index.md#publish-self-contained) was created.

* **`-v|--verbosity <LEVEL>`**

Expand Down
12 changes: 4 additions & 8 deletions docs/core/tools/dotnet-help.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
---
title: dotnet help command
description: The dotnet help command shows more detailed documentation online for the specified command.
ms.date: 08/08/2019
ms.date: 02/14/2020
---
# dotnet help reference

**This article applies to:** ✔️ .NET Core 2.0 SDK and later versions

<!-- todo: uncomment when all CLI commands are reviewed
[!INCLUDE [topic-appliesto-net-core-all](../../../includes/topic-appliesto-net-core-2plus.md)]
-->

## Name

`dotnet help` - Shows more detailed documentation online for the specified command.
Expand All @@ -25,19 +21,19 @@ The `dotnet help` command opens up the reference page for more detailed informat

## Arguments

* **`COMMAND_NAME`**
- **`COMMAND_NAME`**

Name of the .NET Core CLI command. For a list of the valid CLI commands, see [CLI commands](index.md#cli-commands).

## Options

* **`-h|--help`**
- **`-h|--help`**

Prints out a short help for the command.

## Examples

* Opens the documentation page for the [dotnet new](dotnet-new.md) command:
- Opens the documentation page for the [dotnet new](dotnet-new.md) command:

```dotnetcli
dotnet help new
Expand Down
46 changes: 20 additions & 26 deletions docs/core/tools/dotnet-list-package.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: dotnet list package command
description: The 'dotnet list package' command provides a convenient option to list the package references for a project or solution.
ms.date: 06/26/2019
ms.date: 02/14/2020
---
# dotnet list package

[!INCLUDE [topic-appliesto-net-core-22plus](../../../includes/topic-appliesto-net-core-22plus.md)]
**This article applies to:** ✔️ .NET Core 2.2 SDK and later versions

## Name

Expand All @@ -27,7 +27,7 @@ The `dotnet list package` command provides a convenient option to list all NuGet
Project 'SentimentAnalysis' has the following package references
[netcoreapp2.1]:
Top-level Package Requested Resolved
> Microsoft.ML 0.11.0 0.11.0
> Microsoft.ML 1.4.0 1.4.0
> Microsoft.NETCore.App (A) [2.1.0, ) 2.1.0

(A) : Auto-referenced package.
Expand All @@ -40,27 +40,21 @@ Use the `--outdated` option to find out if there are newer versions available of
```output
The following sources were used:
https://api.nuget.org/v3/index.json
C:\Program Files (x86)\Microsoft SDKs\NuGetPackages\

Project `SentimentAnalysis` has the following updates to its packages
[netcoreapp2.1]:
Top-level Package Requested Resolved Latest
> Microsoft.ML 0.11.0 0.11.0 1.0.0-preview
> Microsoft.ML 1.4.0 1.4.0 1.5.0-preview
```

If you need to find out whether your project has transitive dependencies, use the `--include-transitive` option. Transitive dependencies occur when you add a package to your project that in turn relies on another package. The following example shows the output from running the `dotnet list package --include-transitive` command for the [HelloPlugin](https://github.com/dotnet/samples/tree/master/core/extensions/AppWithPlugin/HelloPlugin) project, which displays top-level packages and the packages they depend on:

```output
Project 'HelloPlugin' has the following package references
[netcoreapp3.0]:
Top-level Package Requested Resolved
> Microsoft.NETCore.Platforms (A) [3.0.0-preview3.19128.7, ) 3.0.0-preview3.19128.7
> Microsoft.WindowsDesktop.App (A) [3.0.0-preview3-27504-2, ) 3.0.0-preview3-27504-2

Transitive Package Resolved
> Microsoft.NETCore.Targets 2.0.0
> PluginBase 1.0.0

(A) : Auto-referenced package.
Transitive Package Resolved
> PluginBase 1.0.0
```

## Arguments
Expand All @@ -71,61 +65,61 @@ The project or solution file to operate on. If not specified, the command search

## Options

* **`--config <SOURCE>`**
- **`--config <SOURCE>`**

The NuGet sources to use when searching for newer packages. Requires the `--outdated` option.

* **`--framework <FRAMEWORK>`**
- **`--framework <FRAMEWORK>`**

Displays only the packages applicable for the specified [target framework](../../standard/frameworks.md). To specify multiple frameworks, repeat the option multiple times. For example: `--framework netcoreapp2.2 --framework netstandard2.0`.

* **`-h|--help`**
- **`-h|--help`**

Prints out a short help for the command.

* **`--highest-minor`**
- **`--highest-minor`**

Considers only the packages with a matching major version number when searching for newer packages. Requires the `--outdated` option.

* **`--highest-patch`**
- **`--highest-patch`**

Considers only the packages with a matching major and minor version numbers when searching for newer packages. Requires the `--outdated` option.

* **`--include-prerelease`**
- **`--include-prerelease`**

Considers packages with prerelease versions when searching for newer packages. Requires the `--outdated` option.

* **`--include-transitive`**
- **`--include-transitive`**

Lists transitive packages, in addition to the top-level packages. When specifying this option, you get a list of packages that the top-level packages depend on.

* **`--interactive`**
- **`--interactive`**

Allows the command to stop and wait for user input or action. For example, to complete authentication. Available since .NET Core 3.0 SDK.

* **`--outdated`**
- **`--outdated`**

Lists packages that have newer versions available.

* **`-s|--source <SOURCE>`**
- **`-s|--source <SOURCE>`**

The NuGet sources to use when searching for newer packages. Requires the `--outdated` option.

## Examples

* List package references of a specific project:
- List package references of a specific project:

```dotnetcli
dotnet list SentimentAnalysis.csproj package
```

* List package references that have newer versions available, including prerelease versions:
- List package references that have newer versions available, including prerelease versions:

```dotnetcli
dotnet list package --outdated --include-prerelease
```

* List package references for a specific target framework:
- List package references for a specific target framework:

```dotnetcli
dotnet list package --framework netcoreapp3.0
Expand Down
8 changes: 2 additions & 6 deletions docs/core/tools/dotnet-list-reference.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
---
title: dotnet list reference command
description: The dotnet list reference command provides a convenient option to list project to project references.
ms.date: 06/26/2019
ms.date: 02/14/2020
---
# dotnet list reference

**This article applies to:** ✔️ .NET Core 1.x SDK and later versions

<!-- todo: uncomment when all CLI commands are reviewed
[!INCLUDE [topic-appliesto-net-core-all](../../../includes/topic-appliesto-net-core-all.md)]
-->
**This article applies to:** ✔️ .NET Core 2.x SDK and later versions

## Name

Expand Down
4 changes: 2 additions & 2 deletions docs/core/tools/dotnet-migrate.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: dotnet migrate command
description: The dotnet migrate command migrates a project and all of its dependencies.
ms.date: 01/07/2020
ms.date: 02/14/2020
---
# dotnet migrate

**This article applies to:** ✔️ .NET Core 1.x SDK ✔️ .NET Core 2.x SDK
**This article applies to:** ✔️ .NET Core 2.x SDK

## Name

Expand Down
Loading