CommandRunner Class

Summary

The generic command runner.
Namespace
Cake.Common.Tools.Command
Base Types
graph BT Type-->Base0["Tool<CommandSettings>"] Base0-->Base1["object"] Type["CommandRunner"] class Type type-node

Syntax

public sealed class CommandRunner : Tool<CommandSettings>

Constructors

Name Summary
CommandRunner(CommandSettings, IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator) Initializes a new instance of the CommandRunner class.

Methods

Name Value Summary
GetToolExecutableNames() IEnumerable<string>
Gets the possible names of the tool executable.
GetToolName() string
Gets the name of the tool.
RunCommand(ProcessArgumentBuilder, string, string) int
Runs the command using the specified settings.
RunCommand(ProcessArgumentBuilder, string) int
Runs the command using the specified settings.
RunCommand(ProcessArgumentBuilder) void
Runs the command using the specified settings.

Extension Methods

Name Value Summary
Dump<CommandRunner>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<CommandRunner>(CommandRunner[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<CommandRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<CommandRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<CommandRunner>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<CommandRunner>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
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