FAKE is built in a modular approach, each module corresponds to a project. The projects are named according to
logical grouping. For example, all .NET modules have the following prefix in them
Fake.DotNet, for instance
In addition to the modules, FAKE offers a runner which can be used to run F# interactive scripts in a stand-alone approach. The script will have its dependencies resolved using Paket dependency manager. FAKE modules can be added on demand to the script as needed.
Requirements to modules
You can use any NuGet packages which are compatible with
netstandard20, for example all packages
netstandard20 or lower.
Declaring module dependencies
FAKE provide multiple ways to declare dependencies for your F# interactive script. Following sections examine each approach.
Reference paket group
Create a new file
paket.dependencies and add the following content
// [ FAKE GROUP ] group NetcoreBuild source https://api.nuget.org/v3/index.json nuget Fake.Core.Target prerelease
Now you can directly use
open Fake.Core and use the Target module.
For example create a new file
// Use this for IDE support. Not required by FAKE 5 and above. Change "build.fsx" to the name of your script. #load ".fake/build.fsx/intellisense.fsx" open Fake.Core Target.create "MyBuild" (fun _ -> printfn "message from MyBuild target" ) Target.runOrDefault "MyBuild"
fake run build.fsx. This works for all FAKE modules, just add another NuGet require for other module
nuget Fake.Other.Module prerelease to the
Please read introduction about Paket for more information about the
This works because by default the FAKE runner searches for a group annotated with the
// [ FAKE GROUP ]comment.
Reference a paket group
To reference a FAKE group explicitly you can put the following at the top of your build script
#r "paket: groupref netcorebuild //" #load "./.fake/build.fsx/intellisense.fsx"
This header will reference the
paket.dependencies file and the
netcorebuild group within.
The last line
#load is not required by FAKE, however this way the file can still be edited in editors
(after restoring packages initially). Fake will write an
intellisense.fsx file for you importing all
Note that in this scenario the
// [ FAKE GROUP ]comment mentioned above is not required.
Declaring FAKE dependencies within the script
To be more independent from paket infrastructure (stand-alone-scripts and similar situations) there is a way to specify dependencies from within the script itself.
We use the new syntax specified in FST-1027. However, to be fully compatible with existing tooling and infrastructure make sure to add
//at the end of the
#rstring. See for details.
To write your build dependencies in-line you can put the following at the top of your
#r "paket: nuget Fake.Core.Target prerelease //" #load "./.fake/build.fsx/intellisense.fsx"
This has the advantage that your build-script is now "standalone" and no separate
paket.dependencies is required.
Fake will generate a
build.fsx.lock file with the "locked" dependencies to have reproducible script runs.
If you need to update your dependencies just delete the
build.fsx.lock file and run fake again.
Using module dependencies
You use the modules as documented in their corresponding help section.
But usually it's:
open Fake.<Namespace>for example
- Using the features/APIs