feather 0.3.0 · OCaml Package

Creating and combining Feather commands

type cmd

val process : Base.string -> Base.string Base.list -> cmd

process constructs a new cmd that can be run with run or collect

val (|.) : cmd -> cmd -> cmd

|. is Feather's version of a "|" in bash; pipe the first process's stdout to the next's stdin.

val and_ : cmd -> cmd -> cmd

and_ is feather's version of a "&&" in bash. See Infix module for more.

val or_ : cmd -> cmd -> cmd

or_ is feather's version of a "||" in bash. See Infix module for more.

val sequence : cmd -> cmd -> cmd

sequence is feather's version of a ";" in bash. See Infix module for more.

Running Feather commands

val run : 
  ?cwd:Base.string ->
  ?env:(Base.string * Base.string) Base.list ->
  cmd ->
  Base.unit

Run a command without collecting anything

type 'a what_to_collect

The type that determines what should be returned by collect

Various collection possibilities, to be used with collect

val stdout : Base.string what_to_collect

val stderr : Base.string what_to_collect

val status : Base.int what_to_collect

val stdout_and_stderr : (Base.string * Base.string) what_to_collect

val stdout_and_status : (Base.string * Base.int) what_to_collect

val stderr_and_status : (Base.string * Base.int) what_to_collect

type everything = {

stdout : Base.string;
stderr : Base.string;
status : Base.int;

}

val everything : everything what_to_collect

val collect : 
  ?cwd:Base.string ->
  ?env:(Base.string * Base.string) Base.list ->
  'a what_to_collect ->
  cmd ->
  'a

collect col cmd runs cmd, collecting the outputs specified by col along the way and returning them. The return type depends on what is collected.

type 'a background_process

val run_in_background : 
  ?cwd:Base.string ->
  ?env:(Base.string * Base.string) Base.list ->
  cmd ->
  Base.unit background_process

val collect_in_background : 
  ?cwd:Base.string ->
  ?env:(Base.string * Base.string) Base.list ->
  'a what_to_collect ->
  cmd ->
  'a background_process

collect_in_background and run_in_background run the command in a thread.

Use wait to wait for the process to finish (and retreive whatever you collected).

val wait : 'a background_process -> 'a

wait for the result of run_in_background or collect_in_background.

val wait_all : Base.unit -> Base.unit

Wait for all processes started in the background.

Commands to insert OCaml within a Feather pipeline

val map_lines : f:(Base.string -> Base.string) -> cmd

map_lines within a sequence of pipes will be run with a thread. Same goes for filter_lines, mapi_lines, etc.

val filter_lines : f:(Base.string -> Base.bool) -> cmd

val mapi_lines : f:(Base.string -> Base.int -> Base.string) -> cmd

val filteri_lines : f:(Base.string -> Base.int -> Base.bool) -> cmd

val filter_map_lines : f:(Base.string -> Base.string Base.option) -> cmd

val filter_mapi_lines : 
  f:(Base.string -> Base.int -> Base.string Base.option) ->
  cmd

File redirection

val write_stdout_to : Base.string -> cmd -> cmd

val append_stdout_to : Base.string -> cmd -> cmd

val write_stderr_to : Base.string -> cmd -> cmd

val append_stderr_to : Base.string -> cmd -> cmd

val read_stdin_from : Base.string -> cmd -> cmd

val stdout_to_stderr : cmd -> cmd

val stderr_to_stdout : cmd -> cmd

stdout_to_stderr and stderr_to_stdout are NOT composable! Think of these functions as each creating a new command with the given redirection.

Applying both will result in no output to either stdout or stderr. flip_stdout_and_stderr should be easy to write if anyone should need it.

module Infix : sig ... end

Built-in commands

val ls : Base.string -> cmd

val find : 
  ?include_starting_dir:Base.bool ->
  ?ignore_hidden:Base.bool ->
  ?kind:[ `Files | `Directories ] ->
  ?name:Base.string ->
  ?depth:Base.int ->
  Base.string ->
  cmd

find lists files and/or directories, optionally filtering by name.

?depth: The maximum search depth, defaults to infinity.

?include_starting_dir: whether to include the starting directory passed into find. Defaults to false, notably different than the unix find utility.

val sh : Base.string -> cmd

val rg : ?in_:Base.string -> Base.string -> cmd

in_ is the directory that should be rg'd: rg <search> <in>. Without it, it'll filter stdin, just rg <search>

val rg_v : ?in_:Base.string -> Base.string -> cmd

val grep : ?in_:Base.string -> Base.string -> cmd

val cat : Base.string -> cmd

val less : cmd

val mkdir : Base.string -> cmd

val mkdir_p : Base.string -> cmd

val sort : cmd

val uniq : cmd

val shuf : cmd

val head : ?file:Base.string -> Base.int -> cmd

val tail : ?file:Base.string -> Base.int -> cmd

val tail_f : Base.string -> cmd

val echo : Base.string -> cmd

val cut' : ?complement:Base.unit -> ?d:Base.char -> Base.int Base.list -> cmd

val cut : ?d:Base.char -> Base.int -> cmd

val cp : Base.string -> Base.string -> cmd

val cp_r : Base.string -> Base.string -> cmd

val mv : Base.string -> Base.string -> cmd

val pwd : cmd

val sed : ?g:Base.bool -> Base.string -> Base.string -> cmd

val tr : Base.string -> Base.string -> cmd

val tr_d : Base.string -> cmd

Misc

val of_list : Base.string Base.list -> cmd

of_list emulates a Feather.cmd, each item in the list becomes a line on stdout.

val lines : Base.string -> Base.string Base.list

lines splits a string into the list of its lines

val devnull : Base.string

devnull is easier to type than "/dev/null"

val fzf : 
  ?cwd:Base.string ->
  ?env:(Base.string * Base.string) Base.list ->
  cmd ->
  Base.string Base.option

fzf runs the command, and fuzzy finds the stdout. Returns None if no item was chosen, Some str otherwise

Note that fzf is a way to to run a cmd and does not in itself return a cmd.

val debug : Base.bool Base.ref