package directories

  1. Overview
  2. Docs
An OCaml library that provides configuration, cache and data paths (and more!) following the suitable conventions on Linux, macOS and Windows

Install

Dune Dependency

Authors

Maintainers

Sources

0.4.tar.gz
sha256=74d7ebe77255b3c592b7b8777a670c2c0cbeaeb98046d1ff418951e066877834
sha512=8bb52bc9aa6197e2c5c5dcbae41c1487043b34c5a4db3cd83daabbf589a0e3b9f5049efdd0ebd4379bd6cf53c562b12890d2bc558714d27065440e67346edd7b

Description

directories is an OCaml library that provides configuration, cache and data paths (and more!) following the suitable conventions on Linux, macOS and Windows. It is inspired by similar libraries for other languages such as directories-jvm. The following conventions are used:

  • XDG Base Directory Specification and xdg-user-dirs on Linux
  • Known Folders on Windows
  • Standard Directories on macOS.

Published: 25 Nov 2021

README

directories

directories is an OCaml library that provides configuration, cache and data paths (and more!) following the suitable conventions on Linux, macOS and Windows. It is inspired by similar libraries for other languages such as directories-jvm.

The following conventions are used:

On Linux and macOS it has no dependency. On Windows, it depends only on ctypes.

Quickstart

You should depend on directories then :

let () =
  let module App_id = struct
    let qualifier = "com"
    let organization = "YourCompany"
    let application = "yourapp"
  end in
  let module M = Directories.Project_dirs (App_id) in
  let option_value = function None -> "None" | Some v -> v in
  Format.printf "cache dir  = `%s`@." (option_value M.cache_dir);
  Format.printf "config dir = `%s`@." (option_value M.config_dir);
  Format.printf "data dir   = `%s`@." (option_value M.data_dir)

For more, have a look at the example folder.

About

Dependencies (3)

  1. ctypes >= "0.17.1" & (os = "win32" | os = "cygwin")
  2. ocaml >= "4.07.0"
  3. dune >= "2.1"

Dev Dependencies

None

Conflicts

None

OCaml

Innovation. Community. Security.