package pplumbing-log-cli

  1. Overview
  2. Docs
On This Page
  1. Configuration

Module Pplumbing_log_cli.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 ...