dotnet command

This topic applies to: ✓ .NET Core 1.x .NET Core 2.x

Name

dotnet - General driver for running the command-line commands.

Synopsis

dotnet [command] [arguments] [--additional-deps] [--additionalprobingpath] [-d|--diagnostics] [--fx-version] [-h|--help] [--info] [--roll-forward-on-no-candidate-fx] [-v|--verbose] [--version]

Description

dotnet is a generic driver for the Command Line Interface (CLI) toolchain. Invoked on its own, it provides brief usage instructions.

Each specific feature is implemented as a command. In order to use the feature, the command is specified after dotnet, such as dotnet build. All of the arguments following the command are its own arguments.

The only time dotnet is used as a command on its own is to run framework-dependent apps. Specify an application DLL after the dotnet verb to execute the application (for example, dotnet myapp.dll).

Options

--additionaldeps <PATH>

Path to additonal deps.json file.

--additionalprobingpath <PATH>

Path containing probing policy and assemblies to probe.

-d|--diagnostics

Enables diagnostic output.

--fx-version <VERSION>

Version of the installed .NET Core runtime to use to run the application.

-h|--help

Prints out a short help for the command. If using with dotnet, it also prints a list of the available commands.

--info

Prints out detailed information about the CLI tooling and the environment, such as the current operating system, commit SHA for the version, and other information.

--roll-forward-on-no-candidate-fx

Rolls forward on no candidate shared framework.

-v|--verbose

Enables verbose output.

--version

Prints out the version of the .NET Core SDK in use.

dotnet commands

General

Command Function
dotnet build Builds a .NET Core application.
dotnet clean Clean build outputs.
dotnet help Shows more detailed documentation online for the command.
dotnet migrate Migrates a valid Preview 2 project to a .NET Core SDK 1.0 project.
dotnet msbuild Provides access to the MSBuild command line.
dotnet new Initializes a C# or F# project for a given template.
dotnet pack Creates a NuGet package of your code.
dotnet publish Publishes a .NET framework-dependent or self-contained application.
dotnet restore Restores the dependencies for a given application.
dotnet run Runs the application from source.
dotnet sln Options to add, remove, and list projects in a solution file.
dotnet store Stores assemblies in the runtime package store.
dotnet test Runs tests using a test runner.

Project references

Command Function
dotnet add reference Add a project reference.
dotnet list reference List project references.
dotnet remove reference Remove a project reference.

NuGet packages

Command Function
dotnet add package Add a NuGet package.
dotnet remove package Remove a NuGet package.

NuGet commands

Command Function
dotnet nuget delete Deletes or unlists a package from the server.
dotnet nuget locals Clears or lists local NuGet resources such as http-request cache, temporary cache, or machine-wide global packages folder.
dotnet nuget push Pushes a package to the server and publishes it.

Examples

Initialize a sample .NET Core console application that can be compiled and run:

dotnet new console

Restore dependencies for a given application:

dotnet restore

Build a project and its dependencies in a given directory:

dotnet build

Run a framework-dependent app named myapp.dll:

dotnet myapp.dll

Environment variables

DOTNET_PACKAGES

The primary package cache. If not set, it defaults to $HOME/.nuget/packages on Unix or %HOME%\NuGet\Packages on Windows.

DOTNET_SERVICING

Specifies the location of the servicing index to use by the shared host when loading the runtime.

DOTNET_CLI_TELEMETRY_OPTOUT

Specifies whether data about the .NET Core tools usage is collected and sent to Microsoft. Set to true to opt-out of the telemetry feature (values true, 1, or yes accepted); otherwise, set to false to opt-in to the telemetry features (values false, 0, or no accepted). If not set, the defaults is false, and the telemetry feature is active.