View on GitHub

OCamlverse

Documenting everything about OCaml

Edit

Package Management

We’ll suggest the easiest tools to use first, and then explain the details.

End-to-End Project Management Tools

  • drom: A full project management tool similar to Rust’s cargo, aiming for the easiest possible user experience. Calls opam, dune and odoc behind the scenes. drom knows how to talk to github, is configured with toml files, and can produce Sphinx and odoc documentation.
  • spin: For easy project initialization, you may want to try spin. It has all sorts of templates for different kinds of project (more than drom does), but unlike drom it doesn’t manage the various OCaml tools.
  • pesy: On the other side of the package management divide, we have pesy, which uses esy as its package management backend.

Package Management

Due to legacy reasons, OCaml’s package management and build story is complicated. Trust us though – it’s a lot better than it used to be! There are 2 main components: the build tool (everyone now uses dune), and the package management system (nowadays you have the choice of OPAM or esy).

  • OPAM is the main modern package manager for OCaml. If you want to publish a library in OCaml, OPAM is your friend, taking care of package dependency and invoking the build system as needed. OPAM supports lockfiles and sandboxing (local switch creation), but the features aren’t as well-integrated as they are in esy.

    • OPAM command tutorial with comparison to npm
    • opam-ci, a plugin for OPAM, provides access to full continuous integration information about every package in OPAM. You can see which packages compile and which are broken from the command line.
    • OPAM 2.0 tips: Local opam installs, pinning, and lock files.
    • opam-check-all: shows you all OPAM packages and their build status on multiple versions of the compiler. Provides filtering for specific package versions, build errors, and package authors.
    • OPAM for Windows: OPAM repository modified for native Windows usage (deprecated).
  • esy: An alternative tool for package management that draws on lessons learned from the JavaScript ecosystem. Its main advantages over OPAM are

    • Immutable packages managed in a git-like system.
    • All packages have been made relocatable.
    • lockfiles specifying precise package versions by default.

    What this means is that sandboxed, isolated environments with a global binary cache are easier to create than in OPAM, as is a lockfile-based development approach. However, esy’s method suffers from the fact that even the slightest upgrade creates new binary artifacts, causing garbage to pile up. A periodic garbage collection is therefore recommended. Currently esy is installed using npm (the node.js package manager), but this is done purely for ease of distribution.

OCaml Build System

  • dune (formerly jbuilder) is a fast, easy to use build system for OCaml projects, and is seen as the main choice for new projects in OCaml. Dune can handle both OCaml (.ml) and Reason (.re) files.

    • mkocaml: tool for creating a new OCaml project using dune.
    • dune-starter: a sample project indicating ideal code layout for an OCaml project.
    • By default, Dune treats warnings as errors when building in the dev mode (ie. a local build). To change this, use this tip.
    • dune-deps: Allows you to view your dependencies in graph form.
    • Cache: Dune now includes an opt-in feature that shares build artifacts. See here.

Package Release System

Managing packages can take some effort, and there are some tools available for automating this process.

  • dune-release: a tool for managing and releasing a package easily on OPAM. Built only for projects that use Dune as a build system. This is the tool you should use for easily updating your OPAM projects.
  • topkg: an alternative, older tool that allows you to easily release and maintain many OCaml packages at once. A little bit of extra metadata in your repo gives you the ability to use the topkg command line tools and manage your authored packages.

Other Tooling

  • ocamlscript: Allows you to run OCaml files as if they were scripts. Pre-compiles and runs them on the spot.

  • ocamlfind is a utility similar to pkg-config that allows local libraries to find each other on your system. You don’t need to have much awareness of ocamlfind nowadays because Dune and OPAM (see below) will do all the work, but it’s good to know about ocamlfind’s existence.

Continuous Integration

Legacy OCaml build systems

You may find some other build systems used by various OCaml projects. The general recommendation is to avoid these legacy tools.

  • ocamlbuild : the option most used as a build tool before Dune came about.
  • Oasis : An older tool to integrate a configure, build and install system in your OCaml project. Before OPAM and Dune, this was a relatively easy way to create your project.
  • oasis2opam : Tool to convert OASIS metadata to OPAM package descriptions.
  • jenga : A monadic build system from Jane Street. Much of the underlying system used by Dune is composed of code from Jenga.
  • ocaml-makefile : Easy to use Makefile for small to medium-sized OCaml-projects.
  • obuild : Simple package build system for ocaml.