Paket


Dependencies

Namespace: Paket

Paket API which is optimized for F# Interactive use.

Constructors

ConstructorDescription
new(dependenciesFileName)
Signature: dependenciesFileName:string -> Dependencies

CompiledName: .ctor

Instance members

Instance memberDescription
Add(...)
Signature: (groupName:string option * package:string * version:string * force:bool * withBindingRedirects:bool * cleanBindingRedirects:bool * createNewBindingFiles:bool * interactive:bool * installAfter:bool * semVerUpdateMode:SemVerUpdateMode * touchAffectedRefs:bool * runResolver:bool) -> unit

Adds the given package with the given version to the dependencies file.

Add(...)
Signature: (groupName:string option * package:string * version:string * force:bool * withBindingRedirects:bool * cleanBindingRedirects:bool * createNewBindingFiles:bool * interactive:bool * installAfter:bool * semVerUpdateMode:SemVerUpdateMode * touchAffectedRefs:bool) -> unit

Adds the given package with the given version to the dependencies file.

Add(groupName, package, version)
Signature: (groupName:string option * package:string * version:string) -> unit

Adds the given package with the given version to the dependencies file.

Add(package)
Signature: package:string -> unit

Adds the given package without version requirements to main dependency group of the dependencies file.

Add(groupName, package)
Signature: (groupName:string option * package:string) -> unit

Adds the given package without version requirements to the dependencies file.

AddCredentials(...)
Signature: (source:string * username:string * password:string * authType:string) -> unit

Adds credentials for a Nuget feed

AddToken(source, token)
Signature: (source:string * token:string) -> unit

Adds a token for a source

AddToProject(...)
Signature: (groupName:string option * package:string * version:string * force:bool * withBindingRedirects:bool * cleanBindingRedirects:bool * createNewBindingFiles:bool * projectName:string * installAfter:bool * semVerUpdateMode:SemVerUpdateMode * touchAffectedRefs:bool * runResolver:bool) -> unit

Adds the given package with the given version to the dependencies file.

AddToProject(...)
Signature: (groupName:string option * package:string * version:string * force:bool * withBindingRedirects:bool * cleanBindingRedirects:bool * createNewBindingFiles:bool * projectName:string * installAfter:bool * semVerUpdateMode:SemVerUpdateMode * touchAffectedRefs:bool) -> unit

Adds the given package with the given version to the dependencies file.

DependenciesFile
Signature: string

Get path to dependencies file

CompiledName: get_DependenciesFile

DownloadLatestBootstrapper()
Signature: unit -> unit

Downloads the latest paket.bootstrapper into the .paket folder and try to rename it to paket.exe in order to activate magic mode.

FindOutdated(...)
Signature: (strict:bool * force:bool * includePrereleases:bool * groupName:Option<string>) -> (string * string * SemVerInfo) list
FindOutdated(...)
Signature: (strict:bool * includePrereleases:bool * groupName:Option<string>) -> (string * string * SemVerInfo) list

Finds all outdated packages.

FindPackageVersions(...)
Signature: (sources:seq<PackageSource> * name:string * maxResults:int option) -> string []
FindProjectsFor(group, package)
Signature: (group:string * package:string) -> ProjectFile list

Finds all projects where the given package is referenced.

FindReferencesFor(group, package)
Signature: (group:string * package:string) -> string list

Finds all references files where the given package is referenced.

FindReferencesFor(package)
Signature: package:string -> string list

Finds all references files where the given main group package is referenced.

GenerateLoadScriptData(...)
Signature: paketDependencies:string -> (groups:string list) -> (frameworks:string list) -> (scriptTypes:string list) -> ScriptContent list
GenerateLoadScripts(...)
Signature: (groups:string list) -> (frameworks:string list) -> (scriptTypes:string list) -> unit
GetDefinedNuGetFeeds()
Signature: unit -> string list

Returns all system-wide defined NuGet feeds. (Can be used for Autocompletion)

GetDependenciesFile()
Signature: unit -> DependenciesFile

Returns an instance of the paket.dependencies file.

GetDirectDependencies()
Signature: unit -> (string * string * string) list

Returns the installed versions of all direct dependencies.

GetDirectDependencies(referencesFile)
Signature: referencesFile:ReferencesFile -> (string * string * string) list

Returns the installed versions of all direct dependencies which are referenced in the references file.

GetDirectDependenciesForPackage(...)
Signature: (groupName:GroupName * packageName:string) -> (string * string * string) list

Returns the direct dependencies for the given package.

GetGroups()
Signature: unit -> string list

