package pplumbing

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Configuration

pplumbing
- CHANGES
- README
- Library pplumbing.cmdlang-cmdliner-runner
  - Cmdlang_cmdliner_runner
- Library pplumbing.err
  - Err
    
    Exit_code
    
    With_exit_code
    
    Color_mode
    
    Log_level
    
    Level
    
    For_test
    
    Private
- Library pplumbing.log
  - Log
    
    Logs
- Library pplumbing.log-cli
  - Log_cli
    
    Color_mode
    
    Log_level
    
    Config
- Library pplumbing.pp-tty
  - Pp_tty
    
    Ansi_color
    
    RGB8
    
    RGB24
    
    Style
    
    Staged
    
    Style
    
    Print_config
    
    To_string
- Sources
  - pplumbing.cmdlang-cmdliner-runner
    
    cmdlang_cmdliner_runner.ml
  - pplumbing.err
    
    err.ml
  - pplumbing.log
    
    log.ml
  - pplumbing.log-cli
    
    log_cli.ml
  - pplumbing.pp-tty
    
    ansi_color.ml
    
    pp_tty.ml
    
    pp_tty__.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Log_cli`Source

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

package pplumbing

Module Log_cliSource

Configuration

Module `Log_cli`Source