ICakeContext Interface

Summary

Represents a context for scripts and script aliases.

Syntax
public interface ICakeContext
Properties
Arguments ICakeArguments Gets the arguments.
Environment ICakeEnvironment Gets the environment.
FileSystem IFileSystem Gets the file system.
Globber IGlobber Gets the globber.
Log ICakeLog Gets the log.
ProcessRunner IProcessRunner Gets the process runner.
Registry IRegistry Gets the registry.
Tools IToolLocator Gets the tool locator.
Extension Methods
AdbConnectGenymotionSimulator(string, ​GenymotionDeviceSettings)​
AdbDisconnectGenymotionSimulator(string, ​GenymotionDeviceSettings)​
AddEmbeddedResources(FilePathCollection, ​FilePath)​ Adds absolute/relative file paths into a .proj as embed resource with relative paths
AddEmbeddedResources(FilePathCollection, ​string)​ Adds absolute/relative file paths into a .proj as embed resource with relative paths
AddEmbeddedResources(String[], ​string)​ Assuming files in project folder, adds absolute/relative file paths into a .proj file as embed resource (with relative paths to the project file)
AndroidPackage(FilePath, ​bool, ​Action<DotNetBuildSettings>)​ Creates an android .APK package file
AppBundle(FilePath, ​DirectoryPath)​
AppBundle(FilePath, ​DirectoryPath, ​AppPackagerSettings)​
AppBundle(FilePath, ​FilePath)​
AppBundle(FilePath, ​FilePath, ​AppPackagerSettings)​
AppDecrypter(FilePath, ​FilePath, ​FilePath)​
AppDecrypter(FilePath, ​FilePath)​
AppDecrypter(FilePath, ​FilePath, ​AppPackagerSettings)​
AppDecrypter(FilePath, ​FilePath, ​FilePath, ​AppPackagerSettings)​
AppEncrypter(FilePath, ​FilePath, ​FilePath)​
AppEncrypter(FilePath, ​FilePath)​
AppEncrypter(FilePath, ​FilePath, ​AppPackagerSettings)​
AppEncrypter(FilePath, ​FilePath, ​FilePath, ​AppPackagerSettings)​
AppPack(FilePath, ​DirectoryPath)​
AppPack(FilePath, ​DirectoryPath, ​AppPackagerSettings)​
AppPack(FilePath, ​FilePath)​
AppPack(FilePath, ​FilePath, ​AppPackagerSettings)​
AppUnbundle(FilePath, ​DirectoryPath)​
AppUnbundle(FilePath, ​DirectoryPath, ​AppPackagerSettings)​
AppUnpack(FilePath, ​DirectoryPath)​
AppUnpack(FilePath, ​DirectoryPath, ​AppPackagerSettings)​
AppVeyor Gets a AppVeyorProvider instance that can be used to manipulate the AppVeyor environment.
AppVeyorCancelBuild(string, ​string, ​string, ​string)​ Cancels a build
AppVeyorCancelDeployment(string, ​int)​ Cancels a Deployment
AppVeyorClearCache(AppVeyorSettings, ​string, ​string)​ Clears the AppVeyor Cache
AppVeyorClearCache(string, ​string, ​string)​ Gets all projects
AppVeyorDeployment(string, ​int)​ Gets the specified Deployment
AppVeyorEnvironmentDeployments(string, ​int)​ Gets Deployments for the given Environment
AppVeyorEnvironments(string)​ Gets Environments
AppVeyorProjectBuildByVersion(string, ​string, ​string, ​string)​ Gets the project build by version
AppVeyorProjectDeployments(string, ​string, ​string)​ Gets the Deployments for a given project
AppVeyorProjectHistory(AppVeyorSettings, ​string, ​string, ​int, ​Nullable<int>, ​string)​ Gets the project build history
AppVeyorProjectHistory(string, ​string, ​string, ​int, ​Nullable<int>, ​string)​ Gets the project build history
AppVeyorProjectLastBranchBuild(string, ​string, ​string, ​string)​ Gets the last build on the specified branch of the project
AppVeyorProjectLastBuild(AppVeyorSettings, ​string, ​string)​ Gets the last build of the project
AppVeyorProjectLastBuild(string, ​string, ​string)​ Gets the last build of the project
AppVeyorProjectLastSuccessfulBuild(AppVeyorSettings, ​string, ​string, ​string, ​Nullable<int>)​ Gets the last successful build of the project
AppVeyorProjectLastSuccessfulBuild(string, ​string, ​string, ​string, ​Nullable<int>)​ Gets the last successful build of the project
AppVeyorProjects(AppVeyorSettings)​ Gets all projects
AppVeyorProjects(string)​ Gets all projects
AppVeyorStartBuildLatestCommit(string, ​string, ​string, ​string, ​Dictionary<string,​ string>)​ Starts a build from the latest commit
AppVeyorStartBuildPullRequest(string, ​string, ​string, ​int)​ Starts a build for the given GitHub pull request
AppVeyorStartBuildSpecificCommit(string, ​string, ​string, ​string, ​string)​ Starts a build for a specific commit
AppVeyorStartDeployment(string, ​string, ​string, ​string, ​string, ​string, ​Dictionary<string,​ string>)​ Starts a Deployment
Argument(string)​ Gets an argument and throws if the argument is missing.
Argument(string, ​T)​ Gets an argument and returns the provided if the argument is missing.
AutoRest Get an AutoRestRunner for controlling AutoRest
Bamboo Gets a BambooProvider instance that can be used to manipulate the Bamboo environment.
BitbucketPipelines Gets a BitbucketPipelinesProvider instance that can be used to obtain information from the Bitbucket Pipelines environment.
Bitrise Gets a BitriseProvider instance that can be used to obtain information from the Bitrise environment.
BootAppleSimulator(string)​
BootAppleSimulator(string, ​SimCtlSettings)​
BuildSystem Gets a BuildSystem instance that can be used to query for information about the current build system.
BZip2Compress(DirectoryPath, ​FilePath)​ Create a BZip2 Tar archive of the specified directory.
BZip2Compress(DirectoryPath, ​FilePath, ​int)​ Create a BZip2 Tar archive of the specified directory.
BZip2Compress(DirectoryPath, ​FilePath, ​string)​ Create a BZip2 Tar archive of the files matching the specified pattern.
BZip2Compress(DirectoryPath, ​FilePath, ​string, ​int)​ Create a BZip2 Tar archive of the files matching the specified pattern.
BZip2Compress(DirectoryPath, ​FilePath, ​IEnumerable<FilePath>)​ Create a BZip2 Tar archive of the specified files.
BZip2Compress(DirectoryPath, ​FilePath, ​IEnumerable<FilePath>, ​int)​ Create a BZip2 Tar archive of the specified files.
BZip2Compress(DirectoryPath, ​FilePath, ​IEnumerable<string>)​ Create a BZip2 Tar archive of the specified files.
BZip2Compress(DirectoryPath, ​FilePath, ​IEnumerable<string>, ​int)​ Create a BZip2 Tar archive of the specified files.
BZip2Uncompress(FilePath, ​DirectoryPath)​ Uncompress the specified BZip2 Tar file.
CakeExecuteExpression(string)​ Executes Cake expression out of process
CakeExecuteExpression(string, ​CakeSettings)​ Executes Cake expression out of process
CakeExecuteScript(FilePath)​ Executes cake script out of process
CakeExecuteScript(FilePath, ​CakeSettings)​ Executes cake script out of process
CakeMail Gets a CakeMailProvider instance that can be used for communicating with CakeMailProvider API.
CalculateFileHash(FilePath)​ Calculates the hash for a given file using the default (SHA256) algorithm.
CalculateFileHash(FilePath, ​HashAlgorithm)​ Calculates the hash for a given file.
ChocolateyAddSource(string, ​string)​ Adds Chocolatey package source using the specified name &source to global user config
ChocolateyAddSource(string, ​string, ​ChocolateySourcesSettings)​ Adds Chocolatey package source using the specified name, source & settings to global user config
ChocolateyApiKey(string, ​string, ​ChocolateyApiKeySettings)​ Sets the Api Key for a Chocolatey Source using the specified settings.
ChocolateyConfig(string, ​string, ​ChocolateyConfigSettings)​ Sets the config parameter using the specified settings.
ChocolateyDisableFeature(string)​ Disables a Chocolatey Feature using the specified name
ChocolateyDisableFeature(string, ​ChocolateyFeatureSettings)​ Disables a Chocolatey Feature using the specified name and settings
ChocolateyDisableSource(string)​ Disables a Chocolatey Source using the specified name
ChocolateyDisableSource(string, ​ChocolateySourcesSettings)​ Disables a Chocolatey Source using the specified name and settings
ChocolateyEnableFeature(string)​ Enables a Chocolatey Feature using the specified name
ChocolateyEnableFeature(string, ​ChocolateyFeatureSettings)​ Enables a Chocolatey Feature using the specified name and settings
ChocolateyEnableSource(string)​ Enables a Chocolatey Source using the specified name
ChocolateyEnableSource(string, ​ChocolateySourcesSettings)​ Enables a Chocolatey Source using the specified name and settings
ChocolateyInstall(string)​ Installs a Chocolatey package.
ChocolateyInstall(string, ​ChocolateyInstallSettings)​ Installs a Chocolatey package using the specified settings.
ChocolateyInstallFromConfig(FilePath)​ Installs Chocolatey packages using the specified package configuration.
ChocolateyInstallFromConfig(FilePath, ​ChocolateyInstallSettings)​ Installs Chocolatey packages using the specified package configuration and settings.
ChocolateyPack(FilePath, ​ChocolateyPackSettings)​ Creates a Chocolatey package using the specified Nuspec file.
ChocolateyPack(ChocolateyPackSettings)​ Creates a Chocolatey package using the specified settings.
ChocolateyPin(string, ​ChocolateyPinSettings)​ Pins a Chocolatey package using the specified settings.
ChocolateyPush(FilePath, ​ChocolateyPushSettings)​ Pushes a Chocolatey package to a Chocolatey server and publishes it.
ChocolateyRemoveSource(string)​ Removes Chocolatey package source using the specified name & source from global user config
ChocolateyRemoveSource(string, ​ChocolateySourcesSettings)​ Removes Chocolatey package source using the specified name, source & settings from global user config
ChocolateyUpgrade(string)​ Upgrades Chocolatey package.
ChocolateyUpgrade(string, ​ChocolateyUpgradeSettings)​ Upgrades Chocolatey package using the specified settings.
CleanDirectories(string)​ Cleans the directories matching the specified pattern. Cleaning the directory will remove all its content but not the directory itself.
CleanDirectories(string, ​Func<IFileSystemInfo,​ bool>)​ Cleans the directories matching the specified pattern. Cleaning the directory will remove all its content but not the directory itself.
CleanDirectories(IEnumerable<DirectoryPath>)​ Cleans the specified directories. Cleaning a directory will remove all its content but not the directory itself.
CleanDirectories(IEnumerable<string>)​ Cleans the specified directories. Cleaning a directory will remove all its content but not the directory itself.
CleanDirectory(DirectoryPath)​ Cleans the specified directory.
CleanDirectory(DirectoryPath, ​Func<IFileSystemInfo,​ bool>)​ Cleans the specified directory.
CMake(DirectoryPath, ​CMakeSettings)​ Runs CMake with the specified source path and settings.
CocoaPodInstall(DirectoryPath)​ Runs pod install for the given project directory
CocoaPodInstall(DirectoryPath, ​CocoaPodInstallSettings)​ Runs pod install for the given project directory
CocoaPodRepoUpdate()​ Updates the CocoaPods repo
CocoaPodRepoUpdate(CocoaPodSettings)​ Updates the CocoaPods repo
CocoaPodUpdate(DirectoryPath)​ Runs pod update for the given project directory, updating all pods
CocoaPodUpdate(DirectoryPath, ​CocoaPodUpdateSettings)​ Runs pod update for the given project directory, updating all pods
CocoaPodUpdate(DirectoryPath, ​String[], ​CocoaPodUpdateSettings)​ Runs pod update for the given project directory, updating only the specified pods
CocoaPodVersion()​ Returns the version of CocoaPods
CocoaPodVersion(CocoaPodSettings)​ Returns the version of CocoaPods
ConfigureGenymotion(GenymotionConfigSettings)​
ContinuaCI Gets a ContinuaCIProvider instance that can be used to manipulate the Continua CI environment.
CopyDirectory(DirectoryPath, ​DirectoryPath)​ Copies the contents of a directory, including subdirectories to the specified location.
CopyFile(FilePath, ​FilePath)​ Copies an existing file to a new file, providing the option to specify a new file name.
CopyFiles(string, ​DirectoryPath)​ Copies all files matching the provided pattern to a new location.
CopyFiles(IEnumerable<FilePath>, ​DirectoryPath)​ Copies existing files to a new location.
CopyFiles(IEnumerable<string>, ​DirectoryPath)​ Copies existing files to a new location.
CopyFiles(string, ​DirectoryPath, ​bool)​ Copies all files matching the provided pattern to a new location.
CopyFiles(IEnumerable<FilePath>, ​DirectoryPath, ​bool)​ Copies existing files to a new location.
CopyFiles(IEnumerable<string>, ​DirectoryPath, ​bool)​ Copies existing files to a new location.
CopyFileToDirectory(FilePath, ​DirectoryPath)​ Copies an existing file to a new location.
CoverallsIo(FilePath)​ Uploads the code coverage report to Coveralls.io using the coveralls.io tool.
CoverallsIo(FilePath, ​CoverallsIoSettings)​ Uploads the code coverage report to Coveralls.io using the coveralls.io tool with the specified settings
CoverallsNet(FilePath, ​CoverallsNetReportType)​ Uploads the code coverage report to Coveralls.io using the coveralls.net tool.
CoverallsNet(FilePath, ​CoverallsNetReportType, ​CoverallsNetSettings)​ Uploads the code coverage report to Coveralls.io using the coveralls.net tool with the specified settings.
CreateAssemblyInfo(FilePath, ​AssemblyInfoSettings)​ Creates an assembly information file.
CreateDatabase(string, ​string)​ Creates an empty database. If database with this name already exists, throws a SqlException. Cake.SqlServer.SqlServerAliases.CreateDatabaseIfNotExists(Cake.Core.ICakeContext,System.String,System.String) if you would like to check if database already exists.
CreateDatabaseIfNotExists(string, ​string)​ Creates an empty database if another database with the same does not already exist.
CreateDirectory(DirectoryPath)​ Creates the specified directory.
CreateSemVer(int, ​int, ​int)​ Create a Semantic Version instance
CreateSemVer(int, ​int, ​int, ​string)​ Create a Semantic Version instance
CreateSemVer(int, ​int, ​int, ​string, ​string)​ Create a Semantic Version instance
Debug(string, ​Object[])​ Writes a debug message to the log using the specified format information.
Debug(LogAction)​ Writes a debug message to the log using the specified log message action. Evaluation message only if verbosity same or more verbose.
DeleteBlob(AzureStorageSettings)​ Deletes an Azure Storage blob
DeleteBlobsByPrefix(AzureStorageSettings)​ Deletes an Azure Storage blobs by prefix.
DeleteDirectories(IEnumerable<DirectoryPath>, ​bool)​ Deletes the specified directories.
DeleteDirectories(IEnumerable<string>, ​bool)​ Deletes the specified directories.
DeleteDirectory(DirectoryPath, ​bool)​ Deletes the specified directory.
DeleteFile(FilePath)​ Deletes the specified file.
DeleteFiles(string)​ Deletes the specified files.
DeleteFiles(IEnumerable<FilePath>)​ Deletes the specified files.
DeserializeAppManifest(string)​
DeserializeAppManifest(FilePath)​
DeserializeJson(string)​ Deserializes the JSON from a string.
DeserializeJsonFromFile(FilePath)​ Deserializes the JSON from a file.
DeserializePlist(FilePath)​ Deserializes a plist from file
DeserializePlistXml(string)​ Desierializes plist from xml
DeserializeYaml(string)​ Deserializes the YAML from a string.
DeserializeYamlFromFile(FilePath)​ Deserializes the YAML from a file.
Directory(string)​ Gets a directory path from string.
DirectoryExists(DirectoryPath)​ Determines whether the given path refers to an existing directory.
DNUBuild(string)​ Build all projects.
DNUBuild(string, ​DNUBuildSettings)​ Build all projects.
DNUPack(string)​ Pack all projects.
DNUPack(string, ​DNUPackSettings)​ Pack all projects.
DNURestore()​ Restore all NuGet Packages.
DNURestore(FilePath)​ Restore all NuGet Packages in the specified path.
DNURestore(DNURestoreSettings)​ Restore all NuGet Packages with the settings.
DNURestore(FilePath, ​DNURestoreSettings)​ Restore all NuGet Packages in the specified path with settings.
DocFx()​ Builds DocFx API metadata and markdown files.
DocFx(FilePath)​ Builds markdown and API documentation using DocFx.
DocFx(DocFxSettings)​ Builds markdown and API documentation using DocFx, with the specified settings.
DocFx(FilePath, ​DocFxSettings)​ Builds markdown and API documentation using DocFx, with the specified settings.
DocFxBuild()​ Builds markdown only using DocFx. This will not build API documentation.
DocFxBuild(FilePath)​ Builds markdown only using DocFx. This will not build API documentation.
DocFxBuild(DocFxBuildSettings)​ Builds markdown only using DocFx, with the specified settings. This will not build API documentation.
DocFxBuild(FilePath, ​DocFxBuildSettings)​ Builds markdown only using DocFx, with the specified settings. This will not build API documentation.
DocFxMetadata()​ Extract API documentation using DocFx.
DocFxMetadata(FilePath)​ Extract API documentation using DocFx.
DocFxMetadata(IEnumerable<FilePath>)​ Extract API documentation using DocFx, with the specified project/source files or search patterns.
DocFxMetadata(DocFxMetadataSettings)​ Extract API documentation using DocFx, with the specified settings.
DockerBuild(string)​ Builds an image using default settings.
DockerBuild(DockerBuildSettings, ​string)​ Builds an image given .
DockerComposeBuild(String[])​ Runs docker-compose build with default settings.
DockerComposeBuild(DockerComposeBuildSettings, ​String[])​ Runs docker-compose build given .
DockerComposeCreate(String[])​ Runs docker-compose create with default settings.
DockerComposeCreate(DockerComposeCreateSettings, ​String[])​ Runs docker-compose create given .
DockerComposeDown()​ Runs docker-compose down with default settings.
DockerComposeDown(DockerComposeDownSettings)​ Runs docker-compose down given .
DockerComposeKill()​ Runs docker-compose kill with default settings.
DockerComposeKill(DockerComposeKillSettings)​ Runs docker-compose kill given .
DockerComposePause(String[])​ Runs docker-compose pause with default settings.
DockerComposePause(DockerComposeSettings, ​String[])​ Runs docker-compose pause.
DockerComposePull(String[])​ Runs docker-compose pull with default settings.
DockerComposePull(DockerComposePullSettings, ​String[])​ Runs docker-compose pull given .
DockerComposeRestart(String[])​ Runs docker-compose restart with default settings.
DockerComposeRestart(DockerComposeRestartSettings, ​String[])​ Runs docker-compose restart given .
DockerComposeRm(String[])​ Runs docker-compose rm with default settings.
DockerComposeRm(DockerComposeRmSettings, ​String[])​ Runs docker-compose rm given .
DockerComposeRun(string, ​String[])​ Runs docker-compose run with default settings.
DockerComposeRun(string, ​string, ​String[])​ Runs docker-compose run with default settings.
DockerComposeRun(DockerComposeRunSettings, ​string, ​String[])​ Runs docker-compose run given .
DockerComposeRun(DockerComposeRunSettings, ​string, ​string, ​String[])​ Runs docker-compose run given .
DockerComposeScale(String[])​ Runs docker-compose scale with default settings.
DockerComposeScale(DockerComposeSettings, ​String[])​ Runs docker-compose scale.
DockerComposeStart(String[])​ Runs docker-compose start with default settings.
DockerComposeStart(DockerComposeSettings, ​String[])​ Runs docker-compose start.
DockerComposeStop(String[])​ Runs docker-compose stop with default settings.
DockerComposeStop(DockerComposeBuildSettings, ​String[])​ Runs docker-compose stop given .
DockerComposeUnpause(String[])​ Runs docker-compose unpause with default settings.
DockerComposeUnpause(DockerComposeSettings, ​String[])​ Runs docker-compose unpause.
DockerComposeUp(String[])​ Runs docker-compose up with default settings.
DockerComposeUp(DockerComposeUpSettings, ​String[])​ Runs docker-compose up given .
DockerCp(string, ​string)​ Copy files from/to using default settings.
DockerCp(string, ​string, ​DockerCpSettings)​ Copy files from/to container given .
DockerCreate(string, ​string, ​String[])​ Creates a new container using default settings.
DockerCreate(DockerCreateSettings, ​string, ​string, ​String[])​ Creates a new container given .
DockerLoad(DockerLoadSettings)​ Load an image from a tar archive or STDIN.
DockerLogin(string, ​string, ​string)​ Register or log in to a Docker registry. If no server is specified, the docker engine default is used.
DockerLogin(DockerLoginSettings, ​string)​ Register or log in to a Docker registry. If no server is specified, the docker engine default is used.
DockerNetworkConnect(string, ​string, ​String[])​ Connects a container to a network using default settings.
DockerNetworkConnect(DockerNetworkConnectSettings, ​string, ​string, ​String[])​ Connects a container to a network given .
DockerNetworkCreate(String[])​ Crates a network using default settings.
DockerNetworkCreate(DockerNetworkCreateSettings, ​String[])​ Crates a network given .
DockerNetworkDisconnect(String[])​ Disconnects a network using default settings.
DockerNetworkDisconnect(DockerNetworkDisconnectSettings, ​String[])​ Disconnects a network given .
DockerNetworkRemove(string, ​String[])​ Removes a network.
DockerNetworkRemove(String[], ​String[])​ Removes networks.
DockerPs()​ Lists containers using default settings.
DockerPs(DockerPsSettings)​ Lists containers using the given .
DockerPull(string)​ Pull an image or a repository from the registry.
DockerPull(DockerPullSettings, ​string)​ Pull an image or a repository from the registry with given .
DockerPush(string)​ Push an image or a repository to the registry.
DockerPush(DockerPushSettings, ​string)​ Push an image or a repository to the registry with given .
DockerRm(String[])​ Removes an array of using default settings.
DockerRm(DockerRmSettings, ​String[])​ Removes an array of using the given .
DockerRmi(String[])​ Removes an array of using default settings.
DockerRmi(DockerRmiSettings, ​String[])​ Removes an array of using the give .
DockerRun(string, ​string, ​String[])​ Creates a new container using default settings.
DockerRun(DockerRunSettings, ​string, ​string, ​String[])​ Creates a new container given .
DockerSave(DockerSaveSettings, ​String[])​ Save one or more images to a tar archive (streamed to STDOUT by default).
DockerStop(String[])​ Stops an array of using default settings.
DockerStop(DockerStopSettings, ​String[])​ Stops an array of using the give .
DockerSwarmInit(String[])​ Initializes a swarm using default settings.
DockerSwarmInit(DockerSwarmInitSettings, ​String[])​ Initializes a swarm given .
DockerSwarmJoin(String[])​ Joins a swarm using default settings.
DockerSwarmJoin(DockerSwarmJoinSettings, ​String[])​ Joins a swarm given .
DockerSwarmLeave(String[])​ Leaves a swarm using default settings.
DockerSwarmLeave(DockerSwarmLeaveSettings, ​String[])​ Leaves a swarm given .
DockerSwarmUpdate(String[])​ Updates a swarm using default settings.
DockerSwarmUpdate(DockerSwarmUpdateSettings, ​String[])​ Updates a swarm given .
DockerTag(string, ​string)​ Tag an image into a repository.
DoInDirectory(DirectoryPath, ​Action)​ Changes the current working directory before an System.Action and returns to the previous one in the end
DotCoverAnalyse(Action<ICakeContext>, ​FilePath, ​DotCoverAnalyseSettings)​ Runs DotCover Analyse for the specified action and settings.
DotCoverCover(Action<ICakeContext>, ​FilePath, ​DotCoverCoverSettings)​ Runs DotCover Cover for the specified action and settings.
DotCoverReport(FilePath, ​FilePath, ​DotCoverReportSettings)​ Runs DotCover Report for the specified action and settings.
DotNetBuild(FilePath)​ Builds the specified solution using MSBuild or XBuild.
DotNetBuild(FilePath, ​Action<DotNetBuildSettings>)​ Builds the specified solution using MSBuild or XBuild.
DotNetCoreBuild(string)​ Build all projects.
DotNetCoreBuild(string, ​DotNetCoreBuildSettings)​ Build all projects.
DotNetCoreExecute(FilePath)​ Execute an assembly.
DotNetCoreExecute(FilePath, ​ProcessArgumentBuilder)​ Execute an assembly with arguments in the specific path.
DotNetCoreExecute(FilePath, ​ProcessArgumentBuilder, ​DotNetCoreSettings)​ Execute an assembly with arguments in the specific path with settings.
DotNetCorePack(string)​ Package all projects.
DotNetCorePack(string, ​DotNetCorePackSettings)​ Package all projects.
DotNetCorePublish(string)​ Publish all projects.
DotNetCorePublish(string, ​DotNetCorePublishSettings)​ Publish all projects.
DotNetCoreRestore()​ Restore all NuGet Packages.
DotNetCoreRestore(string)​ Restore all NuGet Packages in the specified path.
DotNetCoreRestore(DotNetCoreRestoreSettings)​ Restore all NuGet Packages with the settings.
DotNetCoreRestore(string, ​DotNetCoreRestoreSettings)​ Restore all NuGet Packages in the specified path with settings.
DotNetCoreRun()​ Run all projects.
DotNetCoreRun(string)​ Run project.
DotNetCoreRun(string, ​ProcessArgumentBuilder)​ Run project with path and arguments.
DotNetCoreRun(string, ​ProcessArgumentBuilder, ​DotNetCoreRunSettings)​ Run project with settings.
DotNetCoreTest()​ Test project.
DotNetCoreTest(string)​ Test project with path.
DotNetCoreTest(string, ​DotNetCoreTestSettings)​ Test project with settings.
DownloadFile(string)​ Downloads the specified resource over HTTP to a temporary file.
DownloadFile(string, ​DownloadFileSettings)​ Downloads the specified resource over HTTP to a temporary file with specified settings.
DownloadFile(Uri)​ Downloads the specified resource over HTTP to a temporary file.
DownloadFile(Uri, ​DownloadFileSettings)​ Downloads the specified resource over HTTP to a temporary file with specified settings.
DownloadFile(string, ​FilePath)​ Downloads the specified resource over HTTP to the specified output path.
DownloadFile(string, ​FilePath, ​DownloadFileSettings)​ Downloads the specified resource over HTTP to the specified output path and settings.
DownloadFile(Uri, ​FilePath, ​DownloadFileSettings)​ Downloads the specified resource over HTTP to the specified output path.
DropAndCreateDatabase(string, ​string)​ First drops, then recreates the database
DropDatabase(string, ​string)​ Drops database. Before dropping the DB, database is set to be offline, then online again. This is to be sure that there are no live connections, otherwise the script will fail. Also if the database does not exist - it will not do anything.
DupFinder(FilePath)​ Analyses the specified file with ReSharper's DupFinder. The file can either be a solution/project or a source file.
DupFinder(FilePath, ​DupFinderSettings)​ Analyses the specified file with ReSharper's DupFinder using the specified settings. The file can either be a solution/project or a source file.
DupFinder(IEnumerable<FilePath>)​ Analyses the specified projects with ReSharper's DupFinder. The files can either be solutions and projects or a source files.
DupFinder(IEnumerable<FilePath>, ​DupFinderSettings)​ Analyses the specified projects with ReSharper's DupFinder using the specified settings. The files can either be solutions and projects or a source files.
DupFinder(string)​ Analyses all files matching the specified pattern with ReSharper's DupFinder.
DupFinder(string, ​DupFinderSettings)​ Analyses all files matching the specified pattern with ReSharper's DupFinder, using the specified settings.
DupFinderFromConfig(FilePath)​ Runs ReSharper's DupFinder using the provided config file.
Email Gets a EmailProvider instance that can be used for sending emails.
EnsureDirectoryExists(DirectoryPath)​ Creates the specified directory if it does not exist.
EnvironmentVariable(string)​ Retrieves the value of the environment variable or null if the environment variable does not exist.
EnvironmentVariables()​ Retrieves all environment variables
EraseAllAppleSimulators()​
EraseAllAppleSimulators(SimCtlSettings)​
EraseAppleSimulator(string)​
EraseAppleSimulator(string, ​SimCtlSettings)​
Error(string, ​Object[])​ Writes an error message to the log using the specified format information.
Error(LogAction)​ Writes an error message to the log using the specified log message action. Evaluation message only if verbosity same or more verbose.
ExecuteSqlCommand(string, ​string)​ Execute any SQL command.
ExecuteSqlCommand(SqlConnection, ​string)​ Execute any SQL command.
ExecuteSqlFile(string, ​FilePath)​ Reads SQL commands from a file and executes them.
ExecuteSqlFile(SqlConnection, ​FilePath)​ Reads SQL commands from a file and executes them.
FactoryResetGenymotionSimulator(string, ​GenymotionAdminSettings)​
Figlet(string)​ Returns ASCII art for the specified text using the default font.
Figlet(string, ​FilePath)​ Returns ASCII art for the specified text using a custom figlet font file.
File(string)​ Gets a file path from string.
FileAppendLines(FilePath, ​String[])​ Appends all text lines to a file
FileAppendText(FilePath, ​string)​ Appends all text to a file
FileExists(FilePath)​ Determines whether the given path refers to an existing file.
FileReadLines(FilePath)​ Reads all lines from a file
FileReadText(FilePath)​ Reads all text from a file
FileSize(FilePath)​ Gets the size of a file in bytes.
FileWriteLines(FilePath, ​String[])​ Writes all text lines to a file
FileWriteText(FilePath, ​string)​ Writes all text to a file
FilterModuleBinaries(FilePathCollection, ​FilePathCollection)​
FilterThemeBinaries(FilePathCollection, ​FilePathCollection)​
FindRegexInFiles(string, ​string)​ Finds files with regular expression pattern in files matching the given globber pattern.
FindRegexInFiles(string, ​string, ​RegexOptions)​ Finds files with regular expression pattern in files matching the given globber pattern.
FindRegexMatchesInFile(FilePath, ​string, ​RegexOptions)​ Finds the regex matches in a text file.
FindRegexMatchInFile(FilePath, ​string, ​RegexOptions)​ Finds the first regex match in a textfile.
FindTextInFiles(string, ​string)​ Finds files with the given text in files matching the given globber pattern.
Fixie(string)​ Runs all Fixie tests in the assemblies matching the specified pattern.
Fixie(string, ​FixieSettings)​ Runs all Fixie tests in the assemblies matching the specified pattern, using the specified settings.
Fixie(IEnumerable<string>)​ Runs all Fixie tests in the specified assemblies.
Fixie(IEnumerable<FilePath>)​ Runs all Fixie tests in the specified assemblies.
Fixie(IEnumerable<string>, ​FixieSettings)​ Runs all Fixie tests in the specified assemblies, using the specified settings.
Fixie(IEnumerable<FilePath>, ​FixieSettings)​ Runs all Fixie tests in the specified assemblies, using the specified settings.
FluentMigrator(FluentMigratorSettings)​ Executes FluentMigrator using the specified settings.
FluentMigrator(string, ​string, ​FilePath)​ Executes FluentMigrator using the specified parameters.
FtpDeleteFile(Uri, ​string, ​string)​ Delets the file on the FTP server using the supplied credentials.
FtpDeleteFile(Uri, ​FtpSettings)​ Delets the file on the FTP server using the supplied credentials.
FtpUploadFile(Uri, ​FilePath, ​string, ​string)​ Uploads the file to the FTP server using the supplied credentials.
FtpUploadFile(Uri, ​FilePath, ​FtpSettings)​ Uploads the file to the FTP server using the supplied credentials.
GemBuild(FilePath)​ Builds the gem using the path to the gemspec file.
GemBuild(FilePath, ​GemBuildSettings)​ Builds the gem using the path to the gemspec file and any additional settings.
GemPush(FilePath)​ Pushes the gem using the path to the gem file.
GemPush(FilePath, ​GemPushSettings)​ Pushes the gem using the path to the gem file and any additional settings.
GetDirectories(string)​ Gets all directory matching the specified pattern.
GetDirectories(string, ​Func<IDirectory,​ bool>)​ Gets all directory matching the specified pattern.
GetFiles(string)​ Gets all files matching the specified pattern.
GetFiles(string, ​Func<IDirectory,​ bool>)​ Gets all files matching the specified pattern.
GetFullVersionNumber(FilePath)​ Get the version number from an assembly in 4-digit format.
GetFullVersionNumberWithContinuesIntegrationNumberAppended(FilePath, ​int)​ Get the version number from an assembly in 4-digit format with the current build number appended.
GetNuGetPackageId(FilePath)​ Gets the Package Id from a .nupkg file
GetNuGetPackageVersion(FilePath)​ Gets the Package Version from a .nupkg file
GetPackageReference(DirectoryPath, ​string)​ Get a NuGet project dependency by .
GetPackageReferences(DirectoryPath)​ NuGet project dependencies.
GetVersionNumber(FilePath)​ Get the version number from an assembly in SemVer format.
GetVersionNumberWithContinuesIntegrationNumberAppended(FilePath, ​int)​ Get the version number with the current build number appended. This is based on the article found here: http://www.xavierdecoster.com/semantic-versioning-auto-incremented-nuget-package-versions
GitAdd(DirectoryPath, ​FilePath[])​ Add file to index.
GitAddAll(DirectoryPath)​ Add all file changes to index.
GitBranchCurrent(DirectoryPath)​ Gets the current branch.
GitCheckout(DirectoryPath, ​string, ​FilePath[])​ Checkout file(s) using supplied commit or branch spec.
GitCheckout(DirectoryPath, ​FilePath[])​ Checkout file.
GitClone(string, ​DirectoryPath)​ Clone unauthenticated using default options.
GitClone(string, ​DirectoryPath, ​GitCloneSettings)​ Clone unauthenticated using default options.
GitClone(string, ​DirectoryPath, ​string, ​string)​ Clone authenticated using default options.
GitClone(string, ​DirectoryPath, ​string, ​string, ​GitCloneSettings)​ Clone authenticated using default options.
GitCommit(DirectoryPath, ​string, ​string, ​string)​ Commit using default options.
GitDescribe(DirectoryPath)​ Describe current branch.
GitDescribe(DirectoryPath, ​GitDescribeStrategy)​ Describe current branch.
GitDescribe(DirectoryPath, ​bool, ​GitDescribeStrategy)​ Describe current branch.
GitDescribe(DirectoryPath, ​bool, ​GitDescribeStrategy, ​Nullable<int>)​ Describe current branch.
GitDescribe(DirectoryPath, ​string, ​bool, ​GitDescribeStrategy, ​Nullable<int>)​ Describe specified commit-ish.
GitDiff(DirectoryPath)​ Get changed files from inital commit id up to current.
GitDiff(DirectoryPath, ​string)​ Get changed files from certain commit id up to current.
GitDiff(DirectoryPath, ​string, ​string)​ Get changed files from certain commit id up to current.
GitFindRootFromPath(DirectoryPath)​ Finding git root path from subtree.
GitInit(DirectoryPath)​ Init using default options.
GitLabCI Gets a GitLabCIProvider instance that can be used to obtain information from the GitLab CI environment.
GitLink(DirectoryPath)​ Update pdb files to link all sources. This will allow anyone to step through the source code while debugging without a symbol source server.
GitLink(DirectoryPath, ​GitLinkSettings)​ Update pdb files to link all sources, using specified settings. This will allow anyone to step through the source code while debugging without a symbol source server.
GitLog(DirectoryPath, ​int)​ Get commit log.
GitLog(DirectoryPath, ​string)​ Get commit from certain commit id up to current.
GitLogLookup(DirectoryPath, ​string)​ Get specific commit.
GitLogTip(DirectoryPath)​ Get last commit
GitPackager(string, ​IDictionary<string,​ string>, ​string, ​string)​
GitPull(DirectoryPath, ​string, ​string)​ Pull unauthenticated using default options.
GitPull(DirectoryPath, ​string, ​string, ​string, ​string, ​string)​ Pull authenticating using default options.
GitPush(DirectoryPath)​ Push all branches unauthenticated.
GitPush(DirectoryPath, ​string, ​string)​ Push all branches authenticated.
GitPush(DirectoryPath, ​string, ​string, ​string)​ Push specific branch authenticated.
GitPushRef(DirectoryPath, ​string, ​string)​ Push a tag to a remote unauthenticated.
GitPushRef(DirectoryPath, ​string, ​string, ​string, ​string)​ Push a tag to a remote authenticated.
GitReleaseManagerAddAssets(string, ​string, ​string, ​string, ​string, ​string)​ Add Assets to an existing release.
GitReleaseManagerAddAssets(string, ​string, ​string, ​string, ​string, ​string, ​GitReleaseManagerAddAssetsSettings)​ Add Assets to an existing release using the specified settings.
GitReleaseManagerClose(string, ​string, ​string, ​string, ​string)​ Closes the milestone associated with a release.
GitReleaseManagerClose(string, ​string, ​string, ​string, ​string, ​GitReleaseManagerCloseMilestoneSettings)​ Closes the milestone associated with a release using the specified settings.
GitReleaseManagerCreate(string, ​string, ​string, ​string)​ Creates a Package Release.
GitReleaseManagerCreate(string, ​string, ​string, ​string, ​GitReleaseManagerCreateSettings)​ Creates a Package Release using the specified settings.
GitReleaseManagerExport(string, ​string, ​string, ​string, ​FilePath)​ Exports the release notes.
GitReleaseManagerExport(string, ​string, ​string, ​string, ​FilePath, ​GitReleaseManagerExportSettings)​ Exports the release notes using the specified settings.
GitReleaseManagerPublish(string, ​string, ​string, ​string, ​string)​ Publishes the release.
GitReleaseManagerPublish(string, ​string, ​string, ​string, ​string, ​GitReleaseManagerPublishSettings)​ Publishes the release using the specified settings.
GitReleaseNotes(FilePath, ​GitReleaseNotesSettings)​ Generates a set of release notes based on the commit history of the repository and specified settings.
GitRemove(DirectoryPath, ​bool, ​FilePath[])​ Remove file(s) from index.
GitReset(DirectoryPath, ​GitResetMode, ​string)​ Sets the current branch head (HEAD) to a specified commit, optionally modifying index and working tree to match.
GitReset(DirectoryPath, ​GitResetMode)​ Resets the current branch head (HEAD) optionally modifying index and working tree to match.
GitTag(DirectoryPath, ​string)​ Applys tagName to repository.
GitTag(DirectoryPath, ​string, ​string)​ Applys tagName to repository.
Gitter Gets a GitterProvider instance that can be used for communicating with GitterProvider API.
GitVersion()​ Retrives the GitVersion output.
GitVersion(GitVersionSettings)​ Retrives the GitVersion output.
GoCD Gets a GoCDProvider instance that can be used to obtain information from the Go.CD environment.
Gulp Allows access to the gulp task orchestrator for either the local or global installation
GZipCompress(DirectoryPath, ​FilePath)​ Create a GZip Tar archive of the specified directory.
GZipCompress(DirectoryPath, ​FilePath, ​int)​ Create a GZip Tar archive of the specified directory.
GZipCompress(DirectoryPath, ​FilePath, ​string)​ Create a GZip Tar archive of the files matching the specified pattern.
GZipCompress(DirectoryPath, ​FilePath, ​string, ​int)​ Create a GZip Tar archive of the files matching the specified pattern.
GZipCompress(DirectoryPath, ​FilePath, ​IEnumerable<FilePath>)​ Create a GZip Tar archive of the specified files.
GZipCompress(DirectoryPath, ​FilePath, ​IEnumerable<FilePath>, ​int)​ Create a GZip Tar archive of the specified files.
GZipCompress(DirectoryPath, ​FilePath, ​IEnumerable<string>)​ Create a GZip Tar archive of the specified files.
GZipCompress(DirectoryPath, ​FilePath, ​IEnumerable<string>, ​int)​ Create a GZip Tar archive of the specified files.
GZipUncompress(FilePath, ​DirectoryPath)​ Uncompress the specified GZip Tar file.
HasArgument(string)​ Determines whether or not the specified argument exist.
HasEnvironmentVariable(string)​ Checks for the existence of a value for a given environment variable.
ILMerge(FilePath, ​FilePath, ​IEnumerable<FilePath>)​ Merges the specified assemblies.
ILMerge(FilePath, ​FilePath, ​IEnumerable<FilePath>, ​ILMergeSettings)​ Merges the specified assemblies.
ILRepack(FilePath, ​FilePath, ​IEnumerable<FilePath>)​ Merges the specified assemblies.
ILRepack(FilePath, ​FilePath, ​IEnumerable<FilePath>, ​ILRepackSettings)​ Merges the specified assemblies.
Information(string, ​Object[])​ Writes an informational message to the log using the specified format information.
Information(LogAction)​ Writes an informational message to the log using the specified log message action. Evaluation message only if verbosity same or more verbose.
InnoSetup(FilePath)​ Compiles the given Inno Setup script using the default settings.
InnoSetup(FilePath, ​InnoSetupSettings)​ Compiles the given Inno Setup script using the given .
InspectCode(FilePath)​ Analyses the specified solution with Resharper's InspectCode.
InspectCode(FilePath, ​InspectCodeSettings)​ Analyses the specified solution with Resharper's InspectCode, using the specified settings.
InspectCodeFromConfig(FilePath)​ Runs ReSharper's InspectCode using the specified config file.
IsNuGetPublished(FilePath, ​string)​ Determines if a .nupkg is already published at the given NuGet package source.
IsNuGetPublished(string, ​string, ​string)​ Determines if a .nupkg is already published at the given NuGet package source.
IsNuGetPublished(string, ​SemanticVersion, ​string)​ Determines if a .nupkg is already published at the given NuGet package source.
IsRunningOnUnix()​ Determines whether the build script running on a Unix or Linux based system.
IsRunningOnWindows()​ Determines whether the build script is running on Windows.
Jenkins Gets a JenkinsProvider instance that can be used to obtain information from the Jenkins environment.
Kudu Gets a KuduProvider instance that can be used to query for information and manipulate the current Kudu environment
LaunchAppleSimulator(string)​
LaunchAppleSimulator(string, ​SimulatorSettings)​
ListAppleSimulatorDeviceTypes(SimCtlSettings)​
ListAppleSimulatorDeviceTypes()​
ListAppleSimulatorPairs(SimCtlSettings)​
ListAppleSimulatorPairs()​
ListAppleSimulatorRuntimes(SimCtlSettings)​
ListAppleSimulatorRuntimes()​
ListAppleSimulators(SimCtlSettings)​
ListAppleSimulators()​
ListGenymotionSimulators(GenymotionAdminSettings)​
LocalDbCreateInstance(string, ​LocalDbVersion)​ Creates a server instance and starts the server.
LocalDbCreateInstance(string)​ Creates a server instance and starts the server. The version number defaults to the version of the SqlLocalDB utility
LocalDbDeleteInstance(string)​ Deletes the LocalDB instance
LocalDbStartInstance(string)​ Starts the LocalDB instance. Instance must exist before you can start it.
LocalDbStopInstance(string)​ Stops the LocalDB instance.
MakeAbsolute(DirectoryPath)​ Makes the path absolute (if relative) using the current working directory.
MakeAbsolute(FilePath)​ Makes the path absolute (if relative) using the current working directory.
MakeNSIS(FilePath)​ Compiles the given NSIS script using the default settings.
MakeNSIS(FilePath, ​MakeNSISSettings)​ Compiles the given NSIS script using the given .
MDToolArchive(FilePath, ​string, ​Action<MDToolSettings>)​ Creates an archive of an app with MDTool
MDToolBuild(FilePath, ​Action<MDToolSettings>)​ Builds a project with MDTool
MDToolSetup Gets a runner for invoking the Xamarin Studio Add-in Setup Utility.
MoveDirectory(DirectoryPath, ​DirectoryPath)​ Moves an existing directory to a new location, providing the option to specify a new directory name.
MoveFile(FilePath, ​FilePath)​ Moves an existing file to a new location, providing the option to specify a new file name.
MoveFiles(string, ​DirectoryPath)​ Moves existing files matching the specified pattern to a new location.
MoveFiles(IEnumerable<FilePath>, ​DirectoryPath)​ Moves existing files to a new location.
MoveFileToDirectory(FilePath, ​DirectoryPath)​ Moves an existing file to a new location.
MSBuild(FilePath)​ Builds the specified solution using MSBuild.
MSBuild(FilePath, ​Action<MSBuildSettings>)​ Builds the specified solution using MSBuild.
MSBuild(FilePath, ​MSBuildSettings)​ Builds the specified solution using MSBuild.
MSBuildTaskExecute(ITask)​ Executes an MSBuild task
MsDeploy(MsDeploySettings)​ Executes an MsDeploy operation for the given source, destination (optional), and operation settings.
MSTest(string)​ Runs all MSTest unit tests in the assemblies matching the specified pattern.
MSTest(string, ​MSTestSettings)​ Runs all MSTest unit tests in the assemblies matching the specified pattern.
MSTest(IEnumerable<FilePath>)​ Runs all MSTest unit tests in the specified assemblies.
MSTest(IEnumerable<FilePath>, ​MSTestSettings)​ Runs all MSTest unit tests in the specified assemblies.
MyGet Gets a MyGetProvider instance that can be used to manipulate the MyGet environment.
Npm Get an Npm runner
NSwag Gets a runner to invoke NSwag operations
NuGetAddSource(string, ​string)​ Adds NuGet package source using the specified name &source to global user config
NuGetAddSource(string, ​string, ​NuGetSourcesSettings)​ Adds NuGet package source using the specified name, source & settings to global user config
NuGetHasSource(string)​ Checks whether or not a NuGet package source exists in the global user configuration, using the specified source.
NuGetHasSource(string, ​NuGetSourcesSettings)​ Checks whether or not a NuGet package source exists in the global user configuration, using the specified source and settings.
NuGetInstall(string)​ Installs a NuGet package.
NuGetInstall(IEnumerable<string>)​ Installs NuGet packages.
NuGetInstall(string, ​NuGetInstallSettings)​ Installs a NuGet package using the specified settings.
NuGetInstall(IEnumerable<string>, ​NuGetInstallSettings)​ Installs NuGet packages using the specified settings.
NuGetInstallFromConfig(FilePath)​ Installs NuGet packages using the specified package configuration.
NuGetInstallFromConfig(IEnumerable<FilePath>)​ Installs NuGet packages using the specified package configurations.
NuGetInstallFromConfig(FilePath, ​NuGetInstallSettings)​ Installs NuGet packages using the specified package configuration and settings.
NuGetInstallFromConfig(IEnumerable<FilePath>, ​NuGetInstallSettings)​ Installs NuGet packages using the specified package configurations and settings.
NuGetPack(FilePath, ​NuGetPackSettings)​ Creates a NuGet package using the specified Nuspec or project file.
NuGetPack(IEnumerable<FilePath>, ​NuGetPackSettings)​ Creates NuGet packages using the specified Nuspec or project files.
NuGetPack(NuGetPackSettings)​ Creates a NuGet package using the specified settings.
NuGetPush(FilePath, ​NuGetPushSettings)​ Pushes a NuGet package to a NuGet server and publishes it.
NuGetPush(IEnumerable<FilePath>, ​NuGetPushSettings)​ Pushes NuGet packages to a NuGet server and publishes them.
NuGetRemoveSource(string, ​string)​ Removes NuGet package source using the specified name & source from global user config
NuGetRemoveSource(string, ​string, ​NuGetSourcesSettings)​ Removes NuGet package source using the specified name, source & settings from global user config
NuGetRestore(FilePath)​ Restores NuGet packages for the specified target.
NuGetRestore(IEnumerable<FilePath>)​ Restores NuGet packages for the specified targets.
NuGetRestore(FilePath, ​NuGetRestoreSettings)​ Restores NuGet packages using the specified settings.
NuGetRestore(IEnumerable<FilePath>, ​NuGetRestoreSettings)​ Restores NuGet packages using the specified settings.
NuGetSetApiKey(string, ​string, ​NuGetSetApiKeySettings)​ Installs NuGet packages using the specified API key, source and settings.
NuGetSetApiKey(string, ​string)​ Installs NuGet packages using the specified API key and source.
NuGetSetProxy(string, ​string, ​string, ​NuGetSetProxySettings)​ Set the proxy settings to be used while connecting to your NuGet feed, including settings.
NuGetSetProxy(string, ​string, ​string)​ Set the proxy settings to be used while connecting to your NuGet feed.
NuGetUpdate(FilePath)​ Updates NuGet packages.
NuGetUpdate(IEnumerable<FilePath>)​ Updates NuGet packages.
NuGetUpdate(FilePath, ​NuGetUpdateSettings)​ Updates NuGet packages using the specified settings.
NuGetUpdate(IEnumerable<FilePath>, ​NuGetUpdateSettings)​ Updates NuGet packages using the specified settings.
NUnit(string)​ Runs all NUnit unit tests in the assemblies matching the specified pattern.
NUnit(string, ​NUnitSettings)​ Runs all NUnit unit tests in the assemblies matching the specified pattern, using the specified settings.
NUnit(IEnumerable<string>)​ Runs all NUnit unit tests in the specified assemblies.
NUnit(IEnumerable<FilePath>)​ Runs all NUnit unit tests in the specified assemblies.
NUnit(IEnumerable<string>, ​NUnitSettings)​ Runs all NUnit unit tests in the specified assemblies, using the specified settings.
NUnit(IEnumerable<FilePath>, ​NUnitSettings)​ Runs all NUnit unit tests in the specified assemblies, using the specified settings.
NUnit3(string)​ Runs all NUnit unit tests in the assemblies matching the specified pattern.
NUnit3(string, ​NUnit3Settings)​ Runs all NUnit unit tests in the assemblies matching the specified pattern, using the specified settings.
NUnit3(IEnumerable<string>)​ Runs all NUnit unit tests in the specified assemblies.
NUnit3(IEnumerable<FilePath>)​ Runs all NUnit unit tests in the specified assemblies.
NUnit3(IEnumerable<string>, ​NUnit3Settings)​ Runs all NUnit unit tests in the specified assemblies, using the specified settings.
NUnit3(IEnumerable<FilePath>, ​NUnit3Settings)​ Runs all NUnit unit tests in the specified assemblies, using the specified settings.
OctoCreateRelease(string, ​CreateReleaseSettings)​ Creates a release for the specified Octopus Deploy Project.
OctoDeployRelease(string, ​string, ​string, ​string, ​string, ​OctopusDeployReleaseDeploymentSettings)​ Deploys the specified already existing release into a specified environment See Octopus Documentation for more details.
OctoPack(string)​ Packs the specified folder into an Octopus Deploy package.
OctoPack(string, ​OctopusPackSettings)​ Packs the specified folder into an Octopus Deploy package.
OctoPush(string, ​string, ​FilePath, ​OctopusPushSettings)​ Pushes the specified package to the Octopus Deploy repository
OctoPush(string, ​string, ​IEnumerable<FilePath>, ​OctopusPushSettings)​ Pushes the specified packages to the Octopus Deploy repository
OpenCover(Action<ICakeContext>, ​FilePath, ​OpenCoverSettings)​ Runs OpenCover for the specified action and settings.
OpenSqlConnection(string)​ Opens a new System.Data.SqlClient.SqlConnection with the given connection string.
PackageComponent(DirectoryPath, ​XamarinComponentSettings)​ Packages the component for a given component YAML configuration file
PaketPack(DirectoryPath, ​PaketPackSettings)​ Creates NuGet package(s) in the output directory for the given settings.
PaketPack(DirectoryPath)​ Creates NuGet package(s) in the output directory.
PaketPush(FilePath, ​PaketPushSettings)​ Pushes NuGet package defined by the file path for the given settings.
PaketPush(IEnumerable<FilePath>, ​PaketPushSettings)​ Pushes NuGet packages defined by the file paths for the given settings.
PaketRestore(PaketRestoreSettings)​ Runs paket restore for the given settings.
PaketRestore()​ Runs paket restore for the given settings.
ParseAllReleaseNotes(FilePath)​ Parses all release notes.
ParseAssemblyInfo(FilePath)​ Parses an existing assembly information file.
ParseJson(string)​ Parses the JSON into a JObject.
ParseJsonFromFile(FilePath)​ Parses the file contents into a JObject.
ParseProject(FilePath)​ Parses project information from project file
ParseReleaseNotes(FilePath)​ Parses the latest release notes.
ParseSemVer(string)​ Parse a semantic version from a string
ParseSemVer(string, ​bool)​ Parse a semantic version from a string
ParseSolution(FilePath)​ Parses project information from a solution file.
ParseXmlDocExampleCode(FilePath)​ Parses Xml documentation example code from given path.
ParseXmlDocFilesExampleCode(string)​ Parses Xml documentation example code from file(s) using given pattern.
Plink(string, ​string)​ Invokes Plink without settings
Plink(string, ​string, ​PlinkSettings)​ Invokes Plink using given .
Pscp(string, ​string, ​PscpSettings)​ Invokes Pscp with a single from argument and .
Pscp(string, ​string)​ Invokes Pscp with a single from argument.
Pscp(String[], ​string)​ Invokes Pscp with array of from arguments without settings..
Pscp(String[], ​string, ​PscpSettings)​ Invokes Pscp with array of from arguments.
PublishNuGets(string, ​string, ​PublishNuGetsSettings, ​String[])​ Looks for and attempts to publish NuGet packages matching the globbing patterns
PublishNuGets(string, ​string, ​string, ​PublishNuGetsSettings, ​String[])​ Looks for and attempts to publish NuGet packages matching the globbing patterns
RegisterGenymotionLicense(string, ​GenymotionLicenseSettings)​
ReplaceRegexInFiles(string, ​string, ​string)​ Replaces the regex pattern in files matched by the given globber pattern.
ReplaceRegexInFiles(string, ​string, ​string, ​RegexOptions)​ Replaces the regex pattern in files matched by the given globber pattern.
ReplaceTextInFiles(string, ​string, ​string)​ Replaces the text in files matched by the given globber pattern
ReportGenerator(string, ​DirectoryPath)​ Converts the coverage report specified by the glob pattern into human readable form.
ReportGenerator(string, ​DirectoryPath, ​ReportGeneratorSettings)​ Converts the coverage report specified by the glob pattern into human readable form using the specified settings.
ReportGenerator(FilePath, ​DirectoryPath)​ Converts the specified coverage report into human readable form.
ReportGenerator(FilePath, ​DirectoryPath, ​ReportGeneratorSettings)​ Converts the specified coverage report into human readable form using the specified settings.
ReportGenerator(IEnumerable<FilePath>, ​DirectoryPath)​ Converts the specified coverage reports into human readable form.
ReportGenerator(IEnumerable<FilePath>, ​DirectoryPath, ​ReportGeneratorSettings)​ Converts the specified coverage reports into human readable form using the specified settings.
ReportUnit(DirectoryPath)​ Converts the reports in the specified directory into human readable form.
ReportUnit(DirectoryPath, ​ReportUnitSettings)​ Converts the reports in the specified directory into human readable form.
ReportUnit(DirectoryPath, ​DirectoryPath, ​ReportUnitSettings)​ Converts the reports in the specified directory into human readable form and outputs to specified folder.
ReportUnit(FilePath, ​FilePath)​ Converts the single specified report into human readable form and outputs to specified file.
ReportUnit(FilePath, ​FilePath, ​ReportUnitSettings)​ Converts the single specified report into human readable form and outputs to specified file.
ResetAllGenymotionSimulators(GenymotionAdminSettings)​
ResetGenymotionSimulator(string, ​GenymotionAdminSettings)​
ReSharperReports(FilePath, ​FilePath)​ Runs ReSharperReports against the specified input FilePath, and outputs to specified output FilePath
ReSharperReports(FilePath, ​FilePath, ​ReSharperReportsSettings)​ Runs ReSharperReports against the specified input FilePath, and outputs to specified output FilePath with the specified ReSharperReportsSettings
RestoreComponents(FilePath, ​XamarinComponentRestoreSettings)​ Restores Xamarin Components for a given project
RestoreSqlBackup(string, ​FilePath, ​RestoreSqlBackupSettings)​ Restores a database from a backup file.
RestoreSqlBackup(string, ​FilePath)​ Restores a database from a backup file.
RoundhouseDrop(RoundhouseSettings)​ Executes Roundhouse migration to drop the database using the provided settings.
RoundhouseMigrate(RoundhouseSettings)​ Executes Roundhouse with the given configured settings.
RunCollection(FilePath)​ Executes Newman against the given collection file, using all defaults.
RunCollection(FilePath, ​NewmanSettings)​ Executes Newman against the given collection file, using all defaults.
RunCollection(FilePath, ​Action<NewmanSettings>)​ Executes Newman against the given collection file, using all defaults.
SemVerMagnitude(FilePath, ​FilePath)​ Get the magnitude by running SemVer.FromAssembly.
SemVerMagnitude(FilePath, ​FilePath, ​FilePath)​ Get the magnitude by running SemVer.FromAssembly.
SendGrid Gets a SendGridProvider instance that can be used for communicating with SendGridProvider API.
SendMessage(string, ​string, ​string, ​string)​ Send a HipChat message using the HipChat.Net NuGet Package
SerializeAppManifest(FilePath, ​AndroidAppManifest)​
SerializeJson(T)​ Serializes an object to a JSON string.
SerializeJsonToFile(FilePath, ​T)​ Serializes an object to a JSON file.
SerializePlist(FilePath, ​object)​ Serializes a plist into spezified file.
SerializePlistXml(object)​ Serializes plist as xml
SerializeYaml(T)​ Serializes an object to a YAML string.
SerializeYamlToFile(FilePath, ​T)​ Serializes an object to a YAML file.
SetSqlCommandTimeout(int)​ Sets the CommandTimeout property for all SqlCommands used internally
ShutdownAllAppleSimulators(SimCtlSettings)​
ShutdownAllAppleSimulators()​
Sign(string, ​SignToolSignSettings)​ Signs the specified assembly.
Sign(FilePath, ​SignToolSignSettings)​ Signs the specified assembly.
Sign(IEnumerable<string>, ​SignToolSignSettings)​ Signs the specified assemblies.
Sign(IEnumerable<FilePath>, ​SignToolSignSettings)​ Signs the specified assemblies.
Slack Gets a SlackProvider instance that can be used for communicating with Slack API.
Sonar(Action<ICakeContext>, ​SonarBeginSettings)​ Run a self-contained analysis for the specified action. The action should run msbuild.
SonarBegin(SonarBeginSettings)​ Initialise msbuild for sonar analysis.
SonarEnd(SonarEndSettings)​ Run the actual sonar analysis and push them to sonar. This call should follow after a SonarBegin and MSBuild.
SonarEnd()​ Run the actual sonar analysis (no credentials given).
SpecFlowStepDefinitionReport(FilePath)​ Creates a report that shows the usage and binding status of the steps for the entire project. You can use this report to find both unused code in the automation layer and scenario steps that have no definition yet. See SpecFlow Documentation for more information.
SpecFlowStepDefinitionReport(FilePath, ​SpecFlowStepDefinitionReportSettings)​ Creates a report that shows the usage and binding status of the steps for the entire project. You can use this report to find both unused code in the automation layer and scenario steps that have no definition yet. See SpecFlow Documentation for more information.
SpecFlowTestExecutionReport(Action<ICakeContext>, ​FilePath)​ Creates a formatted HTML report of a test execution. The report contains a summary about the executed tests and the result and also a detailed report for the individual scenario executions. See SpecFlow Documentation for more information.
SpecFlowTestExecutionReport(Action<ICakeContext>, ​FilePath, ​SpecFlowTestExecutionReportSettings)​ Creates a formatted HTML report of a test execution. The report contains a summary about the executed tests and the result and also a detailed report for the individual scenario executions. See SpecFlow Documentation for more information.
SqlServerPackager(SqlServerPackagerSettings)​ Merge multiple SQL scripts into one SQL script.
Squirrel(FilePath)​
Squirrel(FilePath, ​SquirrelSettings)​
Squirrel(FilePath, ​SquirrelSettings, ​bool, ​bool)​
StartAndReturnProcess(FilePath, ​ProcessSettings)​ Starts the process resource that is specified by the filename and settings.
StartAndReturnProcess(FilePath)​ Starts the process resource that is specified by the filename.
StartGenymotionSimulator(string, ​GenymotionAdminSettings)​
StartProcess(FilePath)​ Starts the process resource that is specified by the filename.
StartProcess(FilePath, ​string)​ Starts the process resource that is specified by the filename and arguments
StartProcess(FilePath, ​ProcessSettings)​ Starts the process resource that is specified by the filename and settings.
StartProcess(FilePath, ​ProcessSettings, ​out IEnumerable)​
StopAllGenymotionSimulators(GenymotionAdminSettings)​
StopGenymotionSimulator(string, ​GenymotionAdminSettings)​
StrongNameReSign(string, ​StrongNameToolSettings)​ Uses sn.exe to resign the specified assembly.
StrongNameReSign(FilePath, ​StrongNameToolSettings)​ Uses sn.exe to resign the specified assembly.
StrongNameReSign(IEnumerable<string>, ​StrongNameToolSettings)​ Uses sn.exe to resign the specified assemblies.
StrongNameReSign(IEnumerable<FilePath>, ​StrongNameToolSettings)​ Uses sn.exe to resign the specified assemblies.
StrongNameVerify(string, ​StrongNameToolSettings)​ Verify assembly for strong name signature self consistency.
StrongNameVerify(FilePath, ​StrongNameToolSettings)​ Verify assembly for strong name signature self consistency.
StrongNameVerify(IEnumerable<string>, ​StrongNameToolSettings)​ Verify assembly for strong name signature self consistency.
StrongNameVerify(IEnumerable<FilePath>, ​StrongNameToolSettings)​ Verify assembly for strong name signature self consistency.
StyleCopAnalyse(SettingsDelegate)​ Analyses the project using stylecop.
StyleCopReport(ReportSettingsDelegate)​ Generates summary report from a stylecop execution.
SubmitComponent(FilePath, ​XamarinComponentSubmitSettings)​ Submits a .xam component package which is a brand new component on the store and has no previous versions
SubmitComponents(XamarinComponentSubmitSettings, ​String[])​ Finds and Submits .xam component packages which match the globbing patterns
TeamCity Gets a TeamCityProvider instance that can be used to manipulate the TeamCity environment.
TestCloud(FilePath, ​string, ​string, ​string, ​DirectoryPath, ​TestCloudSettings)​ Uploads an android .APK package to TestCloud and runs UITests
TFBuild Gets a TFBuildProvider instance that can be used to obtain information from the Team Foundation Build environment.
TfxExtensionCreate(TfxExtensionCreateSettings)​ Creates an extension using the Tfx CLI using the specified settings.
TfxExtensionInstall(FilePath, ​ICollection<string>, ​TfxExtensionInstallSettings)​ Installs an extension using the Tfx CLI using the specified settings.
TfxExtensionPublish(TfxExtensionPublishSettings)​ Publishes an extension using the Tfx CLI using the specified settings.
TfxExtensionPublish(FilePath, ​TfxExtensionPublishSettings)​ Publishes an extension using the Tfx CLI using the specified settings.
TfxExtensionShare(FilePath, ​ICollection<string>, ​TfxExtensionShareSettings)​ Shares an extension using the Tfx CLI using the specified settings.
TransformConfig(string, ​TransformationCollection)​
TransformConfig(string, ​string, ​TransformationCollection)​
TransformConfig(string, ​string, ​string, ​TransformationCollection)​
TransformTemplate(FilePath)​ Transform a text template.
TransformTemplate(FilePath, ​TextTransformSettings)​ Transform a text template.
TransformText(string)​ Creates a text transformation from the provided template.
TransformText(string, ​string, ​string)​ Creates a text transformation from the provided template, using the specified placeholder.
TransformTextFile(FilePath)​ Creates a text transformation from the provided template on disc.
TransformTextFile(FilePath, ​string, ​string)​ Creates a text transformation from the provided template on disc, using the specified placeholder.
TravisCI Gets a TravisCIProvider instance that can be used to obtain information from the Travis CI environment.
TwitterSendTweet(string, ​string, ​string, ​string, ​string)​ Send a Tweet using the Twitter REST API.
UITest(FilePath, ​NUnitSettings)​ Runs UITests in a given assembly using NUnit
Unzip(FilePath, ​DirectoryPath)​ Unzips the specified file
UploadComponent(FilePath, ​XamarinComponentUploadSettings)​ Uploads a .xam component package which is a new version of an existing component in the store
UploadComponents(XamarinComponentUploadSettings, ​String[])​ Finds and Uploads .xam component packages which match the globbing patterns
UploadFile(Uri, ​FilePath)​ Uploads the specified file via a HTTP POST to the specified uri using multipart/form-data.
UploadFile(string, ​FilePath)​ Uploads the specified file via a HTTP POST to the specified uri using multipart/form-data.
UploadFile(Uri, ​Byte[], ​string)​ Uploads the specified byte array via a HTTP POST to the specified uri using multipart/form-data.
UploadFile(string, ​Byte[], ​string)​ Uploads the specified byte array via a HTTP POST to the specified uri using multipart/form-data.
UploadFileToBlob(AzureStorageSettings, ​FilePath)​ Uploads a file to Azure Blob Storage.
UploadSymbolsToRaygun(FilePath, ​RaygunSymbolSettings)​
UploadToHockeyApp(FilePath, ​HockeyAppUploadSettings, ​FilePath)​
UploadToHockeyApp(FilePath, ​HockeyAppUploadSettings)​ Uploads the specified package to HockeyApp. If you don't upload an apk or ipa, it is required to specify the AppId and the Version property of HockeyAppUploadSettings.
UploadToHockeyApp(FilePath)​ Uploads the specified package and symbols file to HockeyApp. The version is automatically detected from the package metadata. This only works with *.ipa for iOS, *.app.zip for OS X, or *.apk files for Android.
UploadToHockeyApp(FilePath, ​FilePath)​ Uploads the specified package and symbols file to HockeyApp. The version is automatically detected from the package metadata. This only works with *.ipa for iOS, *.app.zip for OS X, or *.apk files for Android.
UploadToHockeyApp(FilePath, ​FilePath, ​HockeyAppUploadSettings)​ Uploads the specified package to HockeyApp. Currently it is required to specify the AppId and the Version property of HockeyAppUploadSettings
Vagrant Gets a runner to control Vagrant through the CLI
ValidateOrchardFiles(FilePathCollection)​
Verbose(string, ​Object[])​ Writes a verbose message to the log using the specified format information.
Verbose(LogAction)​ Writes a verbose message to the log using the specified log message action. Evaluation message only if verbosity same or more verbose.
VscePackage()​ Packages a VsCode Extension.
VscePackage(VscePackageSettings)​ Packages a VsCode Extension using the specified settings.
VscePublish()​ Publishes a VsCode Extension.
VscePublish(VscePublishSettings)​ Publishes a VsCode Extension using the specified settings.
VSTest(string)​ Runs all VSTest unit tests in the assemblies matching the specified pattern.
VSTest(string, ​VSTestSettings)​ Runs all VSTest unit tests in the assemblies matching the specified pattern.
VSTest(IEnumerable<FilePath>)​ Runs all VSTest unit tests in the specified assemblies.
VSTest(IEnumerable<FilePath>, ​VSTestSettings)​ Runs all VSTest unit tests in the specified assemblies.
Warning(string, ​Object[])​ Writes a warning message to the log using the specified format information.
Warning(LogAction)​ Writes a warning message to the log using the specified log message action. Evaluation message only if verbosity same or more verbose.
Watch(string, ​Action<IEnumerable<FileChange>>)​ Watch files in current directory.
Watch(WatchSettings, ​Action<IEnumerable<FileChange>>)​ Watch files that is specified by settings.
Webpack Webpack alias
WinScpSync(string, ​string, ​string, ​bool)​ Synchronizes directories using WinSCP.
WiXCandle(string, ​CandleSettings)​ Compiles all .wxs sources matching the specified pattern.
WiXCandle(IEnumerable<FilePath>, ​CandleSettings)​ Compiles all .wxs sources in the provided source files.
WiXHeat(DirectoryPath, ​FilePath, ​WiXHarvestType)​ Harvests files in the provided object files.
WiXHeat(DirectoryPath, ​FilePath, ​WiXHarvestType, ​HeatSettings)​ Harvests files in the provided directory path.
WiXHeat(IEnumerable<FilePath>, ​FilePath, ​WiXHarvestType)​ Harvests from the desired files.
WiXHeat(IEnumerable<FilePath>, ​FilePath, ​WiXHarvestType, ​HeatSettings)​ Harvests from the desired files.
WiXHeat(string, ​FilePath, ​WiXHarvestType)​ Harvests files for a website or performance.
WiXHeat(string, ​FilePath, ​WiXHarvestType, ​HeatSettings)​ Harvests files for a website or performance.
WiXLight(string, ​LightSettings)​ Links all .wixobj files matching the specified pattern.
WiXLight(IEnumerable<FilePath>, ​LightSettings)​ Links all .wixobj files in the provided object files.
Wyam()​ Runs Wyam using the specified settings.
Wyam(WyamSettings)​ Runs Wyam using the specified settings.
XBuild(FilePath)​ Builds the specified solution using XBuild.
XBuild(FilePath, ​Action<XBuildSettings>)​ Builds the specified solution using XBuild.
XBuild(FilePath, ​XBuildSettings)​ Builds the specified solution using XBuild.
XCodeBuild(XCodeBuildSettings)​ Runs xcodebuild with the given settings.
XCodeSdks()​ Gets the various SDK's installed and available on the machine
XCodeSdks(XCodeSettings)​ Gets the various SDK's installed and available on the machine
XdtTransformConfig(FilePath, ​FilePath, ​FilePath)​
XmlPeek(FilePath, ​string)​ Gets the value of a target node.
XmlPeek(FilePath, ​string, ​XmlPeekSettings)​ Get the value of a target node.
XmlPoke(FilePath, ​string, ​string)​ Set the value of, or remove, target nodes.
XmlPoke(FilePath, ​string, ​string, ​XmlPokeSettings)​ Set the value of, or remove, target nodes.
XmlPokeString(string, ​string, ​string)​ Set the value of, or remove, target nodes.
XmlPokeString(string, ​string, ​string, ​XmlPokeSettings)​ Set the value of, or remove, target nodes.
XmlTransform(string, ​string)​ Performs XML XSL transformation
XmlTransform(string, ​string, ​XmlTransformationSettings)​ Performs XML XSL transformation
XmlTransform(FilePath, ​FilePath, ​FilePath)​ Performs XML XSL transformation
XmlTransform(FilePath, ​FilePath, ​FilePath, ​XmlTransformationSettings)​ Performs XML XSL transformation
XUnit(string)​ Runs all xUnit.net tests in the assemblies matching the specified pattern.
XUnit(string, ​XUnitSettings)​ Runs all xUnit.net tests in the assemblies matching the specified pattern.
XUnit(IEnumerable<string>)​ Runs all xUnit.net tests in the specified assemblies.
XUnit(IEnumerable<FilePath>)​ Runs all xUnit.net tests in the specified assemblies.
XUnit(IEnumerable<string>, ​XUnitSettings)​ Runs all xUnit.net tests in the specified assemblies.
XUnit(IEnumerable<FilePath>, ​XUnitSettings)​ Runs all xUnit.net tests in the specified assemblies.
XUnit2(string)​ Runs all xUnit.net v2 tests in the assemblies matching the specified pattern.
XUnit2(string, ​XUnit2Settings)​ Runs all xUnit.net v2 tests in the assemblies matching the specified pattern.
XUnit2(IEnumerable<string>)​ Runs all xUnit.net v2 tests in the specified assemblies.
XUnit2(IEnumerable<FilePath>)​ Runs all xUnit.net tests in the specified assemblies.
XUnit2(IEnumerable<string>, ​XUnit2Settings)​ Runs all xUnit.net v2 tests in the specified assemblies.
XUnit2(IEnumerable<FilePath>, ​XUnit2Settings)​ Runs all xUnit.net v2 tests in the specified assemblies.
Yarn Get an Yarn runner
Zip(DirectoryPath, ​FilePath)​ Zips the specified directory.
Zip(DirectoryPath, ​FilePath, ​string)​ Zips the files matching the specified pattern.
Zip(DirectoryPath, ​FilePath, ​IEnumerable<FilePath>)​ Zips the specified files.
Zip(DirectoryPath, ​FilePath, ​IEnumerable<string>)​ Zips the specified files.
ZipCompress(DirectoryPath, ​FilePath)​ Create a Zip archive of the specified directory.
ZipCompress(DirectoryPath, ​FilePath, ​int)​ Create a Zip archive of the specified directory.
ZipCompress(DirectoryPath, ​FilePath, ​string)​ Create a Zip archive of the files matching the specified pattern.
ZipCompress(DirectoryPath, ​FilePath, ​string, ​int)​ Create a Zip archive of the files matching the specified pattern.
ZipCompress(DirectoryPath, ​FilePath, ​IEnumerable<FilePath>)​ Create a Zip archive of the specified files.
ZipCompress(DirectoryPath, ​FilePath, ​IEnumerable<FilePath>, ​int)​ Create a Zip archive of the specified files.
ZipCompress(DirectoryPath, ​FilePath, ​IEnumerable<string>)​ Create a Zip archive of the specified files.
ZipCompress(DirectoryPath, ​FilePath, ​IEnumerable<string>, ​int)​ Create a Zip archive of the specified files.
ZipUncompress(FilePath, ​DirectoryPath)​ Uncompress the specified Zip Tar file.