Default Configuration Values

Configuration is currently not supported for Cake Frosting.

The following shows all of the configuration options currently available in Cake .NET Tool, Cake runner for .NET Framework and Cake runner for .NET Core, as well as their default values.

Refer to set configuration values for instructions on using a config file.

Addin NuGet Dependencies

Available since Cake 0.22.0.

When using In-Process NuGet installation you can also opt in to automatically installing and referencing NuGet package dependencies.

Default value: false

Valid values: true, false

CAKE_NUGET_LOADDEPENDENCIES

[NuGet]
LoadDependencies=true

--nuget_loaddependencies=true

Addins Path

This allows the configuration of the addins folder which is used by Cake when restoring addins.

Default value: ./tools/Addins

CAKE_PATHS_ADDINS

[Paths]
Addins=./tools/Addins

--paths_addins=./tools/Addins

In-Process NuGet installation

Available since Cake 0.25.0.

Since Cake 0.25.0 the default is to use the In-Process NuGet Client. If you require to use NuGet.exe instead, you can opt-out by setting this value to false.

Default value: true

Valid values: true, false

CAKE_NUGET_USEINPROCESSCLIENT

[NuGet]
UseInProcessClient=false

--nuget_useinprocessclient=false

Modules Path

This allows the configuration of the Modules folder which is used by Cake when loading custom Modules.

Default value: ./tools/Modules

CAKE_PATHS_MODULES

[Paths]
Modules=./tools/Modules

--paths_modules=./tools/Modules

NuGet Configuration File Path

This allows the configuration of the path to NuGet config file for overriding the default file.

Default value: If NuGet config not specified, will use NuGet default mechanism for resolving it.

CAKE_NUGET_CONFIGFILE

[NuGet]
ConfigFile=./NuGet.config

--nuget_configfile=./NuGet.config

NuGet Download Url

This allows the control of where Cake downloads NuGet packages from when using the addin and tool preprocessor directives. This can be useful when it is necessary to work in an offline mode, where direct access to nuget.org is not available.

Multiple sources can be passed separated by a semicolon.

Default value: https://packages.nuget.org/api/v2

CAKE_NUGET_SOURCE

With a single source:

[Nuget]
Source=http://myfeed/nuget/

With multiple sources:

[Nuget]
Source=http://myfeed/nuget/;http://myotherfeed/nuget

With a single source:

--nuget_source=http://myfeed/nuget/

With multiple sources:

--nuget_source=http://myfeed/nuget/;http://myotherfeed/nuget

Show Process Command Line

When Cake runs a tool the default behavior is to log the file name and the arguments only when the Diagnostic log verbosity is used. This setting will instruct Cake to always log the file name and arguments regardless of the log verbosity setting.

Default value: false

Valid values: true, false

CAKE_SETTINGS_SHOWPROCESSCOMMANDLINE

[Settings]
ShowProcessCommandLine=true

--settings_showprocesscommandline=true

Skip Verification

If any breaking changes are introduced to Cake, we'll set the minimum supported version of the Cake.Core assembly. Any addin/assembly that references an older version of Cake.Core will generate an exception and ultimately abort the execution of the script. This is to avoid runtime errors during execution of the script.

But if you really need to use an addin/assembly and have verified that the breaking change introduced doesn't concern the addin/assembly directly, i.e. it doesn't use a removed property or changed interface, for this scenario we'll allow you to temporarily opt-out of the assembly verification until addin/assembly author has released a version of the assembly targeting the minimum required version of Cake.Core.

This setting is global for all addins/assemblies your script references and should therefore be considered a temporary quick fix.

Default value: false

Valid values: true, false

CAKE_SETTINGS_SKIPVERIFICATION

[Settings]
SkipVerification=true

--settings_skipverification=true

Tools Path

This allows the configuration of the tools folder which is used by Cake when restoring tools.

Default value: ./tools

CAKE_PATHS_TOOLS

[Paths]
Tools=./tools

--paths_tools=./tools

Disable Colors in output text

Available since Cake 1.1.0.

By default, Cake outputs colored text when it detects it is running on an environment that supports ANSI escape codes.

To disable output of colored text, set an environment variable with the name NO_COLOR with any value.

NO_COLOR