Execute dotnet build command

setParams : BuildOptions -> BuildOptions

set compile command parameters

project : string

project to compile

.NET Core SDK default install directory (set to default SDK installer paths (/usr/local/share/dotnet or C:\Program Files\dotnet))

Returns: string

.NET Core SDK default install directory (set to default SDK installer paths (%HOME/.dotnet or %LOCALAPPDATA%/Microsoft/dotnet).

Returns: string

Download .NET Core SDK installer

setParams : InstallerOptions -> InstallerOptions

set download installer options

Returns: string

Execute raw dotnet cli command

buildOptions : Options -> Options

build common execution options

command : string

the sdk command to execute test, new, build, ...

args : string

command arguments

Returns: ProcessResult

Get dotnet cli executable path. Probes the provided path first, then as a fallback tries the system PATH

dotnetCliDir : string option

the path to check else will probe system PATH

Returns: seq<string>

Gets the DotNet SDK from the global.json. This file can exist in the working directory or any of the parent directories

() : unit

Returns: string

Execute dotnet --version command

setParams : VersionOptions -> VersionOptions

set version command parameters

Returns: string

Execute dotnet --info command

setParams : InfoOptions -> InfoOptions

set info command parameters

Returns: InfoResult

Install .NET Core SDK if required

setParams : CliInstallOptions -> CliInstallOptions

set installation options

Returns: Options -> Options

Execute dotnet new --install <PATH|NUGET_ID> command to install a new template

templateName : string

template short name to install

setParams : TemplateInstallOptions -> TemplateInstallOptions

set version command parameters

Runs a MSBuild project

setParams : MSBuildOptions -> MSBuildOptions

A function that overwrites the default MSBuildOptions

project : string

A string with the path to the project file to build.

Example

 open Fake.DotNet
     let setMsBuildParams (defaults:MSBuild.CliArguments) =
             { defaults with
                 Verbosity = Some(Quiet)
                 Targets = ["Build"]
                 Properties =
                     [
                         "Optimize", "True"
                         "DebugSymbols", "True"
                         "Configuration", "Release"
                     ]
              }
     let setParams (defaults:DotNet.MSBuildOptions) =
             { defaults with
                 MSBuildParams = setMsBuildParams defaults.MSBuildParams
              }

     DotNet.msbuild setParams "./MySolution.sln"

Execute dotnet new command

templateName : 'a

template short name to create from

setParams : NewOptions -> NewOptions

set version command parameters

Execute dotnet nuget push command

setParams : NuGetPushOptions -> NuGetPushOptions

set nuget push command parameters

nupkg : string

nupkg to publish

Example

 open Fake.DotNet
     let setNugetPushParams (defaults:NuGet.NuGetPushParams) =
             { defaults with
                 DisableBuffering = true
                 ApiKey = Some "abc123"
              }
     let setParams (defaults:DotNet.NuGetPushOptions) =
             { defaults with
                 PushParams = setNugetPushParams defaults.PushParams
              }

     DotNet.nugetPush setParams "./My.Package.nupkg"

Execute dotnet pack command

setParams : PackOptions -> PackOptions

set pack command parameters

project : string

project to pack

Example

  let packConfiguration (defaults:DotNet.PackOptions) =
         { defaults with
               Configuration = DotNet.Debug
               OutputPath = Some "./packages"
               IncludeSymbols = true }

     DotNet.pack packConfiguration "./MyProject.csproj"

Replace the current CreateProcess instance to run with dotnet.exe

buildOptions : Options -> Options

build common execution options

firstArgs : string list

c : CreateProcess<'a>

Returns: CreateProcess<'a>

Execute dotnet publish command

setParams : PublishOptions -> PublishOptions

set publish command parameters

project : string

project to publish

Execute dotnet restore command

setParams : RestoreOptions -> RestoreOptions

set restore command parameters

project : string

project to restore packages

Setup the environment (PATH and DOTNET_ROOT) in such a way that started processes use the given dotnet SDK installation. This is useful for example when using fable, see issue #2405

install : Options -> Options

The SDK to use (result of DotNet.install)

Execute dotnet test command. Its options are those of the VSTest runner. When global.json selects the Microsoft.Testing.Platform runner, use DotNet.testMTP instead.

setParams : TestOptions -> TestOptions

set test command parameters

project : string

project to test

Execute dotnet test command with the Microsoft.Testing.Platform runner, which dotnet test of the .NET SDK 10 and later uses when global.json contains "test": { "runner": "Microsoft.Testing.Platform" }. That runner has other options than the VSTest runner of DotNet.test, see MTPTestOptions. Fails when dotnet test exits with a code other than 0.

setParams : MTPTestOptions -> MTPTestOptions

set test command parameters

target : MTPTestTarget

the project, the solution or the test applications to test

Example

 DotNet.testMTP
     (fun options ->
         { options with
             NoBuild = true
             Configuration = Some DotNet.BuildConfiguration.Release
             ResultsDirectory = Some "TestResults"
             CodeCoverage =
                 Some
                     { DotNet.MTPCodeCoverageOptions.Create() with
                         OutputFormat = Some DotNet.MTPCoverageFormat.Cobertura } })
     (DotNet.MTPTestTarget.Project "tests/MyProject.Tests/MyProject.Tests.fsproj")

Tries the DotNet SDK from the global.json. This file can exist in the working directory or any of the parent directories Returns None if global.json is not found

() : unit

Returns: string option

Execute dotnet new --uninstall <PATH|NUGET_ID> command to uninstall a new template

templateName : string

template short name to uninstall