package bos

  1. Overview
  2. Docs
Basic OS interaction for OCaml

Install

Dune Dependency

Authors

Maintainers

Sources

bos-0.1.0.tbz
md5=2c2999b01ab5a545dbb4c416e1d20583

Description

Bos provides support for basic and robust interaction with the operating system in OCaml. It has functions to access the process environment, parse command line arguments, interact with the file system and run command line programs.

Bos works equally well on POSIX and Windows operating systems.

Bos depends on Rresult, Astring, Fmt, Fpath and Logs and the OCaml Unix library. It is distributed under the ISC license.

README

Bos — Basic OS interaction for OCaml

v0.1.0

Bos provides support for basic and robust interaction with the operating system in OCaml. It has functions to access the process environment, parse command line arguments, interact with the file system and run command line programs.

Bos works equally well on POSIX and Windows operating systems.

Bos depends on Rresult, Astring, Fmt, Fpath and Logs and the OCaml Unix library. It is distributed under the ISC license.

Home page: http://erratique.ch/software/bos
Contact: Daniel Bünzli <daniel.buenzl i@erratique.ch>

Installation

Bos can be installed with opam:

opam install bos

If you don't use opam consult the opam file for build instructions.

Documentation

The documentation and API reference is automatically generated by ocamldoc from the interfaces. It can be consulted online and there is a generated version in the doc directory of the distribution.

Sample programs

If you installed Bos with opam sample programs are located in the directory opam config var bos:doc.

In the distribution sample programs are located in the test directory of the distribution. They can be built with:

ocamlbuild -use-ocamlfind test/tests.otarget

The resulting binaries are in _build/test.

  • test.native tests the library, nothing should fail.