feather 0.1.0 · OCaml Package

type cmd

val process : string -> string list -> cmd

process constructs a new command

val cat : string -> cmd

val echo : string -> cmd

val ls : string -> cmd

val sh : string -> cmd

val rg : ?in_:string -> 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_:string -> string -> cmd

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

val tr : string -> string -> cmd

val tr_d : string -> cmd

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

val mkdir : string -> cmd

val mkdir_p : string -> cmd

val pwd : cmd

val less : cmd

val sort : cmd

val uniq : cmd

val shuf : cmd

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

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

val tail_f : string -> cmd

val cp : string -> string -> cmd

val cp_r : string -> string -> cmd

val mv : string -> string -> cmd

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

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

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

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

|. is feather's version of a "|" in bash.

val collect_lines : 
  ?cwd:string ->
  ?env:(string * string) list ->
  cmd ->
  string list

val collect_stdout : 
  ?cwd:string ->
  ?env:(string * string) list ->
  cmd ->
  string

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

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

map within a series of pipes will be run in a thread.

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

val run_bg : ?cwd:string -> ?env:(string * string) list -> cmd -> unit

Run the process in a thread. Use wait to ensure that the parent won't exit, subsequently killing the background process.

val write_stdout_to : string -> cmd -> cmd

val append_stdout_to : string -> cmd -> cmd

val write_stderr_to : string -> cmd -> cmd

val append_stderr_to : string -> cmd -> cmd

module File_redirection_infix : sig ... end

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.

val devnull : string

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

val last_exit : unit -> int

last_exit returns the exit status of the last child process to have exited

val fzf : ?cwd:string -> ?env:(string * string) list -> cmd -> string 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 : bool Core.ref

package feather