1dotnet command(1) .NET Core dotnet command(1)
2
7 dotnet - A tool for managing .NET source code and binaries.
8
10 .NET Core 2.1
11 dotnet [command] [arguments] [--additional-deps] [--additionalprobingpath] [-d|--diagnostics] [--fx-version]
12 [-h|--help] [--info] [--list-runtimes] [--list-sdks] [--roll-forward-on-no-candidate-fx] [-v|--verbosity] [--version]
13 .NET Core 2.0
15 dotnet [command] [arguments] [--additional-deps] [--additionalprobingpath] [-d|--diagnostics]
16 [--fx-version] [-h|--help] [--info] [--roll-forward-on-no-candidate-fx] [-v|--verbosity] [--version]
17 .NET Core 1.x
19 dotnet [command] [arguments] [--additionalprobingpath] [-d|--diagnostics] [--fx-version]
20 [-h|--help] [--info] [-v|--verbosity] [--version]
21 * * * * *
23
25 dotnet is a tool for managing .NET source code and binaries. It expos‐
26 es commands that perform specific tasks, such as dotnet build and dot‐
27 net run. Each command defines its own arguments. Type --help after
28 each command to access brief help documentation.
29 dotnet can be used to run applications, by specifying an application
31 DLL, such as dotnet myapp.dll. See .NET Core application deployment
32 for to learn about deployment options.
33
35 .NET Core 2.1
36 --additional-deps <PATH>
37 Path to additional deps.json file.
39 --additionalprobingpath <PATH>
41 Path containing probing policy and assemblies to probe.
43 -d|--diagnostics
45 Enables diagnostic output.
47 --fx-version <VERSION>
49 Version of the .NET Core runtime to use to run the application.
51 -h|--help
53 Prints out documentation for a given command, such as dotnet build
55 --help. dotnet --help prints a list of available commands.
56 --info
58 Prints out detailed information about a .NET Core installation and the
60 machine environment, such as the current operating system, and commit
61 SHA of the .NET Core version.
62 --list-runtimes
64 Displays the installed .NET Core runtimes.
66 --list-sdks
68 Displays the installed .NET Core SDKs.
70 --roll-forward-on-no-candidate-fx <N>
72 Defines behavior when the required shared framework is not available.
74 N can be: * 0 - Disable even minor version roll forward. * 1 - Roll
75 forward on minor version, but not on major version. This is the de‐
76 fault behavior. * 2 - Roll forward on minor and major versions.
77 For more information, see Roll forward.
79 -v|--verbosity <LEVEL>
81 Sets the verbosity level of the command. Allowed values are q[uiet],
83 m[inimal], n[ormal], d[etailed], and diag[nostic]. Not supported in
84 every command; see specific command page to determine if this option is
85 available.
86 --version
88 Prints out the version of the .NET Core SDK in use.
90 .NET Core 2.0
92 --additional-deps <PATH>
93 Path to additional deps.json file.
95 --additionalprobingpath <PATH>
97 Path containing probing policy and assemblies to probe.
99 -d|--diagnostics
101 Enables diagnostic output.
103 --fx-version <VERSION>
105 Version of the .NET Core runtime to use to run the application.
107 -h|--help
109 Prints out documentation for a given command, such as dotnet build
111 --help. dotnet --help prints a list of available commands.
112 --info
114 Prints out detailed information about a .NET Core installation and the
116 machine environment, such as the current operating system, and commit
117 SHA of the .NET Core version.
118 --roll-forward-on-no-candidate-fx
120 Disables minor version roll forward, if set to 0. For more informa‐
122 tion, see Roll forward.
123 -v|--verbosity <LEVEL>
125 Sets the verbosity level of the command. Allowed values are q[uiet],
127 m[inimal], n[ormal], d[etailed], and diag[nostic]. Not supported in
128 every command; see specific command page to determine if this option is
129 available.
130 --version
132 Prints out the version of the .NET Core SDK in use.
134 .NET Core 1.x
136 --additionalprobingpath <PATH>
137 Path containing probing policy and assemblies to probe.
139 -d|--diagnostics
141 Enables diagnostic output.
143 --fx-version <VERSION>
145 Version of the .NET Core runtime to use to run the application.
147 -h|--help
149 Prints out documentation for a given command, such as dotnet build
151 --help. dotnet --help prints a list of available commands.
152 --info
154 Prints out detailed information about a .NET Core installation and the
156 machine environment, such as the current operating system, and commit
157 SHA of the .NET Core version.
158 -v|--verbosity <LEVEL>
160 Sets the verbosity level of the command. Allowed values are q[uiet],
162 m[inimal], n[ormal], d[etailed], and diag[nostic]. Not supported in
163 every command; see specific command page to determine if this option is
164 available.
165 --version
167 Prints out the version of the .NET Core SDK in use.
169 * * * * *
171 dotnet commands
173 General
174 .NET Core 2.1
175 Command Function
176 ─────────────────────────────────────────────────
177 dotnet build Builds a .NET Core appli‐
178 cation.
179 dotnet build-server Interacts with servers
180 started by a build.
181 dotnet clean Clean build outputs.
182 dotnet help Shows more detailed docu‐
183 mentation online for the
184 command.
185 dotnet migrate Migrates a valid Preview 2
186 project to a .NET Core SDK
187 1.0 project.
188 dotnet msbuild Provides access to the MS‐
189 Build command line.
190 dotnet new Initializes a C# or F#
191 project for a given tem‐
192 plate.
193 dotnet pack Creates a NuGet package of
194 your code.
195 dotnet publish Publishes a .NET frame‐
196 work-dependent or self-
197 contained application.
198 dotnet restore Restores the dependencies
200 for a given application.
201 dotnet run Runs the application from
202 source.
203 dotnet sln Options to add, remove,
204 and list projects in a so‐
205 lution file.
206 dotnet store Stores assemblies in the
207 runtime package store.
208 dotnet test Runs tests using a test
209 runner.
210 .NET Core 2.0
212 Command Function
213 ────────────────────────────────────────────
214 dotnet build Builds a .NET Core appli‐
215 cation.
216 dotnet clean Clean build outputs.
217 dotnet help Shows more detailed docu‐
218 mentation online for the
219 command.
220 dotnet migrate Migrates a valid Preview 2
221 project to a .NET Core SDK
222 1.0 project.
223 dotnet msbuild Provides access to the MS‐
224 Build command line.
225 dotnet new Initializes a C# or F#
226 project for a given tem‐
227 plate.
228 dotnet pack Creates a NuGet package of
229 your code.
230 dotnet publish Publishes a .NET frame‐
231 work-dependent or self-
232 contained application.
233 dotnet restore Restores the dependencies
234 for a given application.
235 dotnet run Runs the application from
236 source.
237 dotnet sln Options to add, remove,
238 and list projects in a so‐
239 lution file.
240 dotnet store Stores assemblies in the
241 runtime package store.
242 dotnet test Runs tests using a test
243 runner.
244 .NET Core 1.x
246 Command Function
247 ────────────────────────────────────────────
248 dotnet build Builds a .NET Core appli‐
249 cation.
250 dotnet clean Clean build outputs.
251 dotnet migrate Migrates a valid Preview 2
252 project to a .NET Core SDK
253 1.0 project.
254 dotnet msbuild Provides access to the MS‐
255 Build command line.
256 dotnet new Initializes a C# or F#
257 project for a given tem‐
258 plate.
259 dotnet pack Creates a NuGet package of
260 your code.
261 dotnet publish Publishes a .NET frame‐
262 work-dependent or self-
263 contained application.
264 dotnet restore Restores the dependencies
266 for a given application.
267 dotnet run Runs the application from
268 source.
269 dotnet sln Options to add, remove,
270 and list projects in a so‐
271 lution file.
272 dotnet test Runs tests using a test
273 runner.
274 * * * * *
276 Project references
278 Command Function
279 ─────────────────────────────────────────────────────
280 dotnet add reference Adds a project reference.
281 dotnet list reference Lists project references.
282 dotnet remove reference Removes a project refer‐
283 ence.
284 NuGet packages
286 Command Function
287 ─────────────────────────────────────────────────
288 dotnet add package Adds a NuGet package.
289 dotnet remove package Removes a NuGet package.
290 NuGet commands
292 Command Function
293 ─────────────────────────────────────────────────
294 dotnet nuget delete Deletes or unlists a pack‐
295 age from the server.
296 dotnet nuget locals Clears or lists local
297 NuGet resources such as
298 http-request cache, tempo‐
299 rary cache, or machine-
300 wide global packages fold‐
301 er.
302 dotnet nuget push Pushes a package to the
303 server and publishes it.
304 Global Tools commands
306 .NET Core Global Tools are available starting with .NET Core SDK
307 2.1.300:
308 Command Function
310 ───────────────────────────────────────────────────
311 dotnet tool install Installs a Global Tool on
312 your machine.
313 dotnet tool list Lists all Global Tools
314 currently installed in the
315 default directory on your
316 machine or in the speci‐
317 fied path.
318 dotnet tool uninstall Uninstalls a Global Tool
319 from your machine.
320 dotnet tool update Updates a Global Tool on
321 your machine.
322 Additional tools
324 Starting with .NET Core SDK 2.1.300, a number of tools that were avail‐
325 able only on a per project basis using DotnetCliToolReference are now
326 available as part of the .NET Core SDK. These tools are listed in the
327 following table:
328 Tool Function
330 ──────────────────────────────────────────
331 dev-certs Creates and manages devel‐
332 opment certificates.
333 ef Entity Framework Core com‐
334 mand-line tools.
335 sql-cache SQL Server cache command-
336 line tools.
337 user-secrets Manages development user
338 secrets.
339 watch Starts a file watcher that
340 runs a command when files
341 change.
342 For more information about each tool, type dotnet <tool-name> --help.
344
346 Creates a new .NET Core console application:
347 dotnet new console
349 Restore dependencies for a given application:
351 dotnet restore
353 Build a project and its dependencies in a given directory:
355 dotnet build
357 Run an application DLL, such as myapp.dll:
359 dotnet myapp.dll
361
363 .NET Core 2.1
364 DOTNET_PACKAGES
365 The primary package cache. If not set, it defaults to
367 $HOME/.nuget/packages on Unix or %HOME%\NuGet\Packages on Windows.
368 DOTNET_SERVICING
370 Specifies the location of the servicing index to use by the shared host
372 when loading the runtime.
373 DOTNET_CLI_TELEMETRY_OPTOUT
375 Specifies whether data about the .NET Core tools usage is collected and
377 sent to Microsoft. Set to true to opt-out of the telemetry feature
378 (values true, 1, or yes accepted). Otherwise, set to false to opt into
379 the telemetry features (values false, 0, or no accepted). If not set,
380 the default is false and the telemetry feature is active.
381 DOTNET_MULTILEVEL_LOOKUP
383 Specifies whether .NET Core runtime, shared framework, or SDK are re‐
385 solved from the global location. If not set, it defaults to true. Set
386 to false to not resolve from the global location and have isolated .NET
387 Core installations (values 0 or false are accepted). For more informa‐
388 tion about multi-level lookup, see Multi-level SharedFX Lookup.
389 DOTNET_ROLL_FORWARD_ON_NO_CANDIDATE_FX
391 Disables minor version roll forward, if set to 0. For more informa‐
393 tion, see Roll forward.
394 .NET Core 2.0
396 DOTNET_PACKAGES
397 The primary package cache. If not set, it defaults to
399 $HOME/.nuget/packages on Unix or %HOME%\NuGet\Packages on Windows.
400 DOTNET_SERVICING
402 Specifies the location of the servicing index to use by the shared host
404 when loading the runtime.
405 DOTNET_CLI_TELEMETRY_OPTOUT
407 Specifies whether data about the .NET Core tools usage is collected and
409 sent to Microsoft. Set to true to opt-out of the telemetry feature
410 (values true, 1, or yes accepted). Otherwise, set to false to opt into
411 the telemetry features (values false, 0, or no accepted). If not set,
412 the default is false and the telemetry feature is active.
413 DOTNET_MULTILEVEL_LOOKUP
415 Specifies whether .NET Core runtime, shared framework, or SDK are re‐
417 solved from the global location. If not set, it defaults to true. Set
418 to false to not resolve from the global location and have isolated .NET
419 Core installations (values 0 or false are accepted). For more informa‐
420 tion about multi-level lookup, see Multi-level SharedFX Lookup.
421 .NET Core 1.x
423 DOTNET_PACKAGES
424 The primary package cache. If not set, it defaults to
426 $HOME/.nuget/packages on Unix or %HOME%\NuGet\Packages on Windows.
427 DOTNET_SERVICING
429 Specifies the location of the servicing index to use by the shared host
431 when loading the runtime.
432 DOTNET_CLI_TELEMETRY_OPTOUT
434 Specifies whether data about the .NET Core tools usage is collected and
436 sent to Microsoft. Set to true to opt-out of the telemetry feature
437 (values true, 1, or yes accepted). Otherwise, set to false to opt into
438 the telemetry features (values false, 0, or no accepted). If not set,
439 the default is false and the telemetry feature is active.
440 * * * * *
442 dotnet command(1)