Dependencies Type
Paket API which is optimized for F# Interactive use.
Constructors
| Constructor |
Description
|
Full Usage:
Dependencies(dependenciesFileName)
Parameters:
string
Returns: Dependencies
|
|
Instance members
| Instance member |
Description
|
Full Usage:
this.Add
Parameters:
string option
package : string
version : string
force : bool
withBindingRedirects : bool
cleanBindingRedirects : bool
createNewBindingFiles : bool
interactive : bool
installAfter : bool
semVerUpdateMode : SemVerUpdateMode
touchAffectedRefs : bool
runResolver : bool
packageKind : PackageRequirementKind
|
Adds the given package with the given version to the dependencies file.
|
Full Usage:
this.Add
Parameters:
string option
package : string
version : string
force : bool
withBindingRedirects : bool
cleanBindingRedirects : bool
createNewBindingFiles : bool
interactive : bool
installAfter : bool
semVerUpdateMode : SemVerUpdateMode
touchAffectedRefs : bool
runResolver : bool
|
Adds the given package with the given version to the dependencies file.
|
Full Usage:
this.Add
Parameters:
string option
package : string
version : string
force : bool
withBindingRedirects : bool
cleanBindingRedirects : bool
createNewBindingFiles : bool
interactive : bool
installAfter : bool
semVerUpdateMode : SemVerUpdateMode
touchAffectedRefs : bool
|
Adds the given package with the given version to the dependencies file.
|
Full Usage:
this.Add
Parameters:
string option
package : string
version : string
|
Adds the given package with the given version to the dependencies file.
|
Full Usage:
this.Add
Parameters:
string
|
Adds the given package without version requirements to main dependency group of the dependencies file.
|
Full Usage:
this.Add
Parameters:
string option
package : string
|
Adds the given package without version requirements to the dependencies file.
|
Full Usage:
this.AddCredentials
Parameters:
string
username : string
password : string
authType : string
verify : bool
|
Adds credentials for a Nuget feed
|
Full Usage:
this.AddCredentials
Parameters:
string
username : string
password : string
authType : string
|
Adds credentials for a Nuget feed
|
Full Usage:
this.AddGit
Parameters:
string option
repository : string
version : string
options : InstallerOptions
|
Adds the given git repository to the dependencies file
|
Full Usage:
this.AddGit
Parameters:
string option
repository : string
version : string
|
Adds the given git repository to the dependencies file
|
Full Usage:
this.AddGit
Parameters:
string option
repository : string
|
Adds the given git repository to the dependencies file
|
Full Usage:
this.AddGithub
Parameters:
string option
repository : string
file : string
version : string
options : InstallerOptions
|
Adds the given github repository to the dependencies file.
|
Full Usage:
this.AddGithub
Parameters:
string option
repository : string
file : string
version : string
|
Adds the given github repository to the dependencies file.
|
Full Usage:
this.AddGithub
Parameters:
string option
repository : string
file : string
|
Adds the given github repository to the dependencies file.
|
Full Usage:
this.AddToProject
Parameters:
string option
package : string
version : string
force : bool
withBindingRedirects : bool
cleanBindingRedirects : bool
createNewBindingFiles : bool
projectName : string
installAfter : bool
semVerUpdateMode : SemVerUpdateMode
touchAffectedRefs : bool
runResolver : bool
packageKind : PackageRequirementKind
|
Adds the given package with the given version to the dependencies file.
|
Full Usage:
this.AddToProject
Parameters:
string option
package : string
version : string
force : bool
withBindingRedirects : bool
cleanBindingRedirects : bool
createNewBindingFiles : bool
projectName : string
installAfter : bool
semVerUpdateMode : SemVerUpdateMode
touchAffectedRefs : bool
runResolver : bool
|
Adds the given package with the given version to the dependencies file.
|
Full Usage:
this.AddToProject
Parameters:
string option
package : string
version : string
force : bool
withBindingRedirects : bool
cleanBindingRedirects : bool
createNewBindingFiles : bool
projectName : string
installAfter : bool
semVerUpdateMode : SemVerUpdateMode
touchAffectedRefs : bool
|
Adds the given package with the given version to the dependencies file.
|
Full Usage:
this.AddToken
Parameters:
string
token : string
|
Adds a token for a source
|
Full Usage:
this.DependenciesFile
Returns: string
|
Get path to dependencies file
|
Full Usage:
this.FindOutdated
Parameters:
bool
force : bool
includePrereleases : bool
groupName : Option<string>
Returns: (string * string * SemVerInfo) list
|
|
Full Usage:
this.FindPackageVersions
Parameters:
PackageSource seq
name : string
?maxResults : int
Returns: string array
|
|
Full Usage:
this.FindProjectsFor
Parameters:
string
package : string
Returns: ProjectFile list
|
Finds all projects where the given package is referenced.
|
Full Usage:
this.FindReferencesFor
Parameters:
string
package : string
Returns: string list
|
Finds all references files where the given package is referenced.
|
Full Usage:
this.FindReferencesFor
Parameters:
string
Returns: string list
|
Finds all references files where the given main group package is referenced.
|
Full Usage:
this.GenerateLoadScriptData
Parameters:
string
groups : string list
frameworks : string list
scriptTypes : string list
Returns: ScriptContent list
|
|
Full Usage:
this.GenerateLoadScripts
Parameters:
string list
frameworks : string list
scriptTypes : string list
|
|
Full Usage:
this.GetConditions
Returns: string list
|
|
Full Usage:
this.GetDefinedNuGetFeeds
Returns: string list
|
Returns all system-wide defined NuGet feeds. (Can be used for Autocompletion)
|
|
Returns an instance of the paket.dependencies file.
|
Full Usage:
this.GetDirectDependencies
Returns: (string * string * string) list
|
Returns the installed versions of all direct dependencies.
|
Full Usage:
this.GetDirectDependencies
Parameters:
ReferencesFile
Returns: (string * string * string) list
|
Returns the installed versions of all direct dependencies which are referenced in the references file.
|
Full Usage:
this.GetDirectDependenciesForPackage
Parameters:
GroupName
packageName : string
Returns: (string * string * string) list
|
Returns the direct dependencies for the given package.
|
Full Usage:
this.GetGroups
Returns: string list
|
Returns all groups.
|
Full Usage:
this.GetInstalledPackageModel
Parameters:
string option
packageName : string
Returns: InstallModel
|
Returns an InstallModel for the given package.
|
Full Usage:
this.GetInstalledPackages
Parameters:
ReferencesFile
Returns: (string * string * string) list
|
Returns the installed versions of all installed packages which are referenced in the references file.
|
Full Usage:
this.GetInstalledPackages
Returns: (string * string * string) list
|
Returns the installed versions of all installed packages.
|
Full Usage:
this.GetInstalledVersion
Parameters:
string option
packageName : string
Returns: string option
|
Returns the installed version of the given package.
|
Full Usage:
this.GetInstalledVersion
Parameters:
string
Returns: string option
|
Returns the installed version of the given package.
|
Full Usage:
this.GetLibraries
Parameters:
string option
packageName : string
frameworkIdentifier : TargetProfile
Returns: Library seq
|
Returns all libraries for the given package and framework.
|
|
Returns an instance of the paket.lock file.
|
|
Returns all sources from the dependencies file.
|
Full Usage:
this.Install
Parameters:
bool
withBindingRedirects : bool
cleanBindingRedirects : bool
createNewBindingFiles : bool
onlyReferenced : bool
semVerUpdateMode : SemVerUpdateMode
touchAffectedRefs : bool
generateLoadScripts : bool
providedFrameworks : string list
providedScriptTypes : string list
alternativeProjectRoot : string option
|
Installs all dependencies.
|
Full Usage:
this.Install
Parameters:
bool
|
Installs all dependencies.
|
|
Lists all paket.template files in the current solution.
|
Full Usage:
this.Pack
Parameters:
string
?buildConfig : string
?buildPlatform : string
?version : string
?specificVersions : (string * string) seq
?releaseNotes : string
?templateFile : string
?workingDir : string
?excludedTemplates : 'a
?lockDependencies : bool
?minimumFromLockFile : bool
?pinProjectReferences : bool
?interprojectReferencesConstraint : InterprojectReferencesConstraint option
?symbols : bool
?includeReferencedProjects : bool
?projectUrl : string
Type parameters: 'a (requires :> Microsoft.FSharp.Core.string Microsoft.FSharp.Collections.seq) |
|
Full Usage:
this.Remove
Parameters:
string option
package : string
force : bool
interactive : bool
installAfter : bool
|
Removes the given package from dependencies file.
|
Full Usage:
this.Remove
Parameters:
string option
package : string
|
Removes the given package from dependencies file.
|
Full Usage:
this.Remove
Parameters:
string
|
Removes the given package from the main dependency group of the dependencies file.
|
Full Usage:
this.RemoveFromProject
Parameters:
string option
package : string
force : bool
projectName : string
installAfter : bool
|
Removes the given package from the specified project
|
Full Usage:
this.Restore
Parameters:
bool
group : string option
onlyReferenced : bool
touchAffectedRefs : bool
ignoreChecks : bool
failOnFailedChecks : bool
targetFramework : string option
outputPath : string option
|
Restores packages for all available paket.references files (or all packages if onlyReferenced is false)
|
Full Usage:
this.Restore
Parameters:
bool
group : string option
project : string
touchAffectedRefs : bool
ignoreChecks : bool
failOnChecks : bool
targetFramework : string option
outputPath : string option
|
Restores the given paket.references files.
|
Full Usage:
this.Restore
Parameters:
bool
group : string option
files : string list
touchAffectedRefs : bool
ignoreChecks : bool
failOnChecks : bool
targetFramework : string option
outputPath : string option
|
Restores the given paket.references files.
|
Full Usage:
this.Restore
Parameters:
string option
files : string list
|
Restores the given paket.references files.
|
Full Usage:
this.Restore
Parameters:
string option
files : string list
ignoreChecks : bool
|
Restores the given paket.references files.
|
Full Usage:
this.Restore
|
Restores all dependencies. |
Full Usage:
this.Restore
Parameters:
bool
|
Restores all dependencies.
|
Full Usage:
this.RootPath
Returns: string
|
Get the root path
|
Full Usage:
this.SearchPackagesByName
Parameters:
string
?cancellationToken : CancellationToken
?maxResults : int
Returns: IObservable<string>
|
|
Full Usage:
this.ShowOutdated
Parameters:
bool
force : bool
includePrereleases : bool
groupName : Option<string>
|
|
Full Usage:
this.ShowReferencesFor
Parameters:
(string * string) list
|
Shows all references files where the given package is referenced.
|
Full Usage:
this.SimplePackagesRestore
|
Simple packages restore: - Doesn't restore projects - Doesn't write targets file |
Full Usage:
this.Simplify
Parameters:
bool
|
Converts the current package dependency graph to the simplest dependency graph.
|
Full Usage:
this.TurnOffAutoRestore
|
Removes paket.targets file and Import section from project files. |
Full Usage:
this.TurnOnAutoRestore
|
Writes paket.targets into the .paket folder and imports it into the projects without the .NET SDK. |
Full Usage:
this.Update
Parameters:
bool
withBindingRedirects : bool
cleanBindingRedirects : bool
createNewBindingFiles : bool
installAfter : bool
semVerUpdateMode : SemVerUpdateMode
touchAffectedRefs : bool
|
Updates all dependencies.
|
Full Usage:
this.Update
Parameters:
bool
withBindingRedirects : bool
cleanBindingRedirects : bool
createNewBindingFiles : bool
|
Updates all dependencies.
|
Full Usage:
this.Update
Parameters:
bool
|
Updates all dependencies.
|
Full Usage:
this.UpdateFilteredPackages
Parameters:
string option
package : string
version : string option
force : bool
withBindingRedirects : bool
cleanBindingRedirects : bool
createNewBindingFiles : bool
installAfter : bool
semVerUpdateMode : SemVerUpdateMode
touchAffectedRefs : bool
|
Update a filtered set of packages
|
Full Usage:
this.UpdateGroup
Parameters:
string
force : bool
withBindingRedirects : bool
cleanBindingRedirects : bool
createNewBindingFiles : bool
installAfter : bool
semVerUpdateMode : SemVerUpdateMode
touchAffectedRefs : bool
|
Updates dependencies in single group.
|
Full Usage:
this.UpdatePackage
Parameters:
string option
package : string
version : string option
force : bool
withBindingRedirects : bool
cleanBindingRedirects : bool
createNewBindingFiles : bool
installAfter : bool
semVerUpdateMode : SemVerUpdateMode
touchAffectedRefs : bool
|
Updates the given package.
|
Full Usage:
this.UpdatePackage
Parameters:
string option
package : string
version : string option
force : bool
semVerUpdateMode : SemVerUpdateMode
touchAffectedRefs : bool
|
Updates the given package.
|
Static members
| Static member |
Description
|
Full Usage:
Dependencies.ClearCache(?clearLocalCache)
Parameters:
bool
|
Clears the NuGet cache
|
Full Usage:
Dependencies.ConvertFromNuget(force, installAfter, initAutoRestore, credsMigrationMode, ?directory)
Parameters:
bool
installAfter : bool
initAutoRestore : bool
credsMigrationMode : string option
?directory : DirectoryInfo
|
Converts the solution from NuGet to Paket.
|
Full Usage:
Dependencies.FindPackageVersions(root, sources, name, ?maxResults, ?alternativeProjectRoot)
Parameters:
string
sources : PackageSource seq
name : string
?maxResults : int
?alternativeProjectRoot : string
Returns: string array
|
|
Full Usage:
Dependencies.FindPackagesByName(sources, searchTerm, ?maxResults)
Parameters:
PackageSource seq
searchTerm : string
?maxResults : int
Returns: string list
|
|
Full Usage:
Dependencies.FixNuspecs(projectFile, referencesFile, nuspecFileList, conditions)
Parameters:
ProjectFile
referencesFile : ReferencesFile
nuspecFileList : string list
conditions : string list
|
|
Full Usage:
Dependencies.FixNuspecs(projectFile, referencesFile, nuspecFileList)
Parameters:
ProjectFile
referencesFile : ReferencesFile
nuspecFileList : string list
|
|
Full Usage:
Dependencies.Init(directory, sources, additional)
Parameters:
string
sources : PackageSource list
additional : string list
|
Initialize paket.dependencies file in the given directory
|
Full Usage:
Dependencies.Init(directory)
Parameters:
string
|
Initialize paket.dependencies file in the given directory
|
Full Usage:
Dependencies.Init()
|
Initialize paket.dependencies file in current directory |
Full Usage:
Dependencies.Install(dependencies, ?path, ?force, ?withBindingRedirects, ?cleanBindingRedirects, ?createNewBindingFiles, ?onlyReferenced, ?semVerUpdateMode, ?touchAffectedRefs, ?generateLoadScripts, ?providedFrameworks, ?providedScriptTypes)
Parameters:
string
?path : string
?force : bool
?withBindingRedirects : bool
?cleanBindingRedirects : bool
?createNewBindingFiles : bool
?onlyReferenced : bool
?semVerUpdateMode : SemVerUpdateMode
?touchAffectedRefs : bool
?generateLoadScripts : bool
?providedFrameworks : string list
?providedScriptTypes : string list
|
Creates a paket.dependencies file with the given text in the current directory and installs it.
|
|
Tries to locate the paket.dependencies file in the given folder or a parent folder, throws an exception if unsuccessful.
|
|
Tries to locate the paket.dependencies file in the current folder or a parent folder, throws an exception if unsuccessful.
|
Full Usage:
Dependencies.Push(packageFileName, ?url, ?apiKey, ?endPoint, ?paketVersion, ?maxTrials, ?ignoreConflicts)
Parameters:
string
?url : string
?apiKey : string
?endPoint : string
?paketVersion : 'a
?maxTrials : int
?ignoreConflicts : bool
Type parameters: 'a |
Pushes a nupkg file.
|
Full Usage:
Dependencies.SearchPackagesByName(sources, searchTerm, ?cancellationToken, ?maxResults)
Parameters:
PackageSource seq
searchTerm : string
?cancellationToken : CancellationToken
?maxResults : int
Returns: IObservable<string>
|
|
|
Tries to locate the paket.dependencies file in the given folder or a parent folder.
|
|
Tries to locate the paket.dependencies file in the current folder or a parent folder.
|
Paket