NuGet (Fake)

6.1.3

Lookig for older versions of the documentation, pre FAKE v6? See

NuGet Module

Namespace: Fake.DotNet.NuGet
Assembly: Fake.DotNet.NuGet.dll

Contains helper functions and task which allow to inspect, create and publish NuGet packages. There is also a tutorial about nuget package creating available.

Types

Type	Description
BreakingPoint	NuGet package versioning breaking changes point
NuGetDependency	Holds data for NuGet dependencies of a package
NuGetParams	Nuget base parameter type
NuGetPushParams	dotnet nuget push command options
NuSpecPackage	NuSpec metadata type Please see NuSpec reference
NugetDependencies
NugetFrameworkAssemblyReferences
NugetFrameworkDependencies
NugetFrameworkReferences
NugetPackageInfo	NuGet package information
NugetReferences
NugetSymbolPackage	Specifies that the package contains sources and symbols.
WebClient

Functions and values

Function or value	Description
`GetPackageVersion deploymentsDir package` Full Usage: `GetPackageVersion deploymentsDir package` Parameters: deploymentsDir : `string` - The deployment directory to look into package : `string` - The package id to look for Returns: `string`	Gets the version no. for a given package in the deployments folder deploymentsDir : `string` The deployment directory to look into package : `string` The package id to look for Returns: `string`
`NuGet setParams nuspecOrProjectFile` Full Usage: `NuGet setParams nuspecOrProjectFile` Parameters: setParams : `NuGetParams -> NuGetParams` - Function used to manipulate the default NuGet parameters. nuspecOrProjectFile : `string` - The .nuspec file name.	Creates a new NuGet package, and optionally publishes it. Template parameter substitution is performed when passing a .nuspec setParams : `NuGetParams -> NuGetParams` Function used to manipulate the default NuGet parameters. nuspecOrProjectFile : `string` The .nuspec file name.
`NuGetDefaults ()` Full Usage: `NuGetDefaults ()` Parameters: () : `unit` Returns: `NuGetParams`	NuGet default parameters () : `unit` Returns: `NuGetParams`
`NuGetPack setParams nuspecOrProjectFile` Full Usage: `NuGetPack setParams nuspecOrProjectFile` Parameters: setParams : `NuGetParams -> NuGetParams` - Function used to manipulate the default NuGet parameters. nuspecOrProjectFile : `string` - The .nuspec or project file name.	Creates a new NuGet package based on the given .nuspec or project file. Template parameter substitution is performed when passing a .nuspec setParams : `NuGetParams -> NuGetParams` Function used to manipulate the default NuGet parameters. nuspecOrProjectFile : `string` The .nuspec or project file name.
`NuGetPackDirectly setParams nuspecOrProjectFile` Full Usage: `NuGetPackDirectly setParams nuspecOrProjectFile` Parameters: setParams : `NuGetParams -> NuGetParams` - Function used to manipulate the default NuGet parameters. nuspecOrProjectFile : `string` - The .nuspec or project file name.	Creates a new NuGet package based on the given .nuspec or project file. The .nuspec / projectfile is passed as-is (no templating is performed) setParams : `NuGetParams -> NuGetParams` Function used to manipulate the default NuGet parameters. nuspecOrProjectFile : `string` The .nuspec or project file name.
`NuGetPublish setParams` Full Usage: `NuGetPublish setParams` Parameters: setParams : `NuGetParams -> NuGetParams` - Function used to manipulate the default NuGet parameters.	Publishes a NuGet package to the nuget server. setParams : `NuGetParams -> NuGetParams` Function used to manipulate the default NuGet parameters.
`RequireExactly version` Full Usage: `RequireExactly version` Parameters: version : `string` - The exact version to require Returns: `string`	Creates a string which tells NuGet that you require exactly this package version. version : `string` The exact version to require Returns: `string`
`RequireRange breakingPoint version` Full Usage: `RequireRange breakingPoint version` Parameters: breakingPoint : `BreakingPoint` - The breaking point for version range. See `BreakingPoint` type version : `string` - The version to use to find the range Returns: `string`	Require a version by given breaking point and version See NuGet Versioning breakingPoint : `BreakingPoint` The breaking point for version range. See `BreakingPoint` type version : `string` The version to use to find the range Returns: `string`
`galleryV3` Full Usage: `galleryV3` Returns: `string`	Default NuGet feed. Using V3 feed: https://api.nuget.org/v3/index.json Returns: `string`
`getDependencies packagesFile` Full Usage: `getDependencies packagesFile` Parameters: packagesFile : `string` - The packages file to use Returns: `NuGetDependency list`	Returns the dependencies from specified packages.config file packagesFile : `string` The packages file to use Returns: `NuGetDependency list`
`getLatestPackage repoUrl packageName` Full Usage: `getLatestPackage repoUrl packageName` Parameters: repoUrl : `string` - Query endpoint of NuGet search service packageName : `string` - The package to get Returns: `NugetPackageInfo`	Gets the latest published package from NuGet feed by package id. repoUrl : `string` Query endpoint of NuGet search service packageName : `string` The package to get Returns: `NugetPackageInfo`
`getNuspecProperties nuspec` Full Usage: `getNuspecProperties nuspec` Parameters: nuspec : `string` - The .nuspec file content. Returns: `NuSpecPackage`	Parses nuspec metadata from a nuspec file. nuspec : `string` The .nuspec file content. Returns: `NuSpecPackage`
`getPackage repoUrl packageName version` Full Usage: `getPackage repoUrl packageName version` Parameters: repoUrl : `string` - Query endpoint of NuGet search service packageName : `string` - The package to get version : `string` - The specific version to get Returns: `NugetPackageInfo`	Gets a Package information from NuGet feed by package id. repoUrl : `string` Query endpoint of NuGet search service packageName : `string` The package to get version : `string` The specific version to get Returns: `NugetPackageInfo`
`searchByTitle repoUrl packageName` Full Usage: `searchByTitle repoUrl packageName` Parameters: repoUrl : `string` - Query endpoint of NuGet search service packageName : `string` - The package to search for Returns: `NugetPackageInfo list`	Search NuGet query endpoint for packages matching given name by title repoUrl : `string` Query endpoint of NuGet search service packageName : `string` The package to search for Returns: `NugetPackageInfo list`

