package tezos-clic

  1. Overview
  2. Docs
Tezos: library of auto-documented command-line-parsing combinators

Install 

dune-project
 Dependency

www.tezos.com Edit opam file Versions (5)

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-v12.3.tar.bz2
sha256=296bb5674bc6050afe6330326fbdd0dfc2255d414bfd6b79cc7666ac6b39316d
sha512=c061cd300a9410300851158d77bf8e56ca3c568b0b1161b38305e5b2efdcd9c746d391f832fdb2826f9a1d6babce10a9b764a4b04f5df42699f7314b9863123a

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.

Sourcetype output_format

A representation of the output format.

Sourceval clic_arg : unit -> (output_format option, _) Tezos_clic.Clic.arg

Command line argument for Clic.command (and the 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.

Sourceval 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.t

output 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 ().

Sourceval 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.t

Same as output but for a single row of data.

Sourceval output_for_human : output_format option -> (unit -> unit Tezos_error_monad.Error_monad.tzresult Lwt.t) -> unit Tezos_error_monad.Error_monad.tzresult Lwt.t

output_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.