tatsuya-midorikawa / Owl.cli

🔷 Owl.cli

Owl.cli is a library to facilitate the use of shell from F#. This library allows you to execute commands while also retrieving the results. It is characterized by the ability to execute commands continuously while preserving context.

🔹 Usage

1️⃣ cmd computation expression

▫️ exec custom op : string -> string

Execute the command passed to exec and receive the result. Use into to receive the results.

open Owl.cli.cmd

use builder = cmd () {
  exec @"cd C:\"
  exec @"dir .\" into r
  printfn $"%s{r}"
}

▫️ exit custom op : unit -> ShellBuilder

Explicitly terminates the cmd. If exit is not called, the cmd also exits when the ShellBuilder is disposed.

open Owl.cli.cmd

use builder = cmd () {
  exec @"cd C:\"
  exec @"dir .\"
  exit
}

▫️ results property : array<Output>

Obtain a pair of executed commands and their results.

open Owl.cli.cmd

use builder = cmd () {
  exec @"cd C:\"
  exec @"dir .\"
  exit
}

builder.results |> Array.iter (printfn "%A")

2️⃣ powershell computation expression (LEGACY PowerShell)

▫️ exec custom op : string -> string

Execute the command passed to exec and receive the result. Use into to receive the results

open Owl.cli.powershell

use builder = powershell () {
  exec @"cd C:\"
  exec @"ls .\" into r
  printfn $"%s{r}"
}

▫️ exit custom op : unit -> ShellBuilder

Explicitly terminates the powershell. If exit is not called, the powershell also exits when the ShellBuilder is disposed.

open Owl.cli.powershell

use builder = powershell () {
  exec @"cd C:\"
  exec @"ls .\"
  exit
}

▫️ results property : array<Output>

Obtain a pair of executed commands and their results.

open Owl.cli.powershell

use builder = powershell () {
  exec @"cd C:\"
  exec @"ls .\"
  exit
}

builder.results |> Array.iter (printfn "%A")

3️⃣ pwsh computation expression (PowerShell Core)

▫️ exec custom op : string -> string

Execute the command passed to exec and receive the result. Use into to receive the results.

open Owl.cli.pwsh

use builder = pwsh () {
  exec "cd /bin"
  exec "ls ./" into r
  printfn $"%s{r}"
}

▫️ exit custom op : unit -> ShellBuilder

Explicitly terminates the pwsh. If exit is not called, the pwsh also exits when the ShellBuilder is disposed.

open Owl.cli.pwsh

use builder = pwsh () {
  exec "cd /bin"
  exec "ls ./"
  exit
}

▫️ results property : array<Output>

Obtain a pair of executed commands and their results.

open Owl.cli.pwsh

use builder = pwsh () {
  exec "cd /bin"
  exec "ls ./"
  exit
}

builder.results |> Array.iter (printfn "%A")

4️⃣ zsh computation expression

▫️ exec custom op : string -> string

Execute the command passed to exec and receive the result. Use into to receive the results.

open Owl.cli.zsh

use builder = zsh () {
  exec "cd /bin"
  exec "ls ./" into r
  printfn $"%s{r}"
}

▫️ exit custom op : unit -> ShellBuilder

Explicitly terminates the zsh. If exit is not called, the zsh also exits when the ShellBuilder is disposed.

open Owl.cli.zsh

use builder = zsh () {
  exec "cd /bin"
  exec "ls ./"
  exit
}

▫️ results property : array<Output>

Obtain a pair of executed commands and their results.

open Owl.cli.zsh

use builder = zsh () {
  exec "cd /bin"
  exec "ls ./"
  exit
}

builder.results |> Array.iter (printfn "%A")

5️⃣ bash computation expression

▫️ exec custom op : string -> string

Execute the command passed to exec and receive the result. Use into to receive the results.

open Owl.cli.bash

use builder = bash () {
  exec "cd /bin"
  exec "ls ./" into r
  printfn $"%s{r}"
}

▫️ exit custom op : unit -> ShellBuilder

Explicitly terminates the bash. If exit is not called, the bash also exits when the ShellBuilder is disposed.

open Owl.cli.bash

use builder = bash () {
  exec "cd /bin"
  exec "ls ./"
  exit
}

▫️ results property : array<Output>

Obtain a pair of executed commands and their results.

open Owl.cli.bash

use builder = bash () {
  exec "cd /bin"
  exec "ls ./"
  exit
}

builder.results |> Array.iter (printfn "%A")

6️⃣ cli computation expression

Warning cli will be a generic implementation of CE. Some shells such as 'cmd' will not be handled correctly because the base of behavior will be 'zsh' or 'bash' equivalent.

▫️ exec custom op : string -> string

Execute the command passed to exec and receive the result. Use into to receive the results.

open Owl.cli.general

use builder = cli "/bin/zsh" {
  exec "cd /bin"
  exec "ls ./" into r
  printfn $"%s{r}"
}

▫️ exit custom op : unit -> ShellBuilder

Explicitly terminates the cli. If exit is not called, the cli also exits when the ShellBuilder is disposed.

open Owl.cli.general

use builder = cli () {
  exec "cd /bin"
  exec "ls ./"
  exit
}

▫️ results property : array<Output>

Obtain a pair of executed commands and their results.

open Owl.cli.general

use builder = cli () {
  exec "cd /bin"
  exec "ls ./"
  exit
}

builder.results |> Array.iter (printfn "%A")