Adding a Nix-based environment for OCaml

In this tutorial, you will learn how to set up a basic development environment for OCaml. Unlike the ocaml-dune template, this approach is designed to help you explore an existing OCaml codebase. In this setup, ocaml-lsp provides useful hints on type information and navigation. It is easier to set up than the other template, and it should work whether or not the project uses dune.

Note

This document won't explain how to initialize a new OCaml project without Dune, because generally Dune is the way, and other paths would be either project-specific or trivial. For starting a new project, follow the instruction with ocaml-dune template.

Add flake.nix to the project

1. Initialize the template from the root directory of the project:

   nix flake init github:akirak/flake-templates#ocaml-basic

   The flake.nix contains comments for adding an alternative build system such as GNU Make. If you are trying to build the project, add a required program to the development shell.

2. Add .envrc:

   use flake

3. Allow direnv:

   direnv allow

Developing

The template is basic and intended for existing projects. For development, follow instructions specific to your project.