Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
A .nuspec file is an XML manifest that contains package metadata. This manifest is used both to build the package and to provide information to consumers. The manifest is always included in a package.
In this topic:
- General form and schema
- Replacement tokens (when used with a Visual Studio project)
- Dependencies
- Explicit assembly references
- Framework assembly references
- Including assembly files
- Including content files
- Example nuspec files
Project type compatibility
Use
.nuspecwithnuget.exe packfor non-SDK-style projects that usepackages.config.A
.nuspecfile is not required to create packages for SDK-style projects (typically .NET Core and .NET Standard projects that use the SDK attribute. (Note that a.nuspecis generated when you create the package.)If you are creating a package using
dotnet.exe packormsbuild pack target, we recommend that you include all the properties that are usually in the.nuspecfile in the project file instead. However, you can instead choose to use a.nuspecfile to pack usingdotnet.exeormsbuild pack target.For projects migrated from
packages.configto PackageReference, a.nuspecfile is not required to create the package. Instead, use msbuild -t:pack.
General form and schema
A nuspec.xsd schema file can be found in the NuGet GitHub repository.
Note, that this file only represents the most recent schema for a .nuspec file.
No officially published versions exists and no version of that file corresponds to any specific NuGet version.
Within this schema, a .nuspec file has the following general form:
For a clear visual representation of the schema, open the schema file in Visual Studio in Design mode and click on the XML Schema Explorer link. Alternately, open the file as code, right-click in the editor, and select Show XML Schema Explorer. Either way you get a view like the one below (when mostly expanded):
All XML element names in the .nuspec file are case-sensitive, as is the case for XML in general. For example, using the
metadata element
Important
While the .nuspec file contains a reference to a schema
(xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd"),
The NuGet-Team has never published a schema file that could be used for automatic schema validation.
Required metadata elements
Although the following elements are the minimum requirements for a package, you should consider adding the optional metadata elements to improve the overall experience developers have with your package.
These elements must appear within a
id
The case-insensitive package identifier, which must be unique across nuget.org or whatever gallery the package resides in. IDs may not contain spaces or characters that are not valid for a URL, and generally follow .NET namespace rules. See Choosing a unique package identifier for guidance.
When uploading a package to nuget.org, the id field is limited to 100 characters.
version
The version of the package, following the major.minor.patch pattern. Version numbers may include a pre-release suffix as described in Package versioning.
When uploading a package to nuget.org, the version field is limited to 64 characters.
description
A description of the package for UI display.
When uploading a package to nuget.org, the description field is limited to 4000 characters.
authors
A comma-separated list of package authors.
The authors and the owners from the nuspec are ignored when uploading the package to nuget.org.
For setting package ownership on nuget.org, see Managing package owners on nuget.org.
Optional metadata elements
owners
Important
owners is deprecated. Use authors instead.
A comma-separated list of package owners.
The owners from the nuspec is ignored when uploading the package to nuget.org.
For setting package ownership on nuget.org, see Managing package owners on nuget.org.
projectUrl
A URL for the package's home page, often shown in UI displays as well as nuget.org.
When uploading a package to nuget.org, the projectUrl field is limited to 4000 characters.
licenseUrl
Important
licenseUrl is deprecated. Use license instead.
A URL for the package's license, often shown in UIs like nuget.org.
When uploading a package to nuget.org, the licenseUrl field is limited to 4000 characters.
license
Supported with NuGet 4.9.0 and above
An SPDX license expression or path to a license file within the package, often shown in UIs like nuget.org. If you're licensing the package under a common license, like MIT or BSD-2-Clause, use the associated SPDX license identifier. For example:
Note
NuGet.org only accepts license expressions that are approved by the Open Source Initiative or the Free Software Foundation.
If your package is licensed under multiple common licenses, you can specify a composite license using the SPDX expression syntax version 2.0. For example:
If you use a custom license that isn't supported by license expressions, you can package a .txt or .md file with the license's text. For example:
...
LICENSE.txt
...
...
For the MSBuild equivalent, take a look at Packing a license expression or a license file.
The exact syntax of NuGet's license expressions is described below in ABNF.
license-id =
license-exception-id =
simple-expression = license-id / license-id”+”
compound-expression = 1*1(simple-expression /
simple-expression "WITH" license-exception-id /
compound-expression "AND" compound-expression /
compound-expression "OR" compound-expression ) /
"(" compound-expression ")" )
license-expression = 1*1(simple-expression / compound-expression / UNLICENSED)
iconUrl
Important
iconUrl is deprecated. Use icon instead.
A URL for a 128x128 image with transparency background to use as the icon for the package in UI display. Be sure this element contains the direct image URL and not the URL of a web page containing the image. For example, to use an image from GitHub, use the raw file URL like https://github.com/
When uploading a package to nuget.org, the iconUrl field is limited to 4000 characters.
icon
Supported with NuGet 5.3.0 and above
It is a path to an image file within the package, often shown in UIs like nuget.org as the package icon. Image file size is limited to 1 MB. Supported file formats include JPEG and PNG. We recommend an image resolution of 128x128.
For example, you would add the following to your nuspec when creating a package using nuget.exe:
...
images\icon.png
...
...
For the MSBuild equivalent, take a look at Packing an icon image file.
Tip
To maintain backward compatibility with clients and sources that don't yet support icon, specify both icon and iconUrl. Visual Studio supports icon for packages coming from a folder-based source.
readme
Supported with NuGet 5.10.0 preview 2 and above
When packing a readme file, you need to use the readme element to specify the package path, relative to the root of the package. In addition to this, you need to make sure that the file is included in the package. Supported file formats include only Markdown (.md).
For example, you would add the following to your nuspec in order to pack a readme file with your project:
...
docs\readme.md
...
...
For the MSBuild equivalent, take a look at Packing a readme file.
requireLicenseAcceptance
A Boolean value specifying whether the client must prompt the consumer to accept the package license before installing the package.
developmentDependency
(2.8+) A Boolean value specifying whether the package is be marked as a development-only-dependency, which prevents the package from being included as a dependency in other packages. With PackageReference (NuGet 4.8+), this flag also means that it will exclude compile-time assets from compilation. See DevelopmentDependency support for PackageReference
summary
Important
summary is being deprecated. Use description instead.
A short description of the package for UI display. If omitted, a truncated version of description is used.
When uploading a package to nuget.org, the summary field is limited to 4000 characters.
releaseNotes
(1.5+) A description of the changes made in this release of the package, often used in UI like the Updates tab of the Visual Studio Package Manager in place of the package description.
When uploading a package to nuget.org, the releaseNotes field is limited to 35,000 characters.
copyright
(1.5+) Copyright details for the package.
When uploading a package to nuget.org, the copyright field is limited to 4000 characters.
language
The locale ID for the package. See Creating localized packages.
tags
A space-delimited list of tags and keywords that describe the package and aid discoverability of packages through search and filtering.
When uploading a package to nuget.org, the tags field is limited to 4000 characters.
serviceable
(3.3+) For internal NuGet use only.
repository
Repository metadata, consisting of four optional attributes: type and url (4.0+), and branch and commit (4.6+). These attributes allow you to map the .nupkg to the repository that built it, with the potential to get as detailed as the individual branch name and / or commit SHA-1 hash that built the package. This should be a publicly available url that can be invoked directly by a version control software. It should not be an html page as this is meant for the computer. For linking to project page, use the projectUrl field, instead.
For example:
...
When uploading a package to nuget.org, the type attribute is limited to 100 characters and the url attribute is
limited to 4000 characters.
title
A human-friendly title of the package which may be used in some UI displays. (nuget.org and the Package Manager in Visual Studio do not show title)
When uploading a package to nuget.org, the title field is limited to 256 characters but is not used for any
display purposes.
Collection elements
packageTypes
(3.5+) A collection of zero or more
dependencies
A collection of zero or more
frameworkAssemblies
(1.2+) A collection of zero or more
references
(1.5+) A collection of zero or more lib folder that are added as project references. Each reference has a file attribute. lib are included. See Specifying explicit assembly references below.
contentFiles
(3.3+) A collection of
files
The
metadata attributes
minClientVersion
Specifies the minimum version of the NuGet client that can install this package, enforced by nuget.exe and the Visual Studio Package Manager. This is used whenever the package depends on specific features of the .nuspec file that were added in a particular version of the NuGet client. For example, a package using the developmentDependency attribute should specify "2.8" for minClientVersion. Similarly, a package using the contentFiles element (see the next section) should set minClientVersion to "3.3". Note also that because NuGet clients prior to 2.5 do not recognize this flag, they always refuse to install the package no matter what minClientVersion contains.
dasdas
2.0.0
dsadas
false
My package description.
Replacement tokens
When creating a package, the nuget pack command replaces $-delimited tokens in the .nuspec file's pack command's -properties switch.
On the command line, you specify token values with nuget pack -properties . For example, you can use a token such as $owners$ and $desc$ in the .nuspec and provide the values at packing time as follows:
nuget pack MyProject.csproj -properties
owners=janedoe,harikm,kimo,xiaop;desc="Awesome app logger utility"
To use values from a project, specify the tokens described in the table below (AssemblyInfo refers to the file in Properties such as AssemblyInfo.cs or AssemblyInfo.vb).
To use these tokens, run nuget pack with the project file rather than just the .nuspec. For example, when using the following command, the $id$ and $version$ tokens in a .nuspec file are replaced with the project's AssemblyName and AssemblyVersion values:
nuget pack MyProject.csproj
Typically, when you have a project, you create the .nuspec initially using nuget spec MyProject.csproj which automatically includes some of these standard tokens. However, if a project lacks values for required .nuspec elements, then nuget pack fails. Furthermore, if you change project values, be sure to rebuild before creating the package; this can be done conveniently with the pack command's build switch.
With the exception of $configuration$, values in the project are used in preference to any assigned to the same token on the command line.
| Token | Value source | Value |
|---|---|---|
| $id$ | Project file | AssemblyName (title) from the project file |
| $version$ | AssemblyInfo | AssemblyInformationalVersion if present, otherwise AssemblyVersion |
| $author$ | AssemblyInfo | AssemblyCompany |
| $title$ | AssemblyInfo | AssemblyTitle |
| $description$ | AssemblyInfo | AssemblyDescription |
| $copyright$ | AssemblyInfo | AssemblyCopyright |
| $configuration$ | Assembly DLL | Configuration used to build the assembly, defaulting to Debug. Note that to create a package using a Release configuration, you always use -properties Configuration=Release on the command line. |
Tokens can also be used to resolve paths when you include assembly files and content files. The tokens have the same names as the MSBuild properties, making it possible to select files to be included depending on the current build configuration. For example, if you use the following tokens in the .nuspec file:
And you build an assembly whose AssemblyName is LoggingLibrary with the Release configuration in MSBuild, the resulting lines in the .nuspec file in the package is as follows:
Dependencies element
The
| Attribute | Description |
|---|---|
id |
(Required) The package ID of the dependency, such as "EntityFramework" and "NUnit", which is the name of the package nuget.org shows on a package page. |
version |
(Required) The range of versions acceptable as a dependency. See Package versioning for exact syntax. Floating versions are not supported. |
| include | A comma-delimited list of include/exclude tags (see below) indicating of the dependency to include in the final package. The default value is all. |
| exclude | A comma-delimited list of include/exclude tags (see below) indicating of the dependency to exclude in the final package. The default value is build,analyzers which can be over-written. But content/ ContentFiles are also implicitly excluded in the final package which can't be over-written. Tags specified with exclude take precedence over those specified with include. For example, include="runtime, compile" exclude="compile" is the same as include="runtime". |
When uploading a package to nuget.org, each dependency's id attribute is limited to 128 characters and the version
attribute is limited to 256 characters.
| Include/Exclude tag | Affected folders of the target |
|---|---|
| contentFiles | Content |
| runtime | Runtime, Resources, and FrameworkAssemblies |
| compile | lib |
| build | build (MSBuild props and targets) |
| native | native |
| none | No folders |
| all | All folders |
For example, the following lines indicate dependencies on PackageA version 1.1.0 or higher, and PackageB version 1.x.
The following lines indicate dependencies on the same packages, but specify to include the contentFiles and build folders of PackageA and everything but the native and compile folders of PackageB"
Important
When creating a .nuspec from a project using nuget spec, dependencies that exist in that project are not automatically included in the resulting .nuspec file. Instead, use nuget pack myproject.csproj, and get the .nuspec file from within the generated .nupkg file. This .nuspec contains the dependencies.
Dependency groups
Version 2.0+
As an alternative to a single flat list, dependencies can be specified according to the framework profile of the target project using
Each group has an attribute named targetFramework and contains zero or more
The targetFramework attribute is used as the default or fallback list of dependencies. See Target frameworks for the exact framework identifiers.
Important
The group format cannot be intermixed with a flat list.
Note
The format of Target Framework Moniker (TFM) used in lib/ref folder is different when compared to the TFM used in dependency groups. If the target frameworks declared in the dependencies group and the lib/ref folder of .nuspec file do not have exact matches then pack command will raise NuGet Warning NU5128.
The following example shows different variations of the
Explicit assembly references
The packages.config to explicitly specify the assemblies that the target project should reference when using the package. Explicit references are typically used for design-time only assemblies. For more information, see the page on selecting assemblies referenced by projects for more information.
For example, the following xunit.dll and xunit.extensions.dll even if there are additional assemblies in the package:
Reference groups
As an alternative to a single flat list, references can be specified according to the framework profile of the target project using
Each group has an attribute named targetFramework and contains zero or more
The targetFramework attribute is used as the default or fallback list of references. See Target frameworks for the exact framework identifiers.
Important
The group format cannot be intermixed with a flat list.
The following example shows different variations of the
Framework assembly references
Framework assemblies are those that are part of the .NET framework and should already be in the global assembly cache (GAC) for any given machine. By identifying those assemblies within the
The
| Attribute | Description |
|---|---|
| assemblyName | (Required) The fully qualified assembly name. |
| targetFramework | (Optional) Specifies the target framework to which this reference applies. If omitted, indicates that the reference applies to all frameworks. See Target frameworks for the exact framework identifiers. |
The following example shows a reference to System.Net for all target frameworks, and a reference to System.ServiceModel for .NET Framework 4.0 only:
Including assembly files
If you follow the conventions described in Creating a Package, you do not have to explicitly specify a list of files in the .nuspec file. The nuget pack command automatically picks up the necessary files.
Important
When a package is installed into a project, NuGet automatically adds assembly references to the package's DLLs, excluding those that are named .resources.dll because they are assumed to be localized satellite assemblies. For this reason, avoid using .resources.dll for files that otherwise contain essential package code.
To bypass this automatic behavior and explicitly control which files are included in a package, place a
With NuGet 2.x and earlier, and projects using packages.config, the
File element attributes
Each
| Attribute | Description |
|---|---|
| src | The location of the file or files to include, subject to exclusions specified by the exclude attribute. The path is relative to the .nuspec file unless an absolute path is specified. The wildcard character * is allowed, and the double wildcard ** implies a recursive folder search. |
| target | The relative path to the folder within the package where the source files are placed, which must begin with lib, content, build, or tools. See Creating a .nuspec from a convention-based working directory. |
| exclude | A semicolon-delimited list of files or file patterns to exclude from the src location. The wildcard character * is allowed, and the double wildcard ** implies a recursive folder search. |
Examples
Single assembly
Source file:
library.dll
.nuspec entry:
Single assembly specific to a target framework
Source file:
library.dll
.nuspec entry:
Set of DLLs using a wildcard
Source files:
bin\release\libraryA.dll
bin\release\libraryB.dll
.nuspec entry:
DLLs for different frameworks
Source files:
lib\net40\library.dll
lib\net20\library.dll
.nuspec entry (using ** recursive search):
Excluding files
Source files:
\tools\fileA.bak
\tools\fileB.bak
\tools\fileA.log
\tools\build\fileB.log
.nuspec entries:
Including content files
Content files are immutable files that a package needs to include in a project. Being immutable, they are not intended to be modified by the consuming project. Example content files include:
- Images that are embedded as resources
- Source files that are already compiled
- Scripts that need to be included with the build output of the project
- Configuration files for the package that need to be included in the project but don't need any project-specific changes
Content files are included in a package using the content folder in the target attribute. However, such files are ignored when the package is installed in a project using PackageReference, which instead uses the
For maximum compatibility with consuming projects, a package ideally specifies the content files in both elements.
Using the files element for content files
For content files, simply use the same format as for assembly files, but specify content as the base folder in the target attribute as shown in the following examples.
Basic content files
Source files:
css\mobile\style1.css
css\mobile\style2.css
.nuspec entry:
Content files with directory structure
Source files:
css\mobile\style.css
css\mobile\wp7\style.css
css\browser\style.css
.nuspec entry:
Content file specific to a target framework
Source file:
css\cool\style.css
.nuspec entry
Content file copied to a folder with dot in name
In this case, NuGet sees that the extension in target does not match the extension in src and thus treats that part of the name in target as a folder:
Source file:
images\picture.png
.nuspec entry:
Content files without extensions
To include files without an extension, use the * or ** wildcards:
Source file:
flags\installed
.nuspec entry:
Content files with deep path and deep target
In this case, because the file extensions of the source and target match, NuGet assumes that the target is a file name and not a folder:
Source file:
css\cool\style.css
.nuspec entry:
Renaming a content file in the package
Source file:
ie\css\style.css
.nuspec entry:
Excluding files
Source file:
docs\*.txt (multiple files)
.nuspec entry:
Using the contentFiles element for content files
NuGet 4.0+ with PackageReference
By default, a package places content in a contentFiles folder (see below) and nuget pack included all files in that folder using default attributes. In this case it's not necessary to include a contentFiles node in the .nuspec at all.
To control which files are included, the
These files are specified with a set of attributes that describe how they should be used within the project system:
| Attribute | Description |
|---|---|
| include | (Required) The location of the file or files to include, subject to exclusions specified by the exclude attribute. The path is relative to the contentFiles folder unless an absolute path is specified. The wildcard character * is allowed, and the double wildcard ** implies a recursive folder search. |
| exclude | A semicolon-delimited list of files or file patterns to exclude from the src location. The wildcard character * is allowed, and the double wildcard ** implies a recursive folder search. |
| buildAction | The build action to assign to the content item for MSBuild, such as Content, None, Embedded Resource, Compile, etc. The default is Compile. |
| copyToOutput | A Boolean indicating whether to copy content items to the build (or publish) output folder. The default is false. |
| flatten | A Boolean indicating whether to copy content items to a single folder in the build output (true), or to preserve the folder structure in the package (false). This flag only works when copyToOutput flag is set to true. The default is false. |
When installing a package, NuGet applies the child elements of
Package folder structure
The package project should structure content using the following pattern:
/contentFiles/{codeLanguage}/{TxM}/{any?}
codeLanguagesmay becs,vb,fs,any, or the lowercase equivalent of a given$(ProjectLanguage)TxMis any legal target framework moniker that NuGet supports (see Target frameworks).- Any folder structure may be appended to the end of this syntax.
For example:
Language- and framework-agnostic:
/contentFiles/any/any/config.xml
net45 content for all languages
/contentFiles/any/net45/config.xml
C#-specific content for net45 and up
/contentFiles/cs/net45/sample.cs
Empty folders can use _._ to opt out of providing content for certain combinations of language and TxM, for example:
/contentFiles/vb/any/code.vb
/contentFiles/cs/any/_._
Example contentFiles section
...
Framework reference groups
Version 5.1+ wih PackageReference only
Framework References are a .NET Core concept representing shared frameworks such as WPF or Windows Forms. By specifying a shared framework, the package ensures that all its framework dependencies are included in the referencing project.
Each targetFramework attribute and zero or more
The following example shows a nuspec generated for a .NET Core WPF project. Note that hand authoring nuspecs that contain framework references is not recommended. Consider using the targets pack instead, which will automatically infer them from the project.
Example nuspec files
A simple .nuspec that does not specify dependencies or files
sample
1.2.3
Kim Abercrombie, Franck Halmaert
Sample exists only to show a sample .nuspec file.
en-US
http://xunit.codeplex.com/
MIT
A .nuspec with dependencies
sample
1.0.0
Microsoft
A .nuspec with files
routedebugger
1.0.0
Jay Hamlin
false
Route Debugger is a little utility I wrote...
A .nuspec with framework assemblies
PackageWithGacReferences
1.0
Author here
false
A package that has framework assemblyReferences depending
on the target framework.
In this example, the following are installed for specific project targets:
- .NET4 ->
System.Web,System.Net - .NET4 Client Profile ->
System.Net - Silverlight 3 ->
System.Json - WindowsPhone ->
Microsoft.Devices.Sensors