Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

Options

dotnet cli command execution options

Record Fields

Record FieldDescription
CustomParams
Signature: string option

Custom parameters
Diagnostics
Signature: bool

Restore logging verbosity (--diagnostics)
DotNetCliPath
Signature: string

DotNet cli executable path
Environment
Signature: 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.
PrintRedirectedOutput
Signature: 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.
RedirectOutput
Signature: bool

If true the function will redirect the output of the called process (but will disable colors, false by default)
Verbosity
Signature: Verbosity option

Logging verbosity (--verbosity)
Version
Signature: string option

Write a global.json with the given version (required to make SDK choose the correct version)
WorkingDirectory
Signature: string

Command working directory

Instance members

Instance memberDescription
x.WithCommon(f)
Signature: (f:(Options -> '?14660)) -> '?14660
Type parameters: '?14660

Changes the "Common" properties according to the given function
x.WithEnvironment(map)
Signature: map:Map<string,string> -> Options

Sets the current environment variables.
x.WithPrintRedirectedOutput(shouldPrint)
Signature: shouldPrint:bool -> Options

Sets a value indicating whether the redirected output should be printed to standard-output/error stream.
x.WithRedirectOutput(shouldRedirect)
Signature: shouldRedirect:bool -> Options

Sets a value indicating whether the output for the given process is redirected.

Static members

Static memberDescription
Options.Create()
Signature: unit -> 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")
Options.Default
Signature: Options
Attributes:
[<Obsolete("Use Options.Create instead")>]
OBSOLETE

Use Options.Create instead