1. Overview
  2. Docs
Cmdlang runner for programs using [Err] with a cmdliner backend

Install 

dune-project
 Dependency

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

Authors

  1. M
    Mathieu Barbin

Maintainers

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

Sources

pplumbing-0.0.16.tbz
sha256=8ae0c09fec9088bc7af60582717a9e9d8bb7703e2fbf0a1b90b82e5962ed7039
sha512=ddd1d5a3d47e7c5ebfb2898f0810156dfca4e10df500ce8f39238cfe02b51fd12ea6d7796914bd02e9ad8e615da1ed7067c9f712bdbbfb884cab08d57bba3564

Description

[pplumbing] defines a set of utility libraries to use with pp. It is compatible with logs and inspired by design choices used by dune for user messages.

These libraries are meant to combine nicely into a small ecosystem of useful helpers to build CLIs in OCaml.

[Cmdlang_cmdliner_err_runner] is a library for running command line programs specified with cmdlang with cmdliner as a backend and making opinionated choices, assuming your dependencies are using [Err].

Tags

cli cmdlang logs pp

Added to opam-repository:

README

pplumbing

Logo

CI Status Coverage Status

pplumbing defines a set of utility libraries to use with pp. It is compatible with logs and inspired by design choices used by Dune for user messages. These libraries are meant to combine nicely into a small ecosystem of useful helpers to build CLIs in OCaml.

  • Pp_tty extends pp to build colored documents in the user's terminal using ANSI escape codes.
  • Err is an abstraction to report located errors and warnings to the user.
  • Log is an interface to logs using Pp_tty rather than Format.
  • Log_cli contains functions to work with Err on the side of end programs (such as a command line tools). It defines command line helpers to configure the Err library, while taking care of setting the logs and fmt style rendering.
  • Cmdlang_cmdliner_err_runner is a library for running command line programs specified with cmdlang with cmdliner as a backend and making opinionated choices, assuming your dependencies are using Err.
  • Cmdlang_climate_err_runner is a library for running command line programs specified with cmdlang with climate as a backend and making opinionated choices, assuming your dependencies are using Err.

Experimental Status

:construction: pplumbing is currently under construction. During this initial 0.0.X experimental phase, the interfaces and behavior are subject to breaking changes.

Acknowledgements

  • We are thankful to the authors and contributors of the projects we use as dependencies.
  • We would like to thank the Dune developers for the user-facing error handling of Dune (Stdune.User_message), on which we based the error handling scheme used in Err. By adopting a similar approach, we aim to provide a consistent and unified user experience for OCaml users across different tools and libraries.

Dependencies (6)

  1. pplumbing-err = version
  2. cmdliner >= "1.3.0"
  3. cmdlang-to-cmdliner >= "0.0.9"
  4. cmdlang >= "0.0.9"
  5. ocaml >= "4.14"
  6. dune >= "3.17"

Dev Dependencies (1)

  1. odoc with-doc

Optional Dependencies

None

Used by (4)

  1. crs >= "0.0.20260307"
  2. dunolint >= "0.0.20251006"
  3. pplumbing >= "0.0.16"
  4. volgo-vcs >= "0.0.22"

Conflicts

None

Build status

Results of building cmdlang-cmdliner-err-runner with each compiler on check.ci.ocaml.org, run of against opam-repository 7cdc698. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
0.0.16 (this version) n/a good good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure