nuget
api documents
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 <metadata> element.
01 Syntax
02 Methods
| Name | Overloads | Summary |
|---|---|---|
| ToString | 1 |
03 Properties
| Name | Overloads | Summary |
|---|---|---|
| id | 1 | The case-insensitive package identifier, which must be unique across nuget.org or whatever gallery the package resides in. |
| title | 1 | A human-friendly title of the package which may be used in some UI displays. |
| version | 1 | The version of the package, following the major.minor.patch pattern. |
| authors | 1 | A comma-separated list of packages authors, matching the profile names on nuget.org. |
| requireLicenseAcceptance | 1 | A Boolean value specifying whether the client must prompt the consumer to accept the package license before installing the package. |
| license | 1 | 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. |
| licenseUrl | 1 | A URL for the package's license, often shown in UIs like nuget.org. |
| icon | 1 | 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. |
| projectUrl | 1 | A URL for the package's home page, often shown in UI displays as well as nuget.org. |
| description | 1 | A description of the package for UI display. |
| copyright | 1 | (1.5+) Copyright details for the package. |
| readme | 1 | 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 packa… |
| tags | 1 | A space-delimited list of tags and keywords that describe the package and aid discoverability of packages through search and filtering. |
| repository | 1 | Repository metadata, consisting of four optional attributes: type and url (4.0+), and branch and commit (4.6+). |
| dependencies | 1 | A collection of zero or more <dependency> elements specifying the dependencies for the package. |
| frameworkAssemblies | 1 | (1.2+) A collection of zero or more <frameworkAssembly> elements identifying .NET Framework assembly references that this package requires, which ensures that references are… |
| language | 1 | The locale ID for the package. |
04 Members
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 128 characters.
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.
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.
A comma-separated list of packages authors, matching the profile names on nuget.org. These are displayed in the NuGet Gallery on nuget.org and are used to cross-reference packages by the same authors.
When uploading a package to nuget.org, the authors field Is limited to 4000 characters.
A Boolean value specifying whether the client must prompt the consumer to accept the package license before installing the package.
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:
<LICENSE type="expression">MIT</license>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:
<LICENSE type="expression">BSD-2-Clause OR MIT</license>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.
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.
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.
A description of the package for UI display.
When uploading a package to nuget.org, the description field Is limited to 4000 characters.
(1.5+) Copyright details for the package. When uploading a package to nuget.org, the copyright field Is limited to 4000 characters.
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).
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.
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.
When uploading a package to nuget.org, the type attribute is limited to 100 characters and the url attribute is limited to 4000 characters.
A collection of zero or more <dependency> elements specifying the dependencies for the package. Each dependency has attributes of id, version, include (3.x+), and exclude (3.x+).
(1.2+) A collection of zero or more <frameworkAssembly> elements identifying .NET Framework assembly references that this package requires, which ensures that references are added to projects consuming the package. Each frameworkAssembly has assemblyName and targetFramework attributes.
The locale ID for the package.