DOTNET-NEW-SDK-TEMPLATES(1)

📦 version 6.0.136, in ubuntu jammy

✨ .NET default templates for `dotnet new` ✨

okay bestie, gather round, because this is DOTNET-NEW-SDK-TEMPLATES(1) and it is lowkey one of the most useful pages in the whole .NET universe 💖

The way that when you install the .NET SDK (https://dotnet.microsoft.com/download) you just… get over a dozen built-in templates for creating projects and files? Not me being dramatic, it's literally true. You get templates for console apps, class libraries, unit test projects, ASP.NET Core apps (including Angular (https://angular.io/) and React (https://reactjs.org/) projects), and configuration files. All of them. Pre-installed. No cap. 👑

To list the built-in templates, run the dotnet new command with the -l|--list option:

dotnet new --list

The following table shows the templates that come pre-installed with the .NET SDK. The default language for the template is shown inside the brackets. Click on the short name link to see the specific template options.

✨ THE ICONIC TEMPLATE LINEUP ✨

Console Application — short name console — languages [C#], F#, VB — tags Common/Console — introduced in 1.0
Class library — short name classlib — languages [C#], F#, VB — tags Common/Library — introduced in 1.0
WPF Application — short name wpf — languages [C#], VB — tags Common/WPF — introduced in 3.0 (5.0 for VB)
WPF Class library — short name wpflib — languages [C#], VB — tags Common/WPF — introduced in 3.0 (5.0 for VB)
WPF Custom Control Library — short name wpfcustomcontrollib — languages [C#], VB — tags Common/WPF — introduced in 3.0 (5.0 for VB)
WPF User Control Library — short name wpfusercontrollib — languages [C#], VB — tags Common/WPF — introduced in 3.0 (5.0 for VB)
Windows Forms (WinForms) Application — short name winforms — languages [C#], VB — tags Common/WinForms — introduced in 3.0 (5.0 for VB)
Windows Forms (WinForms) Class library — short name winformslib — languages [C#], VB — tags Common/WinForms — introduced in 3.0 (5.0 for VB)
Worker Service — short name worker — languages [C#] — tags Common/Worker/Web — introduced in 3.0
Unit Test Project — short name mstest — languages [C#], F#, VB — tags Test/MSTest — introduced in 1.0
NUnit 3 Test Project — short name nunit — languages [C#], F#, VB — tags Test/NUnit — introduced in 2.1.400
NUnit 3 Test Item — short name nunit-test — languages [C#], F#, VB — tags Test/NUnit — introduced in 2.2
xUnit Test Project — short name xunit — languages [C#], F#, VB — tags Test/xUnit — introduced in 1.0
Razor Component — short name razorcomponent — languages [C#] — tags Web/ASP.NET — introduced in 3.0
Razor Page — short name page — languages [C#] — tags Web/ASP.NET — introduced in 2.0
MVC ViewImports — short name viewimports — languages [C#] — tags Web/ASP.NET — introduced in 2.0
MVC ViewStart — short name viewstart — languages [C#] — tags Web/ASP.NET — introduced in 2.0
Blazor Server App — short name blazorserver — languages [C#] — tags Web/Blazor — introduced in 3.0
Blazor WebAssembly App — short name blazorwasm — languages [C#] — tags Web/Blazor/WebAssembly — introduced in 3.1.300
ASP.NET Core Empty — short name web — languages [C#], F# — tags Web/Empty — introduced in 1.0
ASP.NET Core Web App (Model-View-Controller) — short name mvc — languages [C#], F# — tags Web/MVC — introduced in 1.0
ASP.NET Core Web App — short names webapp, razor — languages [C#] — tags Web/MVC/Razor Pages — introduced in 2.2, 2.0
ASP.NET Core with Angular — short name angular — languages [C#] — tags Web/MVC/SPA — introduced in 2.0
ASP.NET Core with React.js — short name react — languages [C#] — tags Web/MVC/SPA — introduced in 2.0
ASP.NET Core with React.js and Redux — short name reactredux — languages [C#] — tags Web/MVC/SPA — introduced in 2.0
Razor Class Library — short name razorclasslib — languages [C#] — tags Web/Razor/Library/Razor Class Library — introduced in 2.1
ASP.NET Core Web API — short name webapi — languages [C#], F# — tags Web/WebAPI — introduced in 1.0
ASP.NET Core gRPC Service — short name grpc — languages [C#] — tags Web/gRPC — introduced in 3.0
dotnet gitignore file — short name gitignore — tags Config — introduced in 3.0
global.json file — short name globaljson — tags Config — introduced in 2.0
NuGet Config — short name nugetconfig — tags Config — introduced in 1.0
Dotnet local tool manifest file — short name tool-manifest — tags Config — introduced in 3.0
Web Config — short name webconfig — tags Config — introduced in 1.0
Solution File — short name sln — tags Solution — introduced in 1.0
Protocol Buffer File — short name proto — tags Web/gRPC — introduced in 3.0

🌸 Template options 🌸

Each template may have additional options available. The core templates have the following additional options:

💅 console

-f, --framework <FRAMEWORK> — Specifies the framework to target. Available since .NET Core 3.0 SDK.

The following table lists the default values according to the SDK version number you're using:

SDK version 5.0 → default value net5.0
SDK version 3.1 → default value netcoreapp3.1
SDK version 3.0 → default value netcoreapp3.0

The ability to create a project for an earlier TFM depends on having that version of the SDK installed. For example, if you have only SDK 5.0 installed, then the only value available for --framework is net5.0. If you install SDK 3.1, the value netcoreapp3.1 becomes available for --framework. If you install SDK 2.1, netcoreapp2.1 becomes available, and so on. So by specifying --framework netcoreapp2.1 you can use SDK 2.1 even while running dotnet new in SDK 5.0.

Alternatively, to create a project that targets a framework earlier than the SDK that you're using, you might be able to do it by installing the NuGet package for the template. Common (https://www.nuget.org/packages?q=Microsoft.DotNet.Common.ProjectTemplates), web (https://www.nuget.org/packages?q=Microsoft.DotNet.Web.ProjectTemplates), and SPA (https://www.nuget.org/packages?q=Microsoft.DotNet.Web.Spa.ProjectTemplates) project types use different packages per target framework moniker (TFM). For example, to create a console project that targets netcoreapp1.0, run dotnet new --install on Microsoft.DotNet.Common.ProjectTemplates.1.x.

--langVersion <VERSION_NUMBER> — Sets the LangVersion property in the created project file. For example, use --langVersion 7.3 to use C# 7.3. Not supported for F#. Available since .NET Core 2.2 SDK.

For a list of default C# versions, see Defaults.

--no-restore — If specified, doesn't execute an implicit restore during project creation. Available since .NET Core 2.2 SDK.

🎀 classlib

-f, --framework <FRAMEWORK> — Specifies the framework to target. Values: net5.0 or netcoreapp<version> to create a .NET Class Library or netstandard<version> to create a .NET Standard Class Library. The default value for .NET 5.0 SDK is net5.0.

To create a project that targets a framework earlier than the SDK that you're using, see --framework for console projects earlier in this article.

--langVersion <VERSION_NUMBER> — Sets the LangVersion property in the created project file. For example, use --langVersion 7.3 to use C# 7.3. Not supported for F#. Available since .NET Core 2.2 SDK.

For a list of default C# versions, see Defaults.

--no-restore — Doesn't execute an implicit restore during project creation.

🦋 wpf, wpflib, wpfcustomcontrollib, wpfusercontrollib

-f, --framework <FRAMEWORK> — Specifies the framework to target. The default value is net5.0. Available since .NET Core 3.1 SDK.

To create a project that targets a framework earlier than the SDK that you're using, see --framework for console projects earlier in this article.

--langVersion <VERSION_NUMBER> — Sets the LangVersion property in the created project file. For example, use --langVersion 7.3 to use C# 7.3.

For a list of default C# versions, see Defaults.

--no-restore — Doesn't execute an implicit restore during project creation.

🫶 winforms, winformslib

--langVersion <VERSION_NUMBER> — Sets the LangVersion property in the created project file. For example, use --langVersion 7.3 to use C# 7.3.

For a list of default C# versions, see Defaults.

--no-restore — Doesn't execute an implicit restore during project creation.

💜 worker, grpc

-f, --framework <FRAMEWORK> — Specifies the framework to target. The default value is netcoreapp3.1. Available since .NET Core 3.1 SDK.

To create a project that targets a framework earlier than the SDK that you're using, see --framework for console projects earlier in this article.

--exclude-launch-settings — Excludes launchSettings.json from the generated template.
--no-restore — Doesn't execute an implicit restore during project creation.

⭐ mstest, xunit

-f, --framework <FRAMEWORK> — Specifies the framework to target. Option available since .NET Core 3.0 SDK.

The following table lists the default values according to the SDK version number you're using:

SDK version 5.0 → default value net5.0
SDK version 3.1 → default value netcoreapp3.1
SDK version 3.0 → default value netcoreapp3.0

To create a project that targets a framework earlier than the SDK that you're using, see --framework for console projects earlier in this article.

-p, --enable-pack — Enables packaging for the project using dotnet pack.
--no-restore — Doesn't execute an implicit restore during project creation.

🍓 nunit

-f, --framework <FRAMEWORK> — Specifies the framework to target.

The following table lists the default values according to the SDK version number you're using:

SDK version 5.0 → default value net5.0
SDK version 3.1 → default value netcoreapp3.1
SDK version 3.0 → default value netcoreapp3.0
SDK version 2.2 → default value netcoreapp2.2
SDK version 2.1 → default value netcoreapp2.1

To create a project that targets a framework earlier than the SDK that you're using, see --framework for console projects earlier in this article.

-p, --enable-pack

bestie the page literally cuts off right here mid-option 😭 part 2 has the rest, keep scrolling energy 🫶

Enables packaging for the project using dotnet pack. 🎁

--no-restore — doesn't run an implicit restore while your project is being created. let it cook on its own, bestie.

🎀 page

-na, --namespace <NAMESPACE_NAME> — the namespace for your generated code. default is MyApp.Namespace.
-np, --no-pagemodel — makes the page without a PageModel. no model, no problem. 💅

🦋 viewimports, proto

-na, --namespace <NAMESPACE_NAME> — namespace for the generated code. default is MyApp.Namespace. yes, same one, she's consistent. ✨

🔥 blazorserver

-au, --auth <AUTHENTICATION_TYPE> — which flavor of authentication to use. the possible values are:
- None — no authentication (this is the default).
- Individual — individual authentication.
- IndividualB2C — individual authentication with Azure AD B2C.
- SingleOrg — organizational authentication for a single tenant.
- MultiOrg — organizational authentication for multiple tenants.
- Windows — Windows authentication.
--aad-b2c-instance <INSTANCE> — the Azure Active Directory B2C instance to connect to. use it with IndividualB2C authentication. default is https://login.microsoftonline.com/tfp/.
-ssp, --susi-policy-id <ID> — the sign-in and sign-up policy ID for this project. use it with IndividualB2C authentication.
-rp, --reset-password-policy-id <ID> — the reset password policy ID for this project. use it with IndividualB2C authentication.
-ep, --edit-profile-policy-id <ID> — the edit profile policy ID for this project. use it with IndividualB2C authentication.
--aad-instance <INSTANCE> — the Azure Active Directory instance to connect to. use it with SingleOrg or MultiOrg authentication. default is https://login.microsoftonline.com/.
--client-id <ID> — the Client ID for this project. use it with IndividualB2C, SingleOrg, or MultiOrg authentication. default is 11111111-1111-1111-11111111111111111.
--domain <DOMAIN> — the domain for the directory tenant. use it with SingleOrg or IndividualB2C authentication. default is qualified.domain.name.
--tenant-id <ID> — the TenantId ID of the directory to connect to. use it with SingleOrg authentication. default is 22222222-2222-2222-2222-222222222222.
--callback-path <PATH> — the request path within the application's base path of the redirect URI. use it with SingleOrg or IndividualB2C authentication. default is /signin-oidc.
-r, --org-read-access — lets this application have read-access to the directory. only applies to SingleOrg or MultiOrg authentication.
--exclude-launch-settings — keeps launchSettings.json out of the generated template. bye bestie 👋
--no-https — turns off HTTPS. this option only applies if Individual, IndividualB2C, SingleOrg, or MultiOrg aren't being used for --auth.
-uld, --use-local-db — says LocalDB should be used instead of SQLite. only applies to Individual or IndividualB2C authentication.
--no-restore — doesn't execute an implicit restore during project creation.

💖 blazorwasm

-f, --framework <FRAMEWORK> — picks the framework to target.

the default values depend on which SDK version number you're using:

SDK version 5.0 → net5.0
SDK version 3.1 → netcoreapp3.1

to create a project that targets a framework earlier than the SDK you're using, see --framework for console projects earlier in this article.

--no-restore — doesn't execute an implicit restore during project creation.
-ho, --hosted — includes an ASP.NET Core host for the Blazor WebAssembly app.
-au, --auth <AUTHENTICATION_TYPE> — the type of authentication to use. the possible values are:
- None — no authentication (this is the default).
- Individual — individual authentication.
- IndividualB2C — individual authentication with Azure AD B2C.
- SingleOrg — organizational authentication for a single tenant.
--authority <AUTHORITY> — the authority of the OIDC provider. use it with Individual authentication. default is https://login.microsoftonline.com/.
--aad-b2c-instance <INSTANCE> — the Azure Active Directory B2C instance to connect to. use it with IndividualB2C authentication. default is https://aadB2CInstance.b2clogin.com/.
-ssp, --susi-policy-id <ID> — the sign-in and sign-up policy ID for this project. use it with IndividualB2C authentication.
--aad-instance <INSTANCE> — the Azure Active Directory instance to connect to. use it with SingleOrg authentication. default is https://login.microsoftonline.com/.
--client-id <ID> — the Client ID for this project. use it with IndividualB2C, SingleOrg, or Individual authentication in standalone scenarios. default is 33333333-3333-3333-33333333333333333.
--domain <DOMAIN> — the domain for the directory tenant. use it with SingleOrg or IndividualB2C authentication. default is qualified.domain.name.
--app-id-uri <URI> — the App ID Uri for the server API you want to call. use it with SingleOrg or IndividualB2C authentication. default is api.id.uri.
--api-client-id <ID> — the Client ID for the API that the server hosts. use it with SingleOrg or IndividualB2C authentication. default is 11111111-1111-1111-11111111111111111.
-s, --default-scope <SCOPE> — the API scope the client needs to request to provision an access token. use it with SingleOrg or IndividualB2C authentication. default is user_impersonation.
--tenant-id <ID> — the TenantId ID of the directory to connect to. use it with SingleOrg authentication. default is 22222222-2222-2222-2222-222222222222.
-r, --org-read-access — lets this application have read-access to the directory. only applies to SingleOrg authentication.
--exclude-launch-settings — keeps launchSettings.json out of the generated template.
-p, --pwa — produces a Progressive Web Application (PWA) supporting installation and offline use. offline mode? we love her. 🌈
--no-https — turns off HTTPS. this option only applies if Individual, IndividualB2C, or SingleOrg aren't being used for --auth.
-uld, --use-local-db — says LocalDB should be used instead of SQLite. only applies to Individual or IndividualB2C authentication.
--called-api-url <URL> — URL of the API to call from the web app. only applies to SingleOrg or IndividualB2C authentication without an ASP.NET Core host specified. default is https://graph.microsoft.com/v1.0/me.
--calls-graph — specifies if the web app calls Microsoft Graph. only applies to SingleOrg authentication.
--called-api-scopes <SCOPES> — scopes to request to call the API from the web app. only applies to SingleOrg or IndividualB2C authentication without an ASP.NET Core host specified. default is user.read.

🌸 web

--exclude-launch-settings — keeps launchSettings.json out of the generated template.
-f, --framework <FRAMEWORK> — picks the framework to target. this option isn't available in the .NET Core 2.2 SDK.

the default values depend on which SDK version number you're using:

SDK version 5.0 → net5.0
SDK version 3.1 → netcoreapp3.1
SDK version 3.0 → netcoreapp3.0
SDK version 2.1 → netcoreapp2.1

to create a project that targets a framework earlier than the SDK you're using, see --framework for console projects earlier in this article.

--no-restore — doesn't execute an implicit restore during project creation.
--no-https — turns off HTTPS.

👑 mvc, webapp

-au, --auth <AUTHENTICATION_TYPE> — the type of authentication to use. the possible values are:
- None — no authentication (this is the default).
- Individual — individual authentication.
- IndividualB2C — individual authentication with Azure AD B2C.
- SingleOrg — organizational authentication for a single tenant.
- MultiOrg — organizational authentication for multiple tenants.
- Windows — Windows authentication.
--aad-b2c-instance <INSTANCE> — the Azure Active Directory B2C instance to connect to. use it with IndividualB2C authentication. default is https://login.microsoftonline.com/tfp/.
-ssp, --susi-policy-id <ID> — the sign-in and sign-up policy ID for this project. use it with IndividualB2C authentication.
-rp, --reset-password-policy-id <ID> — the reset password policy ID for this project. use it with IndividualB2C authentication.
-ep, --edit-profile-policy-id <ID> — the edit profile policy ID for this project. use it with IndividualB2C authentication.
--aad-instance <INSTANCE> — the Azure Active Directory instance to connect to. use it with SingleOrg or MultiOrg authentication. default is https://login.microsoftonline.com/.
--client-id <ID> — the Client ID for this project. use it with IndividualB2C, SingleOrg, or MultiOrg authentication. default is 11111111-1111-1111-11111111111111111.
--domain <DOMAIN> — the domain for the directory tenant. use it with SingleOrg or IndividualB2C authentication. default is qualified.domain.name.
--tenant-id <ID> — the TenantId ID of the directory to connect to. use it with SingleOrg authentication. default is 22222222-2222-2222-2222-222222222222.
--callback-path <PATH> — the request path within the application's base path of the redirect URI. use it with SingleOrg or IndividualB2C authentication. default is /signin-oidc.
-r, --org-read-access — lets this application have read-access to the directory. only applies to SingleOrg or MultiOrg authentication.
--exclude-launch-settings — keeps launchSettings.json out of the generated template.
--no-https — turns off HTTPS. this option only applies if Individual, IndividualB2C, SingleOrg, or MultiOrg aren't being used.
-uld, --use-local-db

Specifies LocalDB should be used instead of SQLite. Only applies to Individual or IndividualB2C authentication.

-f, --framework <FRAMEWORK> — picks the framework you wanna target, bestie. option's been around since .NET Core 3.0 SDK.

the defaults are literally:

SDK 5.0 → net5.0
SDK 3.1 → netcoreapp3.1
SDK 3.0 → netcoreapp3.0

wanna target something older than the SDK you're on? see --framework for console projects earlier in this article. periodt.

--no-restore — doesn’t execute an implicit restore during project creation.
--use-browserlink — drops BrowserLink into the project. heads up: not available in .NET Core 2.2 and 3.1 SDK. 💀
-rrc, --razor-runtime-compilation — decides if the project gets Razor runtime compilation in Debug builds. available since .NET Core 3.1.201 SDK. slay.

🎀 angular, react 🎀

-au, --auth <AUTHENTICATION_TYPE> — the type of auth to use. available since .NET Core 3.0 SDK.

possible values:

None — no authentication (default).
Individual — individual authentication.

--exclude-launch-settings — keeps launchSettings.json out of the generated template.
--no-restore — doesn’t execute an implicit restore during project creation.
--no-https — turns off HTTPS. this option only applies if authentication is None.
-uld, --use-local-db — says LocalDB should be used instead of SQLite. only applies to Individual or IndividualB2C authentication. available since .NET Core 3.0 SDK.
-f, --framework <FRAMEWORK> — specifies the framework to target. option not available in .NET Core 2.2 SDK.

defaults:

5.0 → net5.0
3.1 → netcoreapp3.1
3.0 → netcoreapp3.0
2.1 → netcoreapp2.0

for earlier targets, see --framework for console projects earlier in this article.

⚛️ reactredux ⚛️

--exclude-launch-settings — excludes launchSettings.json from the generated template.
-f, --framework <FRAMEWORK> — specifies the framework to target. option not available in .NET Core 2.2 SDK.

defaults:

5.0 → net5.0
3.1 → netcoreapp3.1
3.0 → netcoreapp3.0
2.1 → netcoreapp2.0

for earlier targets, see --framework for console projects earlier in this article.

--no-restore — doesn’t execute an implicit restore during project creation.
--no-https — turns off HTTPS.

🧩 razorclasslib 🧩

--no-restore — doesn’t execute an implicit restore during project creation.
-s, --support-pages-and-views — supports adding traditional Razor pages and Views in addition to components to this library. available since .NET Core 3.0 SDK.

🌐 webapi 🌐

-au, --auth <AUTHENTICATION_TYPE> — the type of authentication to use. possible values:
- None — no authentication (default).
- IndividualB2C — individual authentication with Azure AD B2C.
- SingleOrg — organizational authentication for a single tenant.
- Windows — Windows authentication.
--aad-b2c-instance <INSTANCE> — the Azure Active Directory B2C instance to connect to. use with IndividualB2C authentication. the default value is https://login.microsoftonline.com/tfp/.
-ssp, --susi-policy-id <ID> — the sign-in and sign-up policy ID for this project. use with IndividualB2C authentication.
--aad-instance <INSTANCE> — the Azure Active Directory instance to connect to. use with SingleOrg authentication. the default value is https://login.microsoftonline.com/.
--client-id <ID> — the Client ID for this project. use with IndividualB2C or SingleOrg authentication. the default value is 11111111-1111-1111-11111111111111111.
--domain <DOMAIN> — the domain for the directory tenant. use with IndividualB2C or SingleOrg authentication. the default value is qualified.domain.name.
--tenant-id <ID> — the TenantId ID of the directory to connect to. use with SingleOrg authentication. the default value is 22222222-2222-2222-2222-222222222222.
-r, --org-read-access — allows this application read-access to the directory. only applies to SingleOrg authentication.
--exclude-launch-settings — excludes launchSettings.json from the generated template.
--no-https — turns off HTTPS. app.UseHsts and app.UseHttpsRedirection aren’t added to Startup.Configure. this option only applies if IndividualB2C or SingleOrg aren’t being used for authentication.
-uld, --use-local-db — specifies LocalDB should be used instead of SQLite. only applies to IndividualB2C authentication.
-f, --framework <FRAMEWORK> — specifies the framework to target. option not available in .NET Core 2.2 SDK.

defaults:

5.0 → net5.0
3.1 → netcoreapp3.1
3.0 → netcoreapp3.0
2.1 → netcoreapp2.1

for earlier targets, see --framework for console projects earlier in this article.

--no-restore — doesn’t execute an implicit restore during project creation.

📄 globaljson 📄

--sdk-version <VERSION_NUMBER> — specifies the version of the .NET SDK to use in the global.json file.

DOTNET-NEW-SDK-TEMPLATES(1)

✨ .NET default templates for dotnet new ✨

🌸 Template options 🌸

💅 console

🎀 classlib

🦋 wpf, wpflib, wpfcustomcontrollib, wpfusercontrollib

🫶 winforms, winformslib

💜 worker, grpc

⭐ mstest, xunit

🍓 nunit

🎀 page

🦋 viewimports, proto

🔥 blazorserver

💖 blazorwasm

🌸 web

👑 mvc, webapp

🎀 angular, react 🎀

⚛️ reactredux ⚛️

🧩 razorclasslib 🧩

🌐 webapi 🌐

📄 globaljson 📄

See also

✨ .NET default templates for `dotnet new` ✨