1dotnet new command(1) .NET Core dotnet new command(1)
2
7 dotnet new - Creates a new project, configuration file, or solution
8 based on the specified template.
9
11 .NET Core 2.1
12 dotnet new <TEMPLATE> [--force] [-i|--install] [-lang|--language] [-n|--name] [--nuget-source] [-o|--output]
13 [-u|--uninstall] [Template options]
14 dotnet new <TEMPLATE> [-l|--list] [--type]
15 dotnet new [-h|--help]
16 .NET Core 2.0
18 dotnet new <TEMPLATE> [--force] [-i|--install] [-lang|--language] [-n|--name] [-o|--output] [-u|--uninstall] [Template options]
19 dotnet new <TEMPLATE> [-l|--list] [--type]
20 dotnet new [-h|--help]
21 .NET Core 1.x
23 dotnet new <TEMPLATE> [-lang|--language] [-n|--name] [-o|--output] [-all|--show-all] [-h|--help] [Template options]
24 dotnet new <TEMPLATE> [-l|--list]
25 dotnet new [-all|--show-all]
26 dotnet new [-h|--help]
27 * * * * *
29
31 The dotnet new command provides a convenient way to initialize a valid
32 .NET Core project.
33 The command calls the template engine to create the artifacts on disk
35 based on the specified template and options.
36 Arguments
38 TEMPLATE
39 The template to instantiate when the command is invoked. Each template
41 might have specific options you can pass. For more information, see
42 Template options.
43 .NET Core 2.1
45 The command contains a default list of templates. Use dotnet new -l to
46 obtain a list of the available templates. The following table shows
47 the templates that come pre-installed with the .NET Core SDK 2.1.300.
48 The default language for the template is shown inside the brackets.
49 Template descrip‐ Template name Languages
51 tion
52 ───────────────────────────────────────────────────
53 Console application console [C#], F#, VB
54 Class library classlib [C#], F#, VB
55 Unit test project mstest [C#], F#, VB
56 xUnit test project xunit [C#], F#, VB
57 NUnit test project nunit [C#], F#, VB
58 Razor page page [C#]
59 MVC ViewImports viewimports [C#]
60 MVC ViewStart viewstart [C#]
61 ASP.NET Core empty web [C#], F#
62 ASP.NET Core Web mvc [C#], F#
63 App (Model-View-
64 Controller)
65 ASP.NET Core Web razor, webapp [C#]
68 App
69 ASP.NET Core with angular [C#]
70 Angular
71 ASP.NET Core with react [C#]
72 React.js
73 ASP.NET Core with reactredux [C#]
74 React.js and Redux
75 ASP.NET Core Web webapi [C#], F#
76 API
77 Razor class library razorclasslib [C#]
78 global.json file globaljson
79 NuGet config nugetconfig
80 Web config webconfig
81 Solution file sln
82 .NET Core 2.0
84 The command contains a default list of templates. Use dotnet new -l to
85 obtain a list of the available templates. The following table shows
86 the templates that come pre-installed with the .NET Core SDK 2.0. The
87 default language for the template is shown inside the brackets.
88 Template descrip‐ Template name Languages
90 tion
91 ───────────────────────────────────────────────────
92 Console application console [C#], F#, VB
93 Class library classlib [C#], F#, VB
94 Unit test project mstest [C#], F#, VB
95 xUnit test project xunit [C#], F#, VB
96 ASP.NET Core empty web [C#], F#
97 ASP.NET Core Web mvc [C#], F#
98 App (Model-View-
99 Controller)
100 ASP.NET Core Web razor [C#]
101 App
102 ASP.NET Core with angular [C#]
103 Angular
104 ASP.NET Core with react [C#]
105 React.js
106 ASP.NET Core with reactredux [C#]
107 React.js and Redux
108 ASP.NET Core Web webapi [C#], F#
109 API
110 global.json file globaljson
111 NuGet config nugetconfig
112 Web config webconfig
113 Solution file sln
114 Razor page page
115 MVC ViewImports viewimports
116 MVC ViewStart viewstart
117 .NET Core 1.x
119 The command contains a default list of templates. Use dotnet new -all
120 to obtain a list of the available templates. The following table shows
121 the templates that come pre-installed with the .NET Core SDK 1.x. The
122 default language for the template is shown inside the brackets.
123 Template descrip‐ Template name Languages
125 tion
126 ────────────────────────────────────────────────
127 Console application console [C#], F#
128 Class library classlib [C#], F#
129 Unit test project mstest [C#], F#
130 xUnit test project xunit [C#], F#
131 ASP.NET Core empty web [C#]
132 ASP.NET Core Web mvc [C#], F#
134 App
135 ASP.NET Core Web webapi [C#]
136 API
137 NuGet config nugetconfig
138 Web config webconfig
139 Solution file sln
140 * * * * *
142
144 .NET Core 2.1
145 --force
146 Forces content to be generated even if it would change existing files.
148 This is required when the output directory already contains a project.
149 -h|--help
151 Prints out help for the command. It can be invoked for the dotnet new
153 command itself or for any template, such as dotnet new mvc --help.
154 -i|--install <PATH|NUGET_ID>
156 Installs a source or template pack from the PATH or NUGET_ID provided.
158 If you want to install a prerelease version of a template package, you
159 need to specify the version in the format of <package-name>::<package-
160 version>. By default, dotnet new passes * for the version, which rep‐
161 resents the last stable package version. See an example at the Exam‐
162 ples section.
163 For information on creating custom templates, see Custom templates for
165 dotnet new.
166 -l|--list
168 Lists templates containing the specified name. If invoked for the dot‐
170 net new command, it lists the possible templates available for the giv‐
171 en directory. For example if the directory already contains a project,
172 it doesn’t list all project templates.
173 -lang|--language {C#|F#|VB}
175 The language of the template to create. The language accepted varies
177 by the template (see defaults in the arguments section). Not valid for
178 some templates.
179 [!NOTE] Some shells interpret # as a special character. In
181 those cases, you need to enclose the language parameter value,
182 such as dotnet new console -lang "F#".
183 -n|--name <OUTPUT_NAME>
185 The name for the created output. If no name is specified, the name of
187 the current directory is used.
188 --nuget-source
190 Specifies a NuGet source to use during install.
192 -o|--output <OUTPUT_DIRECTORY>
194 Location to place the generated output. The default is the current di‐
196 rectory.
197 --type
199 Filters templates based on available types. Predefined values are
201 “project”, “item” or “other”.
202 -u|--uninstall <PATH|NUGET_ID>
204 Uninstalls a source or template pack at the PATH or NUGET_ID provided.
206 [!NOTE] To uninstall a template using a PATH, you need to fully
208 qualify the path. For example, C:/Users/<USER>/Documents/Tem‐
209 plates/GarciaSoftware.ConsoleTemplate.CSharp will work, but
210 ./GarciaSoftware.ConsoleTemplate.CSharp from the containing
211 folder will not. Additionally, do not include a final terminat‐
212 ing directory slash on your template path.
213 .NET Core 2.0
215 --force
216 Forces content to be generated even if it would change existing files.
218 This is required when the output directory already contains a project.
219 -h|--help
221 Prints out help for the command. It can be invoked for the dotnet new
223 command itself or for any template, such as dotnet new mvc --help.
224 -i|--install <PATH|NUGET_ID>
226 Installs a source or template pack from the PATH or NUGET_ID provided.
228 If you want to install a prerelease version of a template package, you
229 need to specify the version in the format of <package-name>::<package-
230 version>. By default, dotnet new passes * for the version, which rep‐
231 resents the last stable package version. See an example at the Exam‐
232 ples section.
233 For information on creating custom templates, see Custom templates for
235 dotnet new.
236 -l|--list
238 Lists templates containing the specified name. If invoked for the dot‐
240 net new command, it lists the possible templates available for the giv‐
241 en directory. For example if the directory already contains a project,
242 it doesn’t list all project templates.
243 -lang|--language {C#|F#|VB}
245 The language of the template to create. The language accepted varies
247 by the template (see defaults in the arguments section). Not valid for
248 some templates.
249 [!NOTE] Some shells interpret # as a special character. In
251 those cases, you need to enclose the language parameter value,
252 such as dotnet new console -lang "F#".
253 -n|--name <OUTPUT_NAME>
255 The name for the created output. If no name is specified, the name of
257 the current directory is used.
258 -o|--output <OUTPUT_DIRECTORY>
260 Location to place the generated output. The default is the current di‐
262 rectory.
263 --type
265 Filters templates based on available types. Predefined values are
267 “project”, “item” or “other”.
268 -u|--uninstall <PATH|NUGET_ID>
270 Uninstalls a source or template pack at the PATH or NUGET_ID provided.
272 [!NOTE] To uninstall a template using a source PATH, you need to
274 fully qualify the path. For example, C:/Users/<USER>/Docu‐
275 ments/Templates/GarciaSoftware.ConsoleTemplate.CSharp will work,
276 but ./GarciaSoftware.ConsoleTemplate.CSharp from the containing
277 folder will not. Additionally, do not include a final terminat‐
278 ing directory slash on your template path.
279 If you are unable to determine the PATH or NUGET_ID argument
281 needed to uninstall a template, running dotnet new --uninstall
282 without an argument will list all installed templates and the
283 argument required to uninstall them.
284 .NET Core 1.x
286 -all|--show-all
287 Shows all templates for a specific type of project when running in the
289 context of the dotnet new command alone. When running in the context
290 of a specific template, such as dotnet new web -all, -all is interpret‐
291 ed as a force creation flag. This is required when the output directo‐
292 ry already contains a project.
293 -h|--help
295 Prints out help for the command. It can be invoked for the dotnet new
297 command itself or for any template, such as dotnet new mvc --help.
298 -l|--list
300 Lists templates containing the specified name. If invoked for the dot‐
302 net new command, it lists the possible templates available for the giv‐
303 en directory. For example if the directory already contains a project,
304 it doesn’t list all project templates.
305 -lang|--language {C#|F#}
307 The language of the template to create. The language accepted varies
309 by the template (see defaults in the arguments section). Not valid for
310 some templates.
311 [!NOTE] Some shells interpret # as a special character. In
313 those cases, you need to enclose the language parameter value,
314 such as dotnet new console -lang "F#".
315 -n|--name <OUTPUT_NAME>
317 The name for the created output. If no name is specified, the name of
319 the current directory is used.
320 -o|--output <OUTPUT_DIRECTORY>
322 Location to place the generated output. The default is the current di‐
324 rectory.
325 * * * * *
327 Template options
329 Each project template may have additional options available. The core
330 templates have the following additional options:
331 .NET Core 2.1
333 console, angular, react, reactredux, razorclasslib
334 --no-restore - Doesn’t execute an implicit restore during project cre‐
336 ation.
337 classlib
339 -f|--framework <FRAMEWORK> - Specifies the framework to target. Val‐
341 ues: netcoreapp2.0 to create a .NET Core Class Library or netstan‐
342 dard2.0 to create a .NET Standard Class Library. The default value is
343 netstandard2.0.
344 --no-restore - Doesn’t execute an implicit restore during project cre‐
346 ation.
347 mstest, xunit
349 -p|--enable-pack - Enables packaging for the project using dotnet pack.
351 --no-restore - Doesn’t execute an implicit restore during project cre‐
353 ation.
354 globaljson
356 --sdk-version <VERSION_NUMBER> - Specifies the version of the .NET Core
358 SDK to use in the global.json file.
359 web
361 --exclude-launch-settings - Exclude launchSettings.json from the gener‐
363 ated template.
364 --no-restore - Doesn’t execute an implicit restore during project cre‐
366 ation.
367 --no-https - Project doesn’t require HTTPS. This option only applies
369 if IndividualAuth or OrganizationalAuth are not being used.
370 webapi
372 -au|--auth <AUTHENTICATION_TYPE> - The type of authentication to use.
374 The possible values are:
375 · None - No authentication (Default).
377 · IndividualB2C - Individual authentication with Azure AD B2C.
379 · SingleOrg - Organizational authentication for a single tenant.
381 · Windows - Windows authentication.
383 --aad-b2c-instance <INSTANCE> - The Azure Active Directory B2C instance
385 to connect to. Use with IndividualB2C authentication. The default
386 value is https://login.microsoftonline.com/tfp/.
387 -ssp|--susi-policy-id <ID> - The sign-in and sign-up policy ID for this
389 project. Use with IndividualB2C authentication.
390 --aad-instance <INSTANCE> - The Azure Active Directory instance to con‐
392 nect to. Use with SingleOrg authentication. The default value is
393 https://login.microsoftonline.com/.
394 --client-id <ID> - The Client ID for this project. Use with Individu‐
396 alB2C or SingleOrg authentication. The default value is
397 11111111-1111-1111-11111111111111111.
398 --domain <DOMAIN> - The domain for the directory tenant. Use with Sin‐
400 gleOrg or IndividualB2C authentication. The default value is quali‐
401 fied.domain.name.
402 --tenant-id <ID> - The TenantId ID of the directory to connect to. Use
404 with SingleOrg authentication. The default value is
405 22222222-2222-2222-2222-222222222222.
406 -r|--org-read-access - Allows this application read-access to the di‐
408 rectory. Only applies to SingleOrg or MultiOrg authentication.
409 --exclude-launch-settings - Exclude launchSettings.json from the gener‐
411 ated template.
412 -uld|--use-local-db - Specifies LocalDB should be used instead of
414 SQLite. Only applies to Individual or IndividualB2C authentication.
415 --no-restore - Doesn’t execute an implicit restore during project cre‐
417 ation.
418 --no-https - Project doesn’t require HTTPS. app.UseHsts and app.Use‐
420 HttpsRedirection aren’t added to Startup.Configure. This option only
421 applies if Individual, IndividualB2C, SingleOrg, or MultiOrg aren’t be‐
422 ing used.
423 mvc, razor
425 -au|--auth <AUTHENTICATION_TYPE> - The type of authentication to use.
427 The possible values are:
428 · None - No authentication (Default).
430 · Individual - Individual authentication.
432 · IndividualB2C - Individual authentication with Azure AD B2C.
434 · SingleOrg - Organizational authentication for a single tenant.
436 · MultiOrg - Organizational authentication for multiple tenants.
438 · Windows - Windows authentication.
440 --aad-b2c-instance <INSTANCE> - The Azure Active Directory B2C instance
442 to connect to. Use with IndividualB2C authentication. The default
443 value is https://login.microsoftonline.com/tfp/.
444 -ssp|--susi-policy-id <ID> - The sign-in and sign-up policy ID for this
446 project. Use with IndividualB2C authentication.
447 -rp|--reset-password-policy-id <ID> - The reset password policy ID for
449 this project. Use with IndividualB2C authentication.
450 -ep|--edit-profile-policy-id <ID> - The edit profile policy ID for this
452 project. Use with IndividualB2C authentication.
453 --aad-instance <INSTANCE> - The Azure Active Directory instance to con‐
455 nect to. Use with SingleOrg or MultiOrg authentication. The default
456 value is https://login.microsoftonline.com/.
457 --client-id <ID> - The Client ID for this project. Use with Individu‐
459 alB2C, SingleOrg, or MultiOrg authentication. The default value is
460 11111111-1111-1111-11111111111111111.
461 --domain <DOMAIN> - The domain for the directory tenant. Use with Sin‐
463 gleOrg or IndividualB2C authentication. The default value is quali‐
464 fied.domain.name.
465 --tenant-id <ID> - The TenantId ID of the directory to connect to. Use
467 with SingleOrg authentication. The default value is
468 22222222-2222-2222-2222-222222222222.
469 --callback-path <PATH> - The request path within the application’s base
471 path of the redirect URI. Use with SingleOrg or IndividualB2C authen‐
472 tication. The default value is /signin-oidc.
473 -r|--org-read-access - Allows this application read-access to the di‐
475 rectory. Only applies to SingleOrg or MultiOrg authentication.
476 --exclude-launch-settings - Exclude launchSettings.json from the gener‐
478 ated template.
479 --use-browserlink - Includes BrowserLink in the project.
481 -uld|--use-local-db - Specifies LocalDB should be used instead of
483 SQLite. Only applies to Individual or IndividualB2C authentication.
484 --no-restore - Doesn’t execute an implicit restore during project cre‐
486 ation.
487 --no-https - Project doesn’t require HTTPS. app.UseHsts and app.Use‐
489 HttpsRedirection aren’t added to Startup.Configure. This option only
490 applies if Individual, IndividualB2C, SingleOrg, or MultiOrg aren’t be‐
491 ing used.
492 page
494 -na|--namespace <NAMESPACE_NAME>- Namespace for the generated code.
496 The default value is MyApp.Namespace.
497 -np|--no-pagemodel - Creates the page without a PageModel.
499 viewimports
501 -na|--namespace <NAMESPACE_NAME>- Namespace for the generated code.
503 The default value is MyApp.Namespace.
504 .NET Core 2.0
506 console, angular, react, reactredux
507 --no-restore - Doesn’t execute an implicit restore during project cre‐
509 ation.
510 classlib
512 -f|--framework <FRAMEWORK> - Specifies the framework to target. Val‐
514 ues: netcoreapp2.0 to create a .NET Core Class Library or netstan‐
515 dard2.0 to create a .NET Standard Class Library. The default value is
516 netstandard2.0.
517 --no-restore - Doesn’t execute an implicit restore during project cre‐
519 ation.
520 mstest, xunit
522 -p|--enable-pack - Enables packaging for the project using dotnet pack.
524 --no-restore - Doesn’t execute an implicit restore during project cre‐
526 ation.
527 globaljson
529 --sdk-version <VERSION_NUMBER> - Specifies the version of the .NET Core
531 SDK to use in the global.json file.
532 web
534 --use-launch-settings - Includes launchSettings.json in the generated
536 template output.
537 --no-restore - Doesn’t execute an implicit restore during project cre‐
539 ation.
540 webapi
542 -au|--auth <AUTHENTICATION_TYPE> - The type of authentication to use.
544 The possible values are:
545 · None - No authentication (Default).
547 · IndividualB2C - Individual authentication with Azure AD B2C.
549 · SingleOrg - Organizational authentication for a single tenant.
551 · Windows - Windows authentication.
553 --aad-b2c-instance <INSTANCE> - The Azure Active Directory B2C instance
555 to connect to. Use with IndividualB2C authentication. The default
556 value is https://login.microsoftonline.com/tfp/.
557 -ssp|--susi-policy-id <ID> - The sign-in and sign-up policy ID for this
559 project. Use with IndividualB2C authentication.
560 --aad-instance <INSTANCE> - The Azure Active Directory instance to con‐
562 nect to. Use with SingleOrg authentication. The default value is
563 https://login.microsoftonline.com/.
564 --client-id <ID> - The Client ID for this project. Use with Individu‐
566 alB2C or SingleOrg authentication. The default value is
567 11111111-1111-1111-11111111111111111.
568 --domain <DOMAIN> - The domain for the directory tenant. Use with Sin‐
570 gleOrg or IndividualB2C authentication. The default value is quali‐
571 fied.domain.name.
572 --tenant-id <ID> - The TenantId ID of the directory to connect to. Use
574 with SingleOrg authentication. The default value is
575 22222222-2222-2222-2222-222222222222.
576 -r|--org-read-access - Allows this application read-access to the di‐
578 rectory. Only applies to SingleOrg or MultiOrg authentication.
579 --use-launch-settings - Includes launchSettings.json in the generated
581 template output.
582 -uld|--use-local-db - Specifies LocalDB should be used instead of
584 SQLite. Only applies to Individual or IndividualB2C authentication.
585 --no-restore - Doesn’t execute an implicit restore during project cre‐
587 ation.
588 mvc, razor
590 -au|--auth <AUTHENTICATION_TYPE> - The type of authentication to use.
592 The possible values are:
593 · None - No authentication (Default).
595 · Individual - Individual authentication.
597 · IndividualB2C - Individual authentication with Azure AD B2C.
599 · SingleOrg - Organizational authentication for a single tenant.
601 · MultiOrg - Organizational authentication for multiple tenants.
603 · Windows - Windows authentication.
605 --aad-b2c-instance <INSTANCE> - The Azure Active Directory B2C instance
607 to connect to. Use with IndividualB2C authentication. The default
608 value is https://login.microsoftonline.com/tfp/.
609 -ssp|--susi-policy-id <ID> - The sign-in and sign-up policy ID for this
611 project. Use with IndividualB2C authentication.
612 -rp|--reset-password-policy-id <ID> - The reset password policy ID for
614 this project. Use with IndividualB2C authentication.
615 -ep|--edit-profile-policy-id <ID> - The edit profile policy ID for this
617 project. Use with IndividualB2C authentication.
618 --aad-instance <INSTANCE> - The Azure Active Directory instance to con‐
620 nect to. Use with SingleOrg or MultiOrg authentication. The default
621 value is https://login.microsoftonline.com/.
622 --client-id <ID> - The Client ID for this project. Use with Individu‐
624 alB2C, SingleOrg, or MultiOrg authentication. The default value is
625 11111111-1111-1111-11111111111111111.
626 --domain <DOMAIN> - The domain for the directory tenant. Use with Sin‐
628 gleOrg or IndividualB2C authentication. The default value is quali‐
629 fied.domain.name.
630 --tenant-id <ID> - The TenantId ID of the directory to connect to. Use
632 with SingleOrg authentication. The default value is
633 22222222-2222-2222-2222-222222222222.
634 --callback-path <PATH> - The request path within the application’s base
636 path of the redirect URI. Use with SingleOrg or IndividualB2C authen‐
637 tication. The default value is /signin-oidc.
638 -r|--org-read-access - Allows this application read-access to the di‐
640 rectory. Only applies to SingleOrg or MultiOrg authentication.
641 --use-launch-settings - Includes launchSettings.json in the generated
643 template output.
644 --use-browserlink - Includes BrowserLink in the project.
646 -uld|--use-local-db - Specifies LocalDB should be used instead of
648 SQLite. Only applies to Individual or IndividualB2C authentication.
649 --no-restore - Doesn’t execute an implicit restore during project cre‐
651 ation.
652 page
654 -na|--namespace <NAMESPACE_NAME>- Namespace for the generated code.
656 The default value is MyApp.Namespace.
657 -np|--no-pagemodel - Creates the page without a PageModel.
659 viewimports
661 -na|--namespace <NAMESPACE_NAME>- Namespace for the generated code.
663 The default value is MyApp.Namespace.
664 .NET Core 1.x
666 console, xunit, mstest, web, webapi
667 -f|--framework - Specifies the framework to target. Values: netcore‐
669 app1.0 or netcoreapp1.1. The default value is netcoreapp1.0.
670 classlib
672 -f|--framework - Specifies the framework to target. Values: netcore‐
674 app1.0, netcoreapp1.1, or netstandard1.0 to netstandard1.6. The de‐
675 fault value is netstandard1.4.
676 mvc
678 -f|--framework - Specifies the framework to target. Values: netcore‐
680 app1.0 or netcoreapp1.1. The default value is netcoreapp1.0.
681 -au|--auth - The type of authentication to use. Values: None or Indi‐
683 vidual. The default value is None.
684 -uld|--use-local-db - Specifies whether or not to use LocalDB instead
686 of SQLite. Values: true or false. The default value is false.
687 * * * * *
689
691 Create an F# console application project in the current directory:
692 dotnet new console -lang F#
694 Create a .NET Standard class library project in the specified directory
696 (available only with .NET Core SDK 2.0 or later versions):
697 dotnet new classlib -lang VB -o MyLibrary
699 Create a new ASP.NET Core C# MVC application project in the current di‐
701 rectory with no authentication:
702 dotnet new mvc -au None
704 Create a new xUnit application:
706 dotnet new xunit
708 List all templates available for MVC:
710 dotnet new mvc -l
712 Install version 2.0 of the Single Page Application templates for
714 ASP.NET Core (command option available for .NET Core SDK 1.1 and later
715 versions only):
716 dotnet new -i Microsoft.DotNet.Web.Spa.ProjectTemplates::2.0.0
718 Create a global.json in the current directory setting the SDK version
720 to 2.0.0 (available only with .NET Core SDK 2.0 or later versions):
721 dotnet new globaljson --sdk-version 2.0.0
723 See also
725 · Custom templates for dotnet new
726 · Create a custom template for dotnet new
728 · dotnet/dotnet-template-samples GitHub repo
730 · Available templates for dotnet new
732 dotnet new command(1)