package tezos-clic
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=43723d096307603703a1a89ed1b2eb202b365f5e7824b96b0cbf813b343a6cf7
sha512=b2a637f2e965000d3d49ad85277ca24d6cb07a1a7cf2bc69d296d8b03ad78c3eaa8e21e94b9162e62c2e11649cd03bc845b2a3dafe623b91065df69d47dc8e4f
doc/tezos-clic.unix/Tezos_clic_unix/Scriptable/index.html
Module Tezos_clic_unix.ScriptableSource
Manage a common "--for-script <FORMAT>" option to make the output of certain commands script-friendly.
A representation of the output format.
Command line argument for Tezos_clic.command (and the Tezos_clic.args* functions). Not that this is the only way to obtain a value of type output_format. On the command line, it appears as --for-script with values TSV or CSV.
val output :
?channel:Lwt_io.output_channel ->
output_format option ->
for_human:(unit -> unit Tezos_error_monad.Error_monad.tzresult Lwt.t) ->
for_script:(unit -> string list list) ->
unit Tezos_error_monad.Error_monad.tzresult Lwt.toutput fmt_opt ~for_human ~for_script behaves in one of two ways. If fmt_opt is Some _, then it formats the value returned by for_script (). The function's return value is formatted as lines of columns of values (list of lists of strings). This is to help scripts to decode/interpret/parse the output. Otherwise, if fmt_opt is None, it calls for_human () which is responsible for the whole formatting.
The optional argument channel is used when automatically formatting the value returned by for_script (). It has no effect on for_human ().
val output_row :
?channel:Lwt_io.output_channel ->
output_format option ->
for_human:(unit -> unit Tezos_error_monad.Error_monad.tzresult Lwt.t) ->
for_script:(unit -> string list) ->
unit Tezos_error_monad.Error_monad.tzresult Lwt.tSame as output but for a single row of data.
val output_for_human :
output_format option ->
(unit -> unit Tezos_error_monad.Error_monad.tzresult Lwt.t) ->
unit Tezos_error_monad.Error_monad.tzresult Lwt.toutput_for_human fmt_opt for_human behaves in either of two ways. If fmt_opt is None, then it calls for_human (). Otherwise, it does nothing.
Use this function to provide output that is of no interest to automatic tools.