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

FsiParams

Record Fields

Record FieldDescription
Checked
Signature: bool option

Generate overflow checks

Codepage
Signature: int option

Specify the codepage used to read source files

ConsoleColors
Signature: bool option

Output warning and error messages in color

CrossOptimize
Signature: bool option

Enable or disable cross-module optimizations

Debug
Signature: bool option

Emit debug information (Short form: -g)

DebugType
Signature: DebugTypes

Specify debugging type: full, portable, embedded, pdbonly. PdbOnly is the default

Define
Signature: string

(Obsolete) Define a conditional compilation symbol (use FsiParams.Definitions instead)

Definitions
Signature: string list

Define a list of conditional compilation symbols

Deterministic
Signature: bool option

Produce a deterministic assembly (including module version GUID and timestamp)

Environment
Signature: Map<string,string>

Environment variables

Exec
Signature: bool

Exit fsi after loading the files or running the .fsx script given on the command line

FullPaths
Signature: bool

Output messages with fully qualified paths

GUI
Signature: bool option

Execute interactions on a Windows Forms event loop (on by default)

Help
Signature: bool

Display the commandline flags and their usage

Lib
Signature: string list

Specify a directory for the include path which is used to resolve source files and assemblies (Short form: -I)

Load
Signature: string

Load the given file on startup

MLCompatibility
Signature: bool

Ignore ML compatibility warnings

NoFramework
Signature: bool

Do not reference the default CLI assemblies by default

NoLogo
Signature: bool

Suppress compiler copyright message

NoWarn
Signature: int list

Disable specific warning messages

Optimize
Signature: bool option

Enable optimizations (Short form: -O)

PreferredUiLang
Signature: string

Specify the preferred output language culture name (e.g. es-ES, ja-JP)

Quiet
Signature: bool

Suppress fsi writing to stdout

QuotationsDebug
Signature: bool option

Emit debug information in quotations

ReadLine
Signature: bool option

Support TAB completion in console (on by default)

Reference
Signature: string

Reference an assembly (Short form: -r)

ShadowCopyReferences
Signature: bool option

Prevents references from being locked by the F# Interactive process

SimpleResolution
Signature: bool

Resolve assembly references using directory-based rules rather than MSBuild resolution

TailCalls
Signature: bool option

Enable or disable tailcalls

TargetProfile
Signature: Profile

Specify target framework profile of this assembly. Valid values are mscorlib, netcore or netstandard. Default - mscorlib

ToolPath
Signature: FsiTool

Sets the path to the fsharpi / fsi.exe to use

Use
Signature: string

Use the given file on startup as initial input

Utf8Output
Signature: bool

Output messages in UTF-8 encoding

Warn
Signature: int option

Set a warning level (0-5)

WarnAsError
Signature: bool option

Report all warnings as errors

WarnAsErrors
Signature: bool * int list

Report specific warnings as errors

WarnOn
Signature: int list

Enable specific warnings that may be off by default

WorkingDirectory
Signature: string

When UseShellExecute is true, the fully qualified name of the directory that contains the process to be started. When the UseShellExecute property is false, the working directory for the process to be started. The default is an empty string ("").

Instance members

Instance memberDescription
x.WithEnvironment(map)
Signature: map:Map<string,string> -> FsiParams

Sets the current environment variables.

Static members

Static memberDescription
FsiParams.Create()
Signature: unit -> FsiParams
FsiParams.ToArgsList(p)
Signature: p:FsiParams -> string list