TfxAliases Class

Summary

Contains functionality related to the TFS Cross Platform Command Line Interface.

In order to use the commands for this addin, the tfx-cli utility will need to be installed and available, or you will need to provide a ToolPath to where it can be located, and also you will need to include the following in your build.cake file to download and reference the addin from NuGet.org: 

#addin Cake.Tfx

Assembly
Cake.Tfx.dll
Namespace
Cake.Tfx
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["TfxAliases"] class Type type-node

Syntax

public static class TfxAliases

Attributes

Type Description
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute
CakeNamespaceImportAttribute
CakeNamespaceImportAttribute
CakeNamespaceImportAttribute

Methods

Name Value Summary
TfxExtensionCreate(ICakeContext, TfxExtensionCreateSettings) void
Creates an extension using the Tfx CLI using the specified settings.
static
TfxExtensionInstall(ICakeContext, FilePath, ICollection<string>, TfxExtensionInstallSettings) void
Installs an extension using the Tfx CLI using the specified settings.
static
TfxExtensionPublish(ICakeContext, FilePath, TfxExtensionPublishSettings) void
Publishes an extension using the Tfx CLI using the specified settings.
static
TfxExtensionPublish(ICakeContext, TfxExtensionPublishSettings) void
Publishes an extension using the Tfx CLI using the specified settings.
static
TfxExtensionShare(ICakeContext, FilePath, ICollection<string>, TfxExtensionShareSettings) void
Shares an extension using the Tfx CLI using the specified settings.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin