dotnet new

10/24/2018
15 minutes to read
Contributors

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

Name

dotnet new - Creates a new project, configuration file, or solution based on the specified template.

Synopsis

dotnet new <TEMPLATE> [--force] [-i|--install] [-lang|--language] [-n|--name] [--nuget-source] [-o|--output]
    [-u|--uninstall] [Template options]
dotnet new <TEMPLATE> [-l|--list] [--type]
dotnet new [-h|--help]

dotnet new <TEMPLATE> [--force] [-i|--install] [-lang|--language] [-n|--name] [-o|--output] [-u|--uninstall] [Template options]
dotnet new <TEMPLATE> [-l|--list] [--type]
dotnet new [-h|--help]

dotnet new <TEMPLATE> [-lang|--language] [-n|--name] [-o|--output] [-all|--show-all] [-h|--help] [Template options]
dotnet new <TEMPLATE> [-l|--list]
dotnet new [-all|--show-all]
dotnet new [-h|--help]

Description

The dotnet new command provides a convenient way to initialize a valid .NET Core project.

The command calls the template engine to create the artifacts on disk based on the specified template and options.

Arguments

TEMPLATE

The template to instantiate when the command is invoked. Each template might have specific options you can pass. For more information, see Template options.

The command contains a default list of templates. Use dotnet new -l to obtain a list of the available templates. The following table shows the templates that come pre-installed with the .NET Core SDK 2.1.300. The default language for the template is shown inside the brackets.

Template description	Template name	Languages
Console application	`console`	[C#], F#, VB
Class library	`classlib`	[C#], F#, VB
Unit test project	`mstest`	[C#], F#, VB
xUnit test project	`xunit`	[C#], F#, VB
NUnit test project	`nunit`	[C#], F#, VB
Razor page	`page`	[C#]
MVC ViewImports	`viewimports`	[C#]
MVC ViewStart	`viewstart`	[C#]
ASP.NET Core empty	`web`	[C#], F#
ASP.NET Core Web App (Model-View-Controller)	`mvc`	[C#], F#
ASP.NET Core Web App	`razor`, `webapp`	[C#]
ASP.NET Core with Angular	`angular`	[C#]
ASP.NET Core with React.js	`react`	[C#]
ASP.NET Core with React.js and Redux	`reactredux`	[C#]
ASP.NET Core Web API	`webapi`	[C#], F#
Razor class library	`razorclasslib`	[C#]
global.json file	`globaljson`
NuGet config	`nugetconfig`
Web config	`webconfig`
Solution file	`sln`

The command contains a default list of templates. Use dotnet new -l to obtain a list of the available templates. The following table shows the templates that come pre-installed with the .NET Core SDK 2.0. The default language for the template is shown inside the brackets.

Template description	Template name	Languages
Console application	`console`	[C#], F#, VB
Class library	`classlib`	[C#], F#, VB
Unit test project	`mstest`	[C#], F#, VB
xUnit test project	`xunit`	[C#], F#, VB
ASP.NET Core empty	`web`	[C#], F#
ASP.NET Core Web App (Model-View-Controller)	`mvc`	[C#], F#
ASP.NET Core Web App	`razor`	[C#]
ASP.NET Core with Angular	`angular`	[C#]
ASP.NET Core with React.js	`react`	[C#]
ASP.NET Core with React.js and Redux	`reactredux`	[C#]
ASP.NET Core Web API	`webapi`	[C#], F#
global.json file	`globaljson`
NuGet config	`nugetconfig`
Web config	`webconfig`
Solution file	`sln`
Razor page	`page`
MVC ViewImports	`viewimports`
MVC ViewStart	`viewstart`

The command contains a default list of templates. Use dotnet new -all to obtain a list of the available templates. The following table shows the templates that come pre-installed with the .NET Core SDK 1.x. The default language for the template is shown inside the brackets.

Template description	Template name	Languages
Console application	`console`	[C#], F#
Class library	`classlib`	[C#], F#
Unit test project	`mstest`	[C#], F#
xUnit test project	`xunit`	[C#], F#
ASP.NET Core empty	`web`	[C#]
ASP.NET Core Web App	`mvc`	[C#], F#
ASP.NET Core Web API	`webapi`	[C#]
NuGet config	`nugetconfig`
Web config	`webconfig`
Solution file	`sln`

Options

--force

Forces content to be generated even if it would change existing files. This is required when the output directory already contains a project.

-h|--help

Prints out help for the command. It can be invoked for the dotnet new command itself or for any template, such as dotnet new mvc --help.

-i|--install <PATH|NUGET_ID>

Installs a source or template pack from the PATH or NUGET_ID provided. If you want to install a prerelease version of a template package, you need to specify the version in the format of <package-name>::<package-version>. By default, dotnet new passes * for the version, which represents the last stable package version. See an example at the Examples section.

For information on creating custom templates, see Custom templates for dotnet new.

-l|--list

Lists templates containing the specified name. If invoked for the dotnet new command, it lists the possible templates available for the given directory. For example if the directory already contains a project, it doesn't list all project templates.

-lang|--language {C#|F#|VB}

The language of the template to create. The language accepted varies by the template (see defaults in the arguments section). Not valid for some templates.

Note

Some shells interpret # as a special character. In those cases, you need to enclose the language parameter value, such as dotnet new console -lang "F#".

-n|--name <OUTPUT_NAME>

The name for the created output. If no name is specified, the name of the current directory is used.

--nuget-source

Specifies a NuGet source to use during install.

-o|--output <OUTPUT_DIRECTORY>

Location to place the generated output. The default is the current directory.

--type

Filters templates based on available types. Predefined values are "project", "item" or "other".

-u|--uninstall <PATH|NUGET_ID>

Uninstalls a source or template pack at the PATH or NUGET_ID provided.

Note

To uninstall a template using a PATH, you need to fully qualify the path. For example, C:/Users/<USER>/Documents/Templates/GarciaSoftware.ConsoleTemplate.CSharp will work, but ./GarciaSoftware.ConsoleTemplate.CSharp from the containing folder will not. Additionally, do not include a final terminating directory slash on your template path.

--force

Forces content to be generated even if it would change existing files. This is required when the output directory already contains a project.

-h|--help

Prints out help for the command. It can be invoked for the dotnet new command itself or for any template, such as dotnet new mvc --help.

-i|--install <PATH|NUGET_ID>

For information on creating custom templates, see Custom templates for dotnet new.

-l|--list

-lang|--language {C#|F#|VB}

The language of the template to create. The language accepted varies by the template (see defaults in the arguments section). Not valid for some templates.

Note

Some shells interpret # as a special character. In those cases, you need to enclose the language parameter value, such as dotnet new console -lang "F#".

-n|--name <OUTPUT_NAME>

The name for the created output. If no name is specified, the name of the current directory is used.

-o|--output <OUTPUT_DIRECTORY>

Location to place the generated output. The default is the current directory.

--type

Filters templates based on available types. Predefined values are "project", "item" or "other".

-u|--uninstall <PATH|NUGET_ID>

Uninstalls a source or template pack at the PATH or NUGET_ID provided.

Note

To uninstall a template using a source PATH, you need to fully qualify the path. For example, C:/Users/<USER>/Documents/Templates/GarciaSoftware.ConsoleTemplate.CSharp will work, but ./GarciaSoftware.ConsoleTemplate.CSharp from the containing folder will not. Additionally, do not include a final terminating directory slash on your template path.

If you are unable to determine the PATH or NUGET_ID argument needed to uninstall a template, running dotnet new --uninstall without an argument will list all installed templates and the argument required to uninstall them.

-all|--show-all

Shows all templates for a specific type of project when running in the context of the dotnet new command alone. When running in the context of a specific template, such as dotnet new web -all, -all is interpreted as a force creation flag. This is required when the output directory already contains a project.

-h|--help

Prints out help for the command. It can be invoked for the dotnet new command itself or for any template, such as dotnet new mvc --help.

-l|--list

-lang|--language {C#|F#}

The language of the template to create. The language accepted varies by the template (see defaults in the arguments section). Not valid for some templates.

Note

Some shells interpret # as a special character. In those cases, you need to enclose the language parameter value, such as dotnet new console -lang "F#".

-n|--name <OUTPUT_NAME>

The name for the created output. If no name is specified, the name of the current directory is used.

-o|--output <OUTPUT_DIRECTORY>

Location to place the generated output. The default is the current directory.

Template options

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

console, angular, react, reactredux, razorclasslib

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

classlib

-f|--framework <FRAMEWORK> - Specifies the framework to target. Values: netcoreapp2.0 to create a .NET Core Class Library or netstandard2.0 to create a .NET Standard Class Library. The default value is netstandard2.0.

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

mstest, xunit

-p|--enable-pack - Enables packaging for the project using dotnet pack.

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

globaljson

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

web

--exclude-launch-settings - Exclude launchSettings.json from the generated template.

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

--no-https - Project doesn't require HTTPS. This option only applies if IndividualAuth or OrganizationalAuth are not being used.

webapi

-au|--auth <AUTHENTICATION_TYPE> - The type of authentication to use. The possible values are:

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 SingleOrg or IndividualB2C 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 or MultiOrg authentication.

--exclude-launch-settings - Exclude launchSettings.json from the generated template.

-uld|--use-local-db - Specifies 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.

--no-https - Project doesn't require HTTPS. app.UseHsts and app.UseHttpsRedirection aren't added to Startup.Configure. This option only applies if Individual, IndividualB2C, SingleOrg, or MultiOrg aren't being used.

mvc, razor

-au|--auth <AUTHENTICATION_TYPE> - The type of authentication to use. The possible values are:

None - No authentication (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 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.

-rp|--reset-password-policy-id <ID> - The reset password policy ID for this project. Use with IndividualB2C authentication.

-ep|--edit-profile-policy-id <ID> - The edit profile policy ID for this project. Use with IndividualB2C authentication.

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

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

--domain <DOMAIN> - The domain for the directory tenant. Use with SingleOrg or IndividualB2C 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.

--callback-path <PATH> - 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.

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

--exclude-launch-settings - Exclude launchSettings.json from the generated template.

--use-browserlink - Includes BrowserLink in the project.

-uld|--use-local-db - Specifies 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.

page

-na|--namespace <NAMESPACE_NAME>- Namespace for the generated code. The default value is MyApp.Namespace.

-np|--no-pagemodel - Creates the page without a PageModel.

viewimports

-na|--namespace <NAMESPACE_NAME>- Namespace for the generated code. The default value is MyApp.Namespace.

console, angular, react, reactredux

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

classlib

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

mstest, xunit

-p|--enable-pack - Enables packaging for the project using dotnet pack.

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

globaljson

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

web

--use-launch-settings - Includes launchSettings.json in the generated template output.

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

webapi

-au|--auth <AUTHENTICATION_TYPE> - The type of authentication to use. The possible values are:

None - No authentication (Default).
IndividualB2C - Individual authentication with Azure AD B2C.
SingleOrg - Organizational authentication for a single tenant.
Windows - Windows authentication.