Summary

Represents arguments passed to the executing script.

Namespace

Implementing Types

graph BT Type["ICakeArguments"] class Type type-node Implementing0["CakeArguments"]-.->Type click Implementing0 "/api/Cake.Core/CakeArguments"

Syntax

public interface ICakeArguments

Name	Value	Summary
GetArguments()	IDictionary<string, ICollection<string>>	Gets all command line arguments.
GetArguments(string)	ICollection<string>	Gets all values for an argument.
HasArgument(string)	bool	Determines whether or not the specified argument exist.

Name	Value	Summary
Dump<ICakeArguments>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
GetArgument(string)	string	Gets the value for an argument. From CakeArgumentsExtensions
IsIn<ICakeArguments>(ICakeArguments[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<ICakeArguments>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<ICakeArguments>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<ICakeArguments>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<ICakeArguments>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin