OCP-INDEX(1)

okay bestie, welcome to the OCP-INDEX(1) page from the Ocp-index Manual — it's giving "tiny but mighty OCaml interface explorer," and honestly? iconic. 💖

💖 NAME 💖

ocp-index — explore the interfaces of installed OCaml libraries. That's the whole assignment, and it slays.

✨ SYNOPSIS ✨

ocp-index [COMMAND] …

🦋 DESCRIPTION 🦋

Okay so ocp-index is a simple and light-weight documentation extractor for OCaml — for command-line or integrated use (e.g. for completion). It gathers information from .cmi files (like ocamlbrowser) and .cmt/.cmti files, including structure, location, type, and ocamldoc comments when available. No cap, it just pulls the receipts. 💅

🎀 COMMANDS 🎀

Here's the command fam, bestie:

• complete [OPTION]… STRING — output completions for a given prefix. ✨
• locate [OPTION]… STRING — get the location where an identifier was defined. 📍
• print [OPTION]… STRING [FORMAT] — print information about an identifier with a custom format. 🖨️
• type [OPTION]… STRING — print the type of an identifier. 🔎

💅 OPTIONS 💅

These are the flags, and yes, every single one is invited to the group chat:

• --build=DIR — set the current project build dir (default: try to guess). 🏗️
• -c WHEN, --color=WHEN — colorize the output. WHEN is either always, never or auto. 🌈
• --context=FILEPOS — will analyse the context at given FILE[:LINE[,COL]] to give appropriate answers w.r.t open modules, etc. To read from stdin, specify just :, or alternatively FILENAME:- to still specify a filename which will be used to detect e.g. the owning library scope. 🧚
• -F MODULES, --full-open=MODULES — like --open, but if the .cmt is available, load even the elements that would be restricted by the interface. Useful for the current file. 🔥
• -h LIST, --hide=LIST — kinds of elements not to show in answers: LIST is a comma-separated list of element kinds (see --show). 🙈
• -I DIRS — OCaml directories to (recursively) load the libraries from. 📚
• --no-build — don't include the build directory of the current project in lookups. 🚫
• --no-opamlib — don't include the OPAM library directory (opam var lib) in lookups. 🚫
• --no-stdlib — don't include the OCaml standard library directory (ocamlc -where) in lookups. 🚫
• -O MODULES, --open=MODULES — consider the given (comma-separated list of) modules as opened for lookup. 🫶
• --root=DIR — set the current project root (default: try to guess). 🌱
• -s LIST, --show=LIST — kinds of elements to show in answers: LIST is a comma-separated list of types, values and methods, exceptions, constructs (record fields and sum type constructors), modules and classes, sigs (module and class types), keywords. The default is v,e,c,m,k. 👑

🌈 COMMON OPTIONS 🌈

• --help[=FMT] (default=auto) — show this help in format FMT. The value FMT must be one of auto, pager, groff or plain. With auto, the format is pager or plain whenever the TERM env var is dumb or undefined. 🫶
• --version — show version information. 🌟

⭐ EXIT STATUS ⭐

ocp-index exits with the following status, bestie:

• 0 — on success. ✅
• 123 — on indiscriminate errors reported on standard error. 💀
• 124 — on command line parsing errors. 😭
• 125 — on unexpected internal errors (bugs). 🐛

---

That's the whole page, bestie — footer check: Ocp-index version 1.4.0, page tag OCP-INDEX(1), with no date line in the original to quote. Go explore those installed OCaml library interfaces. Periodt. 💖✨