dotnet-new-sdk-templates.7

dotnet-new-sdk-templates

NAME
DESCRIPTION
SEE ALSO

---

NAME

dotnet-new-sdk-templates - .NET default templates for dotnet new

DESCRIPTION

When you install the .NET SDK (https://dotnet.microsoft.com/download), you receive over a dozen built-in templates for creating projects and files, including 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. To list the built-in templates, run the dotnet new list command:

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 following table shows templates that have been discontinued and no longer come pre-installed with the .NET SDK. Click on the short name link to see the specific template options.

Template options

Each template may have additional options available. To show the additional options available for the template use the —help option with the template name argument, for example: dotnet new console —help. In case the template supports multiple languages, this command will show help for the template in the default language. By combining it with the —language option, you can see the help for other languages: dotnet new console —help —language F#. The templates that ship with the .NET SDK have the following additional options:

console

Specifies the framework to target. Available since .NET Core 3.0 SDK.

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

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 the .NET 7 SDK installed, then the only value available for —framework is net7.0. If you install the .NET 6 SDK the value net6.0 becomes available for —framework. If you install the .NET Core 3.1 SDK, netcoreapp3.1 becomes available, and so on. So by specifying —framework netcoreapp3.1 you can target .NET Core 3.1 even while running dotnet new in the .NET 6 SDK.

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.

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.

If specified, doesn’t execute an implicit restore during project creation. Available since .NET Core 2.2 SDK.

If specified, an explicit Program class and Main method will be used instead of top-level statements. Available since .NET SDK 6.0.300. Default value: false. Available only for C#.

* * * * *

classlib

Specifies the framework to target. Values: net8.0, net7.0, or net6.0 to create a .NET Class Library, or netstandard2.1 or netstandard2.0 to create a .NET Standard Class Library. The default value for .NET SDK 8.0.x is net8.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.

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.

Doesn’t execute an implicit restore during project creation.

* * * * *

wpf, wpflib, wpfcustomcontrollib, wpfusercontrollib

Specifies the framework to target. For the .NET 8 SDK, the default value is net8.0. Available since .NET Core 3.1 SDK.

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.

Doesn’t execute an implicit restore during project creation.

* * * * *

winforms, winformslib

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.

Doesn’t execute an implicit restore during project creation.

* * * * *

worker, grpc

Specifies the framework to target. The default value for .NET 8 SDK is net8.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.

Excludes launchSettings.json from the generated template.

Doesn’t execute an implicit restore during project creation.

If specified, an explicit Program class and Main method will be used instead of top-level statements. Available since .NET SDK 6.0.300. Default value: false.

* * * * *

mstest, xunit

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:

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 the .NET 6 SDK installed, then the only value available for —framework is net6.0. If you install the .NET 5 SDK, the value net5.0 becomes available for —framework. If you install the .NET Core 3.1 SDK, netcoreapp3.1 becomes available, and so on. So by specifying —framework netcoreapp3.1 you can target .NET Core 3.1 even while running dotnet new in the .NET 6 SDK.

Enables packaging for the project using dotnet pack.

Doesn’t execute an implicit restore during project creation.

* * * * *

nunit

Specifies the framework to target.

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

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 the .NET 6 SDK installed, then the only value available for —framework is net6.0. If you install the .NET 5 SDK, the value net5.0 becomes available for —framework. If you install the .NET Core 3.1 SDK, netcoreapp3.1 becomes available, and so on. So by specifying —framework netcoreapp3.1 you can target .NET Core 3.1 even while running dotnet new in the .NET 6 SDK.

Enables packaging for the project using dotnet pack.

Doesn’t execute an implicit restore during project creation.

* * * * *

page

Namespace for the generated code. The default value is MyApp.Namespace.

Creates the page without a PageModel.

* * * * *

viewimports, proto

Namespace for the generated code. The default value is MyApp.Namespace.

* * * * *

blazorserver

Discontinued since .NET 8 SDK.

The type of authentication to use. The possible values are:

—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/.

The sign-in and sign-up policy ID for this project. Use with IndividualB2C authentication.

The reset password policy ID for this project. Use with IndividualB2C authentication.

The edit profile policy ID for this project. Use with IndividualB2C authentication.

The Azure Active Directory instance to connect to. Use with SingleOrg or MultiOrg authentication. The default value is https://login.microsoftonline.com/.

The Client ID for this project. Use with IndividualB2C, SingleOrg, or MultiOrg authentication. The default value is 11111111-1111-1111-11111111111111111.

The domain for the directory tenant. Use with SingleOrg or IndividualB2C authentication. The default value is qualified.domain.name.

The TenantId ID of the directory to connect to. Use with SingleOrg authentication. The default value is 22222222-2222-2222-2222-222222222222.

The request path within the application’s base path of the redirect URI. Use with SingleOrg or IndividualB2C authentication. The default value is /signin-oidc.

Allows this application read-access to the directory. Only applies to SingleOrg or MultiOrg authentication.

Excludes launchSettings.json from the generated template.

Turns off HTTPS. This option only applies if Individual, IndividualB2C, SingleOrg, or MultiOrg aren’t being used for —auth.

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

Doesn’t execute an implicit restore during project creation.

Port number to use for the HTTP endpoint in launchSettings.json.

Port number to use for the HTTPS endpoint in launchSettings.json. This option is not applicable when the parameter no-https is used (but no-https is ignored when an individual or organizational authentication setting is chosen for —auth).

If specified, an explicit Program class and Main method will be used instead of top-level statements. Available since .NET SDK 6.0.300. Default value: false.

* * * * *

blazor

Specifies the framework to target.

This template is available for .NET 8 or later.

Doesn’t execute an implicit restore during project creation.

Excludes launchSettings.json from the generated app.

Specifies which interactive render mode to use for interactive components. The possible values are:

—empty

Omits sample pages and styling that demonstrate basic usage patterns.

The type of authentication to use. The possible values are:

-uld|—use-local-db

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

Makes every page interactive by applying an interactive render mode at the top level. If false, pages use static server-side rendering by default and can be marked interactive on a per-page or per-component basis. This option is only effective if the -i|—interactivity option isn’t set to None.

Turns off HTTPS. This option only applies if Individual isn’t chosen for the -au|—auth option.

If specified, an explicit Program class and Main method is generated instead of top-level statements.

* * * * *

blazorwasm

Specifies the framework to target.

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

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.

Doesn’t execute an implicit restore during project creation.

Includes an ASP.NET Core host for the Blazor WebAssembly app.

The type of authentication to use. The possible values are:

—authority <AUTHORITY>

The authority of the OIDC provider. Use with Individual authentication. The default value is https://login.microsoftonline.com/.

The Azure Active Directory B2C instance to connect to. Use with IndividualB2C authentication. The default value is https://aadB2CInstance.b2clogin.com/.

The sign-in and sign-up policy ID for this project. Use with IndividualB2C authentication.

The Azure Active Directory instance to connect to. Use with SingleOrg authentication. The default value is https://login.microsoftonline.com/.

The Client ID for this project. Use with IndividualB2C, SingleOrg, or Individual authentication in standalone scenarios. The default value is 33333333-3333-3333-33333333333333333.

The domain for the directory tenant. Use with SingleOrg or IndividualB2C authentication. The default value is qualified.domain.name.

The App ID Uri for the server API you want to call. Use with SingleOrg or IndividualB2C authentication. The default value is api.id.uri.

The Client ID for the API that the server hosts. Use with SingleOrg or IndividualB2C authentication. The default value is 11111111-1111-1111-11111111111111111.

The API scope the client needs to request to provision an access token. Use with SingleOrg or IndividualB2C authentication. The default value is user_impersonation.

The TenantId ID of the directory to connect to. Use with SingleOrg authentication. The default value is 22222222-2222-2222-2222-222222222222.

Allows this application read-access to the directory. Only applies to SingleOrg authentication.

Excludes launchSettings.json from the generated template.

produces a Progressive Web Application (PWA) supporting installation and offline use.

Turns off HTTPS. This option only applies if Individual, IndividualB2C, or SingleOrg aren’t being used for —auth.

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

URL of the API to call from the web app. Only applies to SingleOrg or IndividualB2C authentication without an ASP.NET Core host specified. The default value is https://graph.microsoft.com/v1.0/me.

Specifies if the web app calls Microsoft Graph. Only applies to SingleOrg authentication.

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. The default is user.read.

Port number to use for the HTTP endpoint in launchSettings.json.

Port number to use for the HTTPS endpoint in launchSettings.json. This option is not applicable when the parameter no-https is used (but no-https is ignored when an individual or organizational authentication setting is chosen for —auth).

If specified, an explicit Program class and Main method will be used instead of top-level statements. Available since .NET SDK 6.0.300. Default value: false.

* * * * *

web

Excludes launchSettings.json from the generated template.

Specifies the framework to target. Option not available in .NET Core 2.2 SDK.

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

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.

Doesn’t execute an implicit restore during project creation.

Turns off HTTPS.

Port number to use for the HTTP endpoint in launchSettings.json.

Port number to use for the HTTPS endpoint in launchSettings.json. This option is not applicable when the parameter no-https is used (but no-https is ignored when an individual or organizational authentication setting is chosen for —auth).

If specified, an explicit Program class and Main method will be used instead of top-level statements. Available since .NET SDK 6.0.300. Default value: false.

* * * * *

mvc, webapp

The type of authentication to use. The possible values are:

—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/.

The sign-in and sign-up policy ID for this project. Use with IndividualB2C authentication.

The reset password policy ID for this project. Use with IndividualB2C authentication.

The edit profile policy ID for this project. Use with IndividualB2C authentication.

The Azure Active Directory instance to connect to. Use with SingleOrg or MultiOrg authentication. The default value is https://login.microsoftonline.com/.

The Client ID for this project. Use with IndividualB2C, SingleOrg, or MultiOrg authentication. The default value is 11111111-1111-1111-11111111111111111.

The domain for the directory tenant. Use with SingleOrg or IndividualB2C authentication. The default value is qualified.domain.name.

The TenantId ID of the directory to connect to. Use with SingleOrg authentication. The default value is 22222222-2222-2222-2222-222222222222.

The request path within the application’s base path of the redirect URI. Use with SingleOrg or IndividualB2C authentication. The default value is /signin-oidc.

Allows this application read-access to the directory. Only applies to SingleOrg or MultiOrg authentication.

Excludes launchSettings.json from the generated template.

Turns off HTTPS. This option only applies if Individual, IndividualB2C, SingleOrg, or MultiOrg aren’t being used.

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

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:

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.

Doesn’t execute an implicit restore during project creation.

Includes BrowserLink in the project. Option not available in .NET Core 2.2 and 3.1 SDK.

Determines if the project is configured to use Razor runtime compilation in Debug builds. Option available since .NET Core 3.1.201 SDK.

Port number to use for the HTTP endpoint in launchSettings.json.

Port number to use for the HTTPS endpoint in launchSettings.json. This option is not applicable when the parameter no-https is used (but no-https is ignored when an individual or organizational authentication setting is chosen for —auth).

If specified, an explicit Program class and Main method will be used instead of top-level statements. Available since .NET SDK 6.0.300. Default value: false.

* * * * *

angular, react

Discontinued since .NET 8 SDK.

The type of authentication to use. Available since .NET Core 3.0 SDK.

The possible values are:

—exclude-launch-settings

Excludes launchSettings.json from the generated template.

Doesn’t execute an implicit restore during project creation.

Turns off HTTPS. This option only applies if authentication is None.

Specifies LocalDB should be used instead of SQLite. Only applies to Individual or IndividualB2C authentication. Available since .NET Core 3.0 SDK.

Specifies the framework to target. Option not available in .NET Core 2.2 SDK.

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

There isn’t a React template for net8.0, however, if you’re interested in developing React apps with ASP.NET Core, see Overview of Single Page Apps (SPAs) in ASP.NET Core.

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.

Port number to use for the HTTP endpoint in launchSettings.json.

Port number to use for the HTTPS endpoint in launchSettings.json. This option is not applicable when the parameter no-https is used (but no-https is ignored when an individual or organizational authentication setting is chosen for —auth).

If specified, an explicit Program class and Main method will be used instead of top-level statements. Available since .NET SDK 6.0.300. Default value: false.

* * * * *

razorclasslib

Doesn’t execute an implicit restore during project creation.

Supports adding traditional Razor pages and Views in addition to components to this library. Available since .NET Core 3.0 SDK.

* * * * *

webapiaot

Creates a web API project with AOT publish enabled. For more information, see Native AOT deployment and The Web API (Native AOT) template.

Excludes launchSettings.json from the generated template.

Specifies the framework to target.

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

Doesn’t execute an implicit restore during project creation.

If specified, an explicit Program class and Main method will be used instead of top-level statements. Available since .NET SDK 6.0.300. Default value: false.

* * * * *

webapi

The type of authentication to use. The possible values are:

—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/.

Create a project that uses the ASP.NET Core minimal API. Default is false, but this option is overridden by -controllers. Since the default for -controllers is false, entering dotnet new webapi without specifying either option creates a minimal API project.

The sign-in and sign-up policy ID for this project. Use with IndividualB2C authentication.

The Azure Active Directory instance to connect to. Use with SingleOrg authentication. The default value is https://login.microsoftonline.com/.

The Client ID for this project. Use with IndividualB2C or SingleOrg authentication. The default value is 11111111-1111-1111-11111111111111111.

Whether to use controllers instead of minimal APIs. If both this option and -minimal are specified, this option overrides the value specified by -minimal. Default is false. Available since .NET 8 SDK.

The domain for the directory tenant. Use with IndividualB2C or SingleOrg authentication. The default value is qualified.domain.name.

The TenantId ID of the directory to connect to. Use with SingleOrg authentication. The default value is 22222222-2222-2222-2222-222222222222.

Allows this application read-access to the directory. Only applies to SingleOrg authentication.

Excludes launchSettings.json from the generated template.

Turns off OpenAPI (Swagger) support. AddSwaggerGen, UseSwagger, and UseSwaggerUI aren’t called.

Turns off HTTPS. No https launch profile is created in launchSettings.json. app.UseHsts and app.UseHttpsRedirection aren’t called in Program.cs/Startup.cs. This option only applies if IndividualB2C or SingleOrg aren’t being used for authentication.

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

Specifies the framework to target. Option not available in .NET Core 2.2 SDK.

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

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.

Doesn’t execute an implicit restore during project creation.

If specified, an explicit Program class and Main method will be used instead of top-level statements. Available since .NET SDK 6.0.300. Default value: false.

* * * * *

apicontroller

API Controller with or without read/write actions.

The namespace for the generated code. Default is MyApp.Namespace.

Create a controller with read/write actions. Default is false.

* * * * *

globaljson

Specifies the version of the .NET SDK to use in the global.json file.

The roll-forward policy to use when selecting an SDK version, either as a fallback when a specific SDK version is missing or as a directive to use a later version. For more information, see global-json.

editorconfig

Creates an .editorconfig file for configuring code style preferences.

Creates an empty .editorconfig instead of the defaults for .NET.

SEE ALSO

---