OCP-GREP(1)

📦
version 1.4.0 · 2 versions
, in alpine 3.24

OCP-GREP(1) 💅 the Ocp-grep Manual, but make it bestie-core

okay so bestie, welcome to ocp-grep — the Ocp-grep Manual — and we're gonna make it make sense. 🫶✨

✨ NAME ✨

ocp-grep — locates instances of a given OCaml ident in source files, handling (local) opens, module, etc. 💖

🌸 SYNOPSIS 🌸

ocp-grep [--color=WHEN] [--regexp-strings] [--strings] [OPTION]… ID [FILES]…

🎀 ARGUMENTS 🎀

  • FILES — files or directories to search into. By default, searches for project root. 🗂️
  • ID (required) — fully qualified ident to search for (eg. List.map, Set.Make.add, ...), or string with option -s. 🔎

🦋 OPTIONS 🦋

  • -c WHEN, --color=WHEN — colorize the output. WHEN is either always, never or auto. 🌈
  • -e, --regexp-strings — like --strings, but search a POSIX regular expression. 🧚
  • -s, --strings — search strings within strings in the source, instead of searching code. 🍓

👑 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-grep exits with the following status:

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

💀 BUGS 💀

Current version doesn't handle shadowing and different kinds of idents, therefore you can get false positive if a type and a value have the name. bestie, that's the false-positive warning, not a vibe. 😭

Field records don't currently respect the distributive {Module.' syntax. Also, if you use record disambiguation, you're on your own for field names since this program doesn't know about typing. 🫠

okay bye bestie — this iconic manual's source/version footer is Ocp-grep 1.4.0 (no date on the line, just the version tea), and we're out 💖✨

📦 where this page comes from