Type extensions

Type extension	Description
`this.DownloadData` Full Usage: `this.DownloadData` Parameters: uri : `string` Returns: `byte[]`	Extended Type: `HttpClient` uri : `string` Returns: `byte[]`
`this.DownloadData` Full Usage: `this.DownloadData` Parameters: uri : `Uri` Returns: `byte[]`	Extended Type: `HttpClient` uri : `Uri` Returns: `byte[]`
`this.DownloadDataTaskAsync` Full Usage: `this.DownloadDataTaskAsync` Parameters: uri : `Uri` Returns: `Task<byte[]>`	Extended Type: `HttpClient` uri : `Uri` Returns: `Task<byte[]>`
`this.DownloadDataTaskAsync` Full Usage: `this.DownloadDataTaskAsync` Parameters: uri : `string` Returns: `Task<byte[]>`	Extended Type: `HttpClient` uri : `string` Returns: `Task<byte[]>`
`this.DownloadFile` Full Usage: `this.DownloadFile` Parameters: uri : `string` filePath : `string`	Extended Type: `HttpClient` uri : `string` filePath : `string`
`this.DownloadFile` Full Usage: `this.DownloadFile` Parameters: uri : `Uri` filePath : `string`	Extended Type: `HttpClient` uri : `Uri` filePath : `string`
`this.DownloadFileTaskAsync` Full Usage: `this.DownloadFileTaskAsync` Parameters: uri : `Uri` filePath : `string` Returns: `Task<unit>`	Extended Type: `HttpClient` uri : `Uri` filePath : `string` Returns: `Task<unit>`
`this.DownloadFileTaskAsync` Full Usage: `this.DownloadFileTaskAsync` Parameters: uri : `string` filePath : `string` Returns: `Task<unit>`	Extended Type: `HttpClient` uri : `string` filePath : `string` Returns: `Task<unit>`
`this.DownloadString` Full Usage: `this.DownloadString` Parameters: uri : `string` Returns: `string`	Extended Type: `HttpClient` uri : `string` Returns: `string`
`this.DownloadString` Full Usage: `this.DownloadString` Parameters: uri : `Uri` Returns: `string`	Extended Type: `HttpClient` uri : `Uri` Returns: `string`
`this.DownloadStringTaskAsync` Full Usage: `this.DownloadStringTaskAsync` Parameters: uri : `Uri` Returns: `Task<string>`	Extended Type: `HttpClient` uri : `Uri` Returns: `Task<string>`
`this.DownloadStringTaskAsync` Full Usage: `this.DownloadStringTaskAsync` Parameters: uri : `string` Returns: `Task<string>`	Extended Type: `HttpClient` uri : `string` Returns: `Task<string>`
`this.UploadFileAsMultipart` Full Usage: `this.UploadFileAsMultipart` Parameters: url : `Uri` filename : `string` Returns: `HttpResponseMessage`	Extended Type: `HttpClient` url : `Uri` filename : `string` Returns: `HttpResponseMessage`