Skip to content

Latest commit

 

History

History
87 lines (59 loc) · 2.55 KB

README.md

File metadata and controls

87 lines (59 loc) · 2.55 KB

duniverse -- the spice of OCaml build life

This is an experimental vendoring system for Dune. Not for public consumption just yet.

Please see the manual pages for an explanation of how to use the tool:

Contact @avsm if you have any queries.

Manual Pages

duniverse

NAME
       duniverse - the spice of build life

SYNOPSIS
       duniverse COMMAND ...

DESCRIPTION
       The duniverse tool provides a convenient interface to bridge the opam
       package manager with having a local copy of all the source code
       required to build a project using the dune build tool.

       It works by analysing opam package metadata and calculating a set of
       git tags that can be cloned into the local repository into a
       duniverse/ subdirectory. Once the external code has been pulled into
       the repository, a single dune build command is sufficient to build the
       whole project in a standalone fashion, without opam being required.
       This is a particularly convenient way of publishing CLI tools to users
       who do not need the full power of opam.

       You can access the functionality directly via the duniverse-init,
       duniverse-opam-install and duniverse-pull commands,

       Also see https://github.com/avsm/platform for an example of a fully
       bootstrapping use of this tool.

COMMANDS
       depext
           print external packages required to build this duniverse

       init
           analyse opam files to generate an initial dune-get

       opam-install
           install packages that are not duniverse-compatible via opam

       pin Add a pinned package dependency to dune-get

       print-ocaml-compilers
           print OCaml compilers that are supported for this duniverse

       pull
           fetch the latest archives of the vendored libraries

       tools
           Make all the tools needed to build the project available

       unpin
           Remove a pinned package dependency from dune-get

       update
           update the commit hash corresponding to the tracked branch/tag for
           each source dependency

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.

SEE ALSO
       dune(1), git(1), opam(1)