package cmdliner
Install
Dune Dependency
Authors
Maintainers
Sources
sha512=4c46bc334444ff772637deae2f5ba03645d7a1b7db523470a1246acfce79b971c764d964cbb02388639b3161b279700d9ade95da550446fb32aa4849c8a8f283
Description
Cmdliner allows the declarative definition of command line interfaces for OCaml.
It provides a simple and compositional mechanism to convert command line arguments to OCaml values and pass them to your functions. The module automatically handles syntax errors, help messages and UNIX man page generation. It supports programs with single or multiple commands and respects most of the POSIX and GNU conventions.
Cmdliner has no dependencies and is distributed under the ISC license.
Home page: http://erratique.ch/software/cmdliner
README
Cmdliner — Declarative definition of command line interfaces for OCaml
v1.3.0
Cmdliner allows the declarative definition of command line interfaces for OCaml.
It provides a simple and compositional mechanism to convert command line arguments to OCaml values and pass them to your functions. The module automatically handles syntax errors, help messages and UNIX man page generation. It supports programs with single or multiple commands and respects most of the POSIX and GNU conventions.
Cmdliner has no dependencies and is distributed under the ISC license.
Home page: http://erratique.ch/software/cmdliner
Installation
Cmdliner can be installed with opam:
opam install cmdliner
If you don't use opam consult the opam file for build instructions.
Documentation
The documentation and API reference is automatically generated by from the source interfaces. It can be consulted online or via odig doc cmdliner.
Sample programs
If you installed Cmdliner with opam sample programs are located in the directory opam config var cmdliner:doc. These programs define the command line of some classic programs.
In the distribution sample programs are located in the test directory of the distribution. They can be built and run with:
topkg build --tests true && topkg test