Fake Template

The Fake template bootstraps FAKE and sets up a basic build-script.

Installation

Run


dotnet new -i "fake-template::*"
to install or update the template.

Usage

After you installed the template you can setup FAKE by running:


dotnet new fake
This will create a default build.fsx file, a paket.dependencies file used to mangage your build dependencies and two shell scripts fake.sh and fake.cmd. The shell scripts are used to bootstrap and run FAKE. All of the arguments are passed direcly to FAKE so you can run:

.\fake.cmd build
to run your build. Have a look this for the available command-line options. This page additional information on how to use a build script.

Options

--script-name

Specifies the name of the generated build-script. Defaults to build.fsx.

--bootstrap

Specifies your prefered way to bootstrap FAKE.

  • tool (default) - Installs the FAKE dotnet sdk global tool into the tool--path folder
  • project - Creates a build.proj and uses DotNetCliToolReference to bootstrap FAKE
  • none - Does not bootstrap FAKE. Use this if you want to use a global installation of FAKE

--dependencies

Specifies your prefered way to define the nuget packages used in your build:

  • file (default) - Creates a paket.dependencies file to define build dependencies
  • inline - Defines build dependencies inside the build script
  • none - Use this if you already have a paket.dependencies in your folder

--tool-path

Specifies the folder for the fake-cli tool. This parameter is only applicable when tool is used for bootstrapping. Defaults to .fake.

--version

Specifies the version of FAKE to install. Defaults to 5.*. This parameter is only applicable when either tool or project is used for bootstrapping.