package odig

odig — Mine installed OCaml packages

v0.0.2

odig is a library and command line tool to mine installed OCaml packages. It supports package distribution documentation and metadata lookups and generates cross-referenced API documentation.

odig is distributed under the ISC license.

Homepage: http://erratique.ch/software/odig
Contact: Daniel Bünzli <daniel.buenzl i@erratique.ch>

Important warning

odig is a work in progress. The command line interface and API may change without notice in the future.

Installation

odig can be installed with opam:

opam install odoc ocaml-manual odig

If you don't use opam consult the opam file for build instructions.

Documentation

For a quick start, to access the distribution and API documentation of opam packages do:

opam install odoc ocaml-manual odig
odig odoc
odig doc

To use in the toplevel (experimental) do:

# #use "odig.top"
# Odig.load "Irmin_mem" (* load the Irmin_mem module and its dependencies *)
# Odig.load_libs ()     (* load libraries from a local build *)
# Odig.help ()          (* get help about toplevel loaders *)

See odig doc odig for the full API.

Other than that odig is extensively documented in man pages available through it's help system. Type:

odig help basics     # to get started
odig help packaging  # for packaging conventions
odig help            # for more help

The odig API documentation is automatically generated by from the source interfaces. It can be consulted online or, of course, via odig doc odig.