Returns all groups.

GetInstalledPackageModel(...)
Signature: (groupName:string option * packageName:string) -> InstallModel

Returns an InstallModel for the given package.

GetInstalledPackages(referencesFile)
Signature: referencesFile:ReferencesFile -> (string * string * string) list

Returns the installed versions of all installed packages which are referenced in the references file.

GetInstalledPackages()
Signature: unit -> (string * string * string) list

Returns the installed versions of all installed packages.

GetInstalledVersion(...)
Signature: (groupName:string option * packageName:string) -> string option

Returns the installed version of the given package.

GetInstalledVersion(packageName)
Signature: packageName:string -> string option

Returns the installed version of the given package.

GetLibraries(...)
Signature: (groupName:string option * packageName:string * frameworkIdentifier:TargetProfile) -> seq<Library>

Returns all libraries for the given package and framework.

GetLockFile()
Signature: unit -> LockFile

Returns an instance of the paket.lock file.

GetSources()
Signature: unit -> Map<GroupName,PackageSource list>

Returns all sources from the dependencies file.

Install(...)
Signature: (force:bool * withBindingRedirects:bool * cleanBindingRedirects:bool * createNewBindingFiles:bool * onlyReferenced:bool * semVerUpdateMode:SemVerUpdateMode * touchAffectedRefs:bool * generateLoadScripts:bool * providedFrameworks:string list * providedScriptTypes:string list * alternativeProjectRoot:string option) -> unit

Installs all dependencies.

Install(force)
Signature: force:bool -> unit

Installs all dependencies.

ListTemplateFiles()
Signature: unit -> TemplateFile list

Lists all paket.template files in the current solution.

Pack(...)
Signature: (outputPath:string * buildConfig:string option * buildPlatform:string option * version:string option * specificVersions:seq<string * string> option * releaseNotes:string option * templateFile:string option * workingDir:string option * excludedTemplates:'?7753 option * lockDependencies:bool option * minimumFromLockFile:bool option * pinProjectReferences:bool option * symbols:bool option * includeReferencedProjects:bool option * projectUrl:string option) -> unit
Type parameters: '?7753
Remove(...)
Signature: (groupName:string option * package:string * force:bool * interactive:bool * installAfter:bool) -> unit

Removes the given package from dependencies file.

Remove(groupName, package)
Signature: (groupName:string option * package:string) -> unit

Removes the given package from dependencies file.

Remove(package)
Signature: package:string -> unit

Removes the given package from the main dependency group of the dependencies file.

RemoveFromProject(...)
Signature: (groupName:string option * package:string * force:bool * projectName:string * installAfter:bool) -> unit

Removes the given package from the specified project

Restore(...)
Signature: (force:bool * group:string option * onlyReferenced:bool * touchAffectedRefs:bool * ignoreChecks:bool * failOnFailedChecks:bool * targetFramework:string option) -> unit

Restores packages for all available paket.references files (or all packages if onlyReferenced is false)

Restore(...)
Signature: (force:bool * group:string option * project:string * touchAffectedRefs:bool * ignoreChecks:bool * failOnChecks:bool * targetFramework:string option) -> unit

Restores the given paket.references files.

Restore(...)
Signature: (force:bool * group:string option * files:string list * touchAffectedRefs:bool * ignoreChecks:bool * failOnChecks:bool * targetFramework:string option) -> unit

Restores the given paket.references files.

Restore(group, files)
Signature: (group:string option * files:string list) -> unit

Restores the given paket.references files.

Restore(group, files, ignoreChecks)
Signature: (group:string option * files:string list * ignoreChecks:bool) -> unit

Restores the given paket.references files.

Restore()
Signature: unit -> unit

Restores all dependencies.

Restore(ignoreChecks)
Signature: ignoreChecks:bool -> unit

Restores all dependencies.

RootPath
Signature: string

Get the root path

CompiledName: get_RootPath

SearchPackagesByName(...)
Signature: (searchTerm:string * cancellationToken:CancellationToken option * maxResults:int option) -> IObservable<string>
ShowOutdated(...)
Signature: (strict:bool * force:bool * includePrereleases:bool * groupName:Option<string>) -> unit
ShowOutdated(...)
Signature: (strict:bool * includePrereleases:bool * groupName:Option<string>) -> unit

Lists outdated packages.

ShowReferencesFor(packages)
Signature: (packages:(string * string) list) -> unit

Shows all references files where the given package is referenced.

Simplify(interactive)
Signature: interactive:bool -> unit

Converts the current package dependency graph to the simplest dependency graph.

TurnOffAutoRestore()
Signature: unit -> unit

Removes paket.targets file and Import section from project files.

TurnOnAutoRestore()
Signature: unit -> unit

Pulls new paket.targets and bootstrapper and puts them into .paket folder.

Update(...)
Signature: (force:bool * withBindingRedirects:bool * cleanBindingRedirects:bool * createNewBindingFiles:bool * installAfter:bool * semVerUpdateMode:SemVerUpdateMode * touchAffectedRefs:bool) -> unit

Updates all dependencies.

Update(...)
Signature: (force:bool * withBindingRedirects:bool * cleanBindingRedirects:bool * createNewBindingFiles:bool) -> unit

Updates all dependencies.

Update(force)
Signature: force:bool -> unit

Updates all dependencies.

UpdateFilteredPackages(...)
Signature: (groupName:string option * package:string * version:string option * force:bool * withBindingRedirects:bool * cleanBindingRedirects:bool * createNewBindingFiles:bool * installAfter:bool * semVerUpdateMode:SemVerUpdateMode * touchAffectedRefs:bool) -> unit

Update a filtered set of packages

UpdateGroup(...)
Signature: (groupName:string * force:bool * withBindingRedirects:bool * cleanBindingRedirects:bool * createNewBindingFiles:bool * installAfter:bool * semVerUpdateMode:SemVerUpdateMode * touchAffectedRefs:bool) -> unit

Updates dependencies in single group.

UpdatePackage(...)
Signature: (groupName:string option * package:string * version:string option * force:bool * withBindingRedirects:bool * cleanBindingRedirects:bool * createNewBindingFiles:bool * installAfter:bool * semVerUpdateMode:SemVerUpdateMode * touchAffectedRefs:bool) -> unit

Updates the given package.

UpdatePackage(...)
Signature: (groupName:string option * package:string * version:string option * force:bool * semVerUpdateMode:SemVerUpdateMode * touchAffectedRefs:bool) -> unit

Updates the given package.

Static members

Static memberDescription
ClearCache()
Signature: unit -> unit

Clears the NuGet cache

ConvertFromNuget(...)
Signature: (force:bool * installAfter:bool * initAutoRestore:bool * credsMigrationMode:string option * directory:DirectoryInfo option) -> unit

Converts the solution from NuGet to Paket.

FindPackagesByName(...)
Signature: (sources:seq<PackageSource> * searchTerm:string * maxResults:int option) -> string list
FindPackageVersions(...)
Signature: (root:string * sources:seq<PackageSource> * name:string * maxResults:int option * alternativeProjectRoot:string option) -> string []
FixNuspecs(...)
Signature: (referencesFile:ReferencesFile * nuspecFileList:string list) -> unit
FixNuspecs(...)
Signature: (referencesFile:string * nuspecFileList:string list) -> unit

Fix the transitive references in a list of generated .nuspec files

Init(directory)
Signature: directory:string -> unit

Initialize paket.dependencies file in the given directory

Init()
Signature: unit -> unit

Initialize paket.dependencies file in current directory

Install(...)
Signature: (dependencies:string * path:string option * force:bool option * withBindingRedirects:bool option * cleanBindingRedirects:bool option * createNewBindingFiles:bool option * onlyReferenced:bool option * semVerUpdateMode:SemVerUpdateMode option * touchAffectedRefs:bool option * generateLoadScripts:bool option * providedFrameworks:string list option * providedScriptTypes:string list option) -> unit

Creates a paket.dependencies file with the given text in the current directory and installs it.

Locate(path)
Signature: path:string -> Dependencies

Tries to locate the paket.dependencies file in the given folder or a parent folder, throws an exception if unsuccessful.

Locate()
Signature: unit -> Dependencies

Tries to locate the paket.dependencies file in the current folder or a parent folder, throws an exception if unsuccessful.

Push(...)
Signature: (packageFileName:string * url:string option * apiKey:string option * endPoint:string option * paketVersion:'?7755 option * maxTrials:int option) -> unit
Type parameters: '?7755

Pushes a nupkg file.

SearchPackagesByName(...)
Signature: (sources:seq<PackageSource> * searchTerm:string * cancellationToken:CancellationToken option * maxResults:int option) -> IObservable<string>
TryLocate(path)
Signature: path:string -> Dependencies option

Tries to locate the paket.dependencies file in the given folder or a parent folder.

TryLocate()
Signature: unit -> Dependencies option

Tries to locate the paket.dependencies file in the current folder or a parent folder.

Fork me on GitHub