package async_shell

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Small helper commands

Shell helpers for Async

Install

dune-project

Dependency

github.com Readme Changelog MIT License Edit opam file Versions (5)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

sha256=b873051dd46e82b932a52db72a957345a30399c8bce75361024ce7bfe235cb82

doc/async_shell/Async_shell/index.html

Module `Async_shell`Source

WARNING: The use of this library in new projects is discouraged; consider using Async.Process instead. This library has some gotchas, such as being unable to return the full output of a command (see the ?tail_len argument to Low_level_process.run).

The functions in here are straightforward in_thread wrappers of Shell (lib/shell/src/shell.mli) functions.

Child processes will not exit when the parent process exits. If you want the child processes to terminate, you need to arrange it explicitly, e.g. by sending a signal, or closing a pipe, or sending an explicit message.

Sourcemodule Process : sig ... end

Sourcetype 'a with_process_flags = 'a Shell.with_process_flags

Sourcetype 'a with_run_flags = 'a Shell.with_run_flags

Sourcetype 'a with_test_flags = 'a Shell.with_test_flags

Sourcetype 'a with_ssh_flags = 'a Shell.with_ssh_flags

Sourcetype 'a with_sh_flags = 'a Shell.with_sh_flags

Sourcetype 'a cmd = 'a Shell.cmd

Sourcetype ('a, 'ret) sh_cmd = ('a, 'ret) Shell.sh_cmd

Sourceval test : bool Async.Deferred.t cmd with_test_flags

Sourceval sh_test : ('a, bool Async.Deferred.t) sh_cmd with_test_flags with_sh_flags

val ssh_test : 
  ('a, bool Async.Deferred.t) sh_cmd with_test_flags with_ssh_flags

Sourceval run : unit Async.Deferred.t cmd with_run_flags

Sourceval run_lines : ?eol:char -> string list Async.Deferred.t cmd with_run_flags

val run_one_line : 
  ?eol:char ->
  string Core.Or_error.t Async.Deferred.t cmd with_run_flags

Sourceval run_one_line_exn : ?eol:char -> string Async.Deferred.t cmd with_run_flags

val run_first_line : 
  ?eol:char ->
  string option Async.Deferred.t cmd with_run_flags

val run_first_line_exn : 
  ?eol:char ->
  string Async.Deferred.t cmd with_run_flags

Sourceval run_full : string Async.Deferred.t cmd with_run_flags

Sourceval run_full_and_error : (string * string) Async.Deferred.t cmd with_run_flags

Sourceval run_lines_stream : string Async.Stream.t cmd with_run_flags

Sourceval sh : ('a, unit Async.Deferred.t) sh_cmd with_run_flags with_sh_flags

val sh_lines : 
  ('a, string list Async.Deferred.t) sh_cmd with_run_flags with_sh_flags

val sh_one_line : 
  ('a, string Core.Or_error.t Async.Deferred.t) sh_cmd with_run_flags
    with_sh_flags

val sh_one_line_exn : 
  ('a, string Async.Deferred.t) sh_cmd with_run_flags with_sh_flags

val sh_first_line : 
  ('a, string option Async.Deferred.t) sh_cmd with_run_flags with_sh_flags

val sh_first_line_exn : 
  ('a, string Async.Deferred.t) sh_cmd with_run_flags with_sh_flags

Sourceval sh_full : ('a, string Async.Deferred.t) sh_cmd with_run_flags with_sh_flags

val sh_full_and_error : 
  ('a, (string * string) Async.Deferred.t) sh_cmd with_run_flags with_sh_flags

val sh_lines_stream : 
  ('a, string Async.Stream.t) sh_cmd with_run_flags with_sh_flags

Sourceval ssh : ('a, unit Async.Deferred.t) sh_cmd with_run_flags with_ssh_flags

val ssh_lines : 
  ('a, string list Async.Deferred.t) sh_cmd with_run_flags with_ssh_flags

val ssh_one_line : 
  ('a, string Core.Or_error.t Async.Deferred.t) sh_cmd with_run_flags
    with_ssh_flags

val ssh_one_line_exn : 
  ('a, string Async.Deferred.t) sh_cmd with_run_flags with_ssh_flags

val ssh_first_line : 
  ('a, string option Async.Deferred.t) sh_cmd with_run_flags with_ssh_flags

val ssh_first_line_exn : 
  ('a, string Async.Deferred.t) sh_cmd with_run_flags with_ssh_flags

val ssh_lines_stream : 
  ('a, string Async.Stream.t) sh_cmd with_run_flags with_ssh_flags

val ssh_full : 
  ('a, string Async.Deferred.t) sh_cmd with_run_flags with_ssh_flags

val ssh_full_and_error : 
  ('a, (string * string) Async.Deferred.t) sh_cmd with_run_flags with_ssh_flags

Small helper commands

Sourceval mkdir : ?p:unit -> ?perm:int -> string -> unit Async.Deferred.t

val scp : 
  ?compress:bool ->
  ?recurse:bool ->
  ?user:string ->
  host:string ->
  string ->
  string ->
  unit Async.Deferred.t

On This Page

Small helper commands