Fli 0.11.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Fli --version 0.11.0
NuGet\Install-Package Fli -Version 0.11.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Fli" Version="0.11.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Fli --version 0.11.0
#r "nuget: Fli, 0.11.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Fli as a Cake Addin
#addin nuget:?package=Fli&version=0.11.0

// Install Fli as a Cake Tool
#tool nuget:?package=Fli&version=0.11.0

Fli

build Nuget

Execute CLI commands from your F# code in F# style!

Features

  • Starting processes easily
  • Execute CLI commands in your favourite shell
  • F# computation expression syntax
  • Wrap authenticated CLI tools
  • No external dependencies

Install

Get it from Nuget: dotnet add package Fli

Usage

open Fli and start

For example:

cli {
    Shell CMD
    Command "echo Hello World!"
}
|> Command.execute

that starts CMD.exe as Shell and echo Hello World! is the command to execute.

Run a file with PowerShell from a specific directory:

cli {
    Shell PWSH
    Command "test.bat"
    WorkingDirectory (Environment.GetFolderPath Environment.SpecialFolder.UserProfile)
}
|> Command.execute

Executing programs with arguments:

cli {
    Exec "path/to/executable"
    Arguments "--info"
}
|> Command.execute

an example with git:

cli {
    Exec "git"
    Arguments ["commit"; "-m"; "Fixing issue #1337."]
}
|> Command.execute

Add a verb to your executing program:

cli {
    Exec "adobe.exe"
    Arguments (Path.Combine ((Environment.GetFolderPath Environment.SpecialFolder.UserProfile), "test.pdf"))
    Verb "open"
}
|> Command.execute

Write output to a specific file:

cli {
    Exec "dotnet"
    Arguments "--list-sdks"
    Output @"absolute\path\to\dotnet-sdks.txt"
}
|> Command.execute

Add environment variables for the executing program:

cli {
    Exec "git"
    EnvironmentVariables [("GIT_AUTHOR_NAME", "Jon Doe"); ("GIT_AUTHOR_EMAIL", "jon.doe@domain.com")]
}
|> Command.execute

Add credentials to program:

cli {
    Exec "program"
    Credentials ("domain", "bobk", "password123")
}
|> Command.execute

Hint: Running a process as a different user is supported on all platforms. Other options (Domain, Password) are only available on Windows. As an alternative for not Windows based systems there is:

cli {
    Exec "path/to/program"
    Username "admin"
}
|> Command.execute
Command.execute

Command.execute returns record: type Output = { Text: string option; ExitCode: int; Error: string option } which has getter methods to get only one value:

toText: Output -> string
toExitCode: Output -> int
toError: Output -> string

example:

cli {
    Shell CMD
    Command "echo Hello World!"
}
|> Command.execute // { Text = Some "Hello World!"; ExitCode = 0; Error = None }
|> Output.toText // "Hello World!"

// same with Output.toExitCode:
cli { ... }
|> Command.execute // { Text = Some "Hello World!"; ExitCode = 0; Error = None }
|> Output.toExitCode // 0

// in case of an error:
cli { ... }
|> Command.execute // { Text = None; ExitCode = 1; Error = Some "This is an error!" }
|> Output.toError // "This is an error!"

Command.toString

Command.toString concatenates only the the executing shell/program + the given commands/arguments:

cli {
    Shell PS
    Command "Write-Host Hello World!"
}
|> Command.toString // "powershell.exe -Command Write-Host Hello World!"

and:

cli {
    Exec "cmd.exe"
    Arguments [ "/C"; "echo"; "Hello World!" ]
}
|> Command.toString // "cmd.exe /C echo Hello World!"
Builder operations:

ShellContext operations (cli { Shell ... }): | Operation | Type | |------------------------|----------------------------| | Shell | Fli.Shells | | Command | string | | Input | string | | Output | Outputs (see below) | | WorkingDirectory | string | | EnvironmentVariable | string * string | | EnvironmentVariables | (string * string) list | | Encoding | System.Text.Encoding |

ExecContext operations (cli { Exec ... }): | Operation | Type | |------------------------|----------------------------------------------------------| | Exec | string | | Arguments | string / string seq / string list / string array | | Input | string | | Output | Outputs (see below) | | Verb | string | | Username | string | | Credentials | string * string * string | | WorkingDirectory | string | | EnvironmentVariable | string * string | | EnvironmentVariables | (string * string) list | | Encoding | System.Text.Encoding |

Currently provided Fli.Shells:

  • CMD runs cmd.exe /c ... or cmd.exe /k ... (depends if Input is provided or not)
  • PS runs powershell.exe -Command ...
  • PWSH runs pwsh.exe -Command ...
  • WSL runs wsl.exe -- ...
  • BASH runs bash -c ...

Provided Fli.Outputs:

  • File of string a string with an absolute path of the output file.
  • StringBuilder of StringBuilder a StringBuilder which will be filled with the output text.
  • Custom of Func<string, unit> a custom function (string -> unit) that will be called with the output string (logging, printing etc.).

Do you miss something?

Open an issue or start a discussion.

Inspiration

Use CE's for CLI commands came in mind while using FsHttp.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Fli:

Package Downloads
Florence

Package Description

Slurmi

Tool for the creation of slurm jobscripts and workflows with F#.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.111.10 138 5/31/2024
1.111.1 97 5/24/2024
1.111.0 516 4/16/2024
1.110.0 109 4/12/2024
1.101.0 1,160 1/9/2024
1.100.10 241 11/24/2023
1.100.1 111 11/24/2023
1.100.0 115 11/24/2023
1.11.0 895 10/6/2023
1.10.1 1,561 9/1/2023
1.10.0 426 8/11/2023
1.1.1 2,546 7/25/2023
1.1.0 659 5/29/2023
1.0.1 3,671 2/2/2023
1.0.0 463 12/17/2022
0.11.0 985 11/11/2022
0.9.0 390 10/18/2022
0.8.0 393 10/12/2022
0.7.0 352 10/7/2022
0.6.1 355 10/4/2022
0.6.0 368 10/4/2022
0.0.2 388 9/29/2022