OCaml logo

ocp-index

Lightweight completion and documentation browsing for OCaml libraries
README

ocp-index is a light-weight tool and library providing easy access to the information contained in your OCaml cmi/cmt/cmti files.
It can be used to provide features like library interface browsing, auto-completion, show-type and goto-source.

This source tree builds:

  • ocp-index.lib, the engine as a library

  • the ocp-index command-line tool

  • the ocp-grep command-line tool, that can search code for a given qualified
    OCaml ident (including uses after opens, etc.)

  • the ocp-browser tool, which is a browser for installed OCaml APIs on the
    terminal

The first tree are part of opam package ocp-index, and the latter is in its own ocp-browser package.

ocp-index is part of TypeRex, developed and maintained by OCamlPro. Documentation to install and use this tool is available on http://www.typerex.org/ocp-index.html

It is released under LGPL v3 with linking exception.

Install
http://www.typerex.org/ocp-index.html
Documentation
org:ocamlpro org:typerex
Published
21 Sep 2022
Changelog LGPL-2.1-only WITH OCaml-LGPL-linking-exception; GPL-3.0-only License
Authors
Maintainers
Sources
1.3.4.tar.gz 
md5=b1770f0fd784ff29173d5b4090ccff2c
sha512=32c800c404ae0f32a6cdb8f5f62bac56b23b017dd27674834e4d063df7d49bca272fc39ba2905b8404b5e3d1b154f1ffd2924705e34e1d1ac56242260b81a5c4
Dependencies
odoc 
with-doc
cmdliner 
>= "1.1.0"
re 
>= "1.9.0"
ocp-indent 
>= "1.4.2"
dune 
>= "1.0"
cppo 
build & >= "1.1.0"
ocaml 
>= "4.08.0"
Reverse Dependencies
iocaml-kernel 
< "0.4.6"
ocaml-top 
>= "1.1.3"
ocp-browser 
< "1.1.6" | >= "1.3.4"
ocp-index-top
starterkit