Options (Fake)

6.1.3

Lookig for older versions of the documentation, pre FAKE v6? See

DotNet.Options Type

Namespace: Fake.DotNet
Assembly: Fake.DotNet.Cli.dll
Parent Module: DotNet
Base Type: obj
All Interfaces: IEquatable<Options> , IStructuralEquatable , IComparable<Options> , IComparable , IStructuralComparable

dotnet cli command execution options

Record fields

Record Field	Description
`CustomParams` Full Usage: `CustomParams` Field type: `string option`	Custom parameters Field type: `string option`
`Diagnostics` Full Usage: `Diagnostics` Field type: `bool`	Restore logging verbosity (--diagnostics) Field type: `bool`
`DotNetCliPath` Full Usage: `DotNetCliPath` Field type: `string`	DotNet cli executable path Field type: `string`
`Environment` Full Usage: `Environment` Field type: `Map<string, string>`	Gets the environment variables that apply to this process and its child processes. NOTE: Recommendation is to not use this Field, but instead use the helper function in the Proc module (for example Process.setEnvironmentVariable) NOTE: This field is ignored when UseShellExecute is true. Field type: `Map<string, string>`
`PrintRedirectedOutput` Full Usage: `PrintRedirectedOutput` Field type: `bool`	If RedirectOutput is true this flag decides if FAKE emits the output into the standard output/error otherwise the flag is ignored. True by default. Field type: `bool`
`RedirectOutput` Full Usage: `RedirectOutput` Field type: `bool`	If true the function will redirect the output of the called process (but will disable colors, false by default) Field type: `bool`
`Timeout` Full Usage: `Timeout` Field type: `TimeSpan option`	Process timeout, kills the process after the specified time Field type: `TimeSpan option`
`Verbosity` Full Usage: `Verbosity` Field type: `Verbosity option`	Logging verbosity (--verbosity) Field type: `Verbosity option`
`Version` Full Usage: `Version` Field type: `string option`	Write a global.json with the given version (required to make SDK choose the correct version) Field type: `string option`
`WorkingDirectory` Full Usage: `WorkingDirectory` Field type: `string`	Command working directory Field type: `string`

Instance members

Instance member	Description
`this.WithCommon` Full Usage: `this.WithCommon` Parameters: f : `Options -> 'a` Returns: `'a` Modifiers: inline	Changes the "Common" properties according to the given function f : `Options -> 'a` Returns: `'a`
`this.WithEnvironment` Full Usage: `this.WithEnvironment` Parameters: map : `Map<string, string>` Returns: `Options`	Sets the current environment variables. map : `Map<string, string>` Returns: `Options`
`this.WithPrintRedirectedOutput` Full Usage: `this.WithPrintRedirectedOutput` Parameters: shouldPrint : `bool` Returns: `Options`	Sets a value indicating whether the redirected output should be printed to standard-output/error stream. shouldPrint : `bool` Returns: `Options`
`this.WithRedirectOutput` Full Usage: `this.WithRedirectOutput` Parameters: shouldRedirect : `bool` Returns: `Options`	Sets a value indicating whether the output for the given process is redirected. shouldRedirect : `bool` Returns: `Options`

Static members

Static member	Description
`Options.Create()` Full Usage: `Options.Create()` Returns: `Options`	Create a default setup for executing the `dotnet` command line. This function tries to take current `global.json` into account and tries to find the correct installation. To overwrite this behavior set `DotNetCliPath` manually (for example to the first result of `ProcessUtils.findFilesOnPath "dotnet"`) Returns: `Options`