package pplumbing

  1. Overview
  2. Docs
On This Page
  1. Configuration
Utility libraries to use with [pp]

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (2)

Authors

  1. M
    Mathieu Barbin

Maintainers

  1. M
    Mathieu Barbin <opensource@mbarbin.org>

Sources

pplumbing-0.0.14.tbz
sha256=ed7eaba180378a59719e9af63ccdc89dde8e0a20f2cba420abb0080b0bc4a868
sha512=f168c37c1acd38c92e5b6d59321da4021195b6ddc49dde82de70e9282b55042621bea1b84a677d57f83604c06d6ee9c790b683fd589cd2097ab8f00c293f56af

doc/pplumbing.log-cli/Log_cli/index.html

Module Log_cliSource

Log_cli contains functions to work with Err on the side of end programs (such as a command line tool, as opposed to libraries).

It defines a command line parser to configure the Err library, while taking take of setting the Logs and Fmt style rendering.

Configuration

Sourcemodule Color_mode : sig ... end
Sourcemodule Log_level : sig ... end
Sourcemodule Config : sig ... end
Sourceval setup_config : config:Config.t -> unit

Perform global side effects to modules such as Err, Logs & Fmt to configure how to do error rendering in the terminal, set log levels, etc. If you wish to do this automatically from the arguments parsed in a command line, see also set_config.

Sourceval set_config : unit -> unit Cmdlang.Command.Arg.t

Adding this argument to your command line will make it support Err configuration and takes care of setting the global configuration with specification coming from the command line. This is designed to work well with project using Err, Logs and Fmt.

  let open Command.Std in
  let+ () = Log_cli.set_config () in ...