dotnet-pack - Man Page
Packs the code into a NuGet package.
This article applies to: ✔️ .NET Core 3.1 SDK and later versions
dotnet pack [<PROJECT>|<SOLUTION>] [-c|--configuration <CONFIGURATION>] [--force] [--include-source] [--include-symbols] [--interactive] [--no-build] [--no-dependencies] [--no-restore] [--nologo] [-o|--output <OUTPUT_DIRECTORY>] [--runtime <RUNTIME_IDENTIFIER>] [-s|--serviceable] [-v|--verbosity <LEVEL>] [--version-suffix <VERSION_SUFFIX>] dotnet pack -h|--help
dotnet pack command builds the project and creates NuGet packages. The result of this command is a NuGet package (that is, a .nupkg file).
If you want to generate a package that contains the debug symbols, you have two options available:
--include-symbols- it creates the symbols package.
--include-source- it creates the symbols package with a
srcfolder inside containing the source files.
NuGet dependencies of the packed project are added to the .nuspec file, so they’re properly resolved when the package is installed. If the packed project has references to other projects, the other projects are not included in the package. Currently, you must have a package per project if you have project-to-project dependencies.
dotnet pack builds the project first. If you wish to avoid this behavior, pass the
--no-build option. This option is often useful in Continuous Integration (CI) build scenarios where you know the code was previously built.
In some cases, the implicit build cannot be performed. This can occur when
GeneratePackageOnBuild is set, to avoid a cyclic dependency between build and pack targets. The build can also fail if there is a locked file or other issue.
You can provide MSBuild properties to the
dotnet pack command for the packing process. For more information, see NuGet pack target properties and the MSBuild Command-Line Reference. The Examples section shows how to use the MSBuild
-p switch for a couple of different scenarios.
Web projects aren’t packable.
You don’t have to run
dotnet restore because it’s run implicitly by all commands that require a restore to occur, such as
dotnet publish, and
dotnet pack. To disable implicit restore, use the
dotnet restore command is still useful in certain scenarios where explicitly restoring makes sense, such as continuous integration builds in Azure DevOps Services or in build systems that need to explicitly control when the restore occurs.
For information about how to manage NuGet feeds, see the
dotnet restore documentation.
This command supports the
dotnet restore options when passed in the long form (for example,
--source). Short form options, such as
-s, are not supported.
Workload manifest downloads
When you run this command, it initiates an asynchronous background download of advertising manifests for workloads. If the download is still running when this command finishes, the download is stopped. For more information, see Advertising manifests.
PROJECT | SOLUTION
The project or solution to pack. It’s either a path to a csproj, vbproj, or fsproj file, or to a solution file or directory. If not specified, the command searches the current directory for a project or solution file.
Defines the build configuration. The default for most projects is
Debug, but you can override the build configuration settings in your project.
Forces all dependencies to be resolved even if the last restore was successful. Specifying this flag is the same as deleting the project.assets.json file.
Prints out a description of how to use the command.
Includes the debug symbols NuGet packages in addition to the regular NuGet packages in the output directory. The sources files are included in the
srcfolder within the symbols package.
Includes the debug symbols NuGet packages in addition to the regular NuGet packages in the output directory.
Allows the command to stop and wait for user input or action. For example, to complete authentication. Available since .NET Core 3.0 SDK.
Doesn’t build the project before packing. It also implicitly sets the
Ignores project-to-project references and only restores the root project.
Doesn’t execute an implicit restore when running the command.
Doesn’t display the startup banner or the copyright message.
Places the built packages in the directory specified.
Specifies the target runtime to restore packages for. For a list of Runtime Identifiers (RIDs), see the RID catalog.
Sets the serviceable flag in the package. For more information, see .NET Blog: .NET Framework 4.5.1 Supports Microsoft Security Updates for .NET NuGet Libraries (https://aka.ms/nupkgservicing).
Sets the verbosity level of the command. Allowed values are
diag[nostic]. For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
Defines the value for the
VersionSuffixMSBuild property. The effect of this property on the package version depends on the values of the
VersionPrefixproperties, as shown in the following table:
Properties with values Package version None
If you want to use
Versionin the project file. For example, if
0.1.2and you pass
dotnet pack, the package version will be
Versionhas a value and you pass
dotnet pack, the value specified for
Pack the project in the current directory:
dotnet pack ~/projects/app1/project.csproj
Pack the project in the current directory and place the resulting packages into the
dotnet pack --output nupkgs
Pack the project in the current directory into the
nupkgsfolder and skip the build step:
dotnet pack --no-build --output nupkgs
With the project’s version suffix configured as
<VersionSuffix>$(VersionSuffix)</VersionSuffix>in the .csproj file, pack the current project and update the resulting package version with the given suffix:
dotnet pack --version-suffix "ci-1234"
Set the package version to
dotnet pack -p:PackageVersion=2.1.0
Pack the project for a specific target framework:
dotnet pack -p:TargetFrameworks=net45
Pack the project and use a specific runtime (Windows 10) for the restore operation:
dotnet pack --runtime win10-x64
Pack the project using a .nuspec file:
dotnet pack ~/projects/app1/project.csproj -p:NuspecFile=~/projects/app1/project.nuspec -p:NuspecBasePath=~/projects/app1/nuget
For information about how to use
NuspecProperties, see the following resources:
- Packing using a .nuspec
- Advanced extension points to create customized package
- Global properties