package opam-lib

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

This version of the API can be used concurrently.

OPAM API.

val init : OpamTypes.repository -> OpamTypes.compiler -> OpamTypes.shell -> OpamTypes.filename -> [ `ask | `yes | `no ] -> unit

Initialize the client a consistent state.

val list : print_short:bool -> filter:[ `all | `installed | `roots | `installable ] -> order:[ `normal | `depends ] -> exact_name:bool -> case_sensitive:bool -> ?depends:OpamTypes.atom list -> ?reverse_depends:bool -> ?recursive_depends:bool -> ?resolve_depends:bool -> ?depopts:bool -> ?depexts:string list -> ?dev:bool -> string list -> unit

Display all available packages that matches any of the regexps.

val info : fields:string list -> raw_opam:bool -> where:bool -> OpamTypes.atom list -> unit

Display a general summary of a collection of packages.

val install : OpamTypes.atom list -> bool option -> bool -> unit

Install the given list of packages. Second argument, if not None, specifies that given packages should be added or removed from the roots. Third argument installs all dependencies but not the packages themselves

val reinstall : OpamTypes.atom list -> unit

Reinstall the given set of packages.

val update : repos_only:bool -> dev_only:bool -> ?no_stats:bool -> string list -> unit

Refresh the available packages.

val upgrade : OpamTypes.atom list -> unit

Find a consistent state where most of the installed packages are upgraded to their latest version, within the given constraints. An empty list means upgrade all installed packages.

val fixup : unit -> unit

Recovers from an inconsistent universe

val remove : autoremove:bool -> force:bool -> OpamTypes.atom list -> unit

Remove the given list of packages.

module CONFIG : sig ... end

Config API.

module REPOSITORY : sig ... end

Repository API

module SWITCH : sig ... end

Switch API

module PIN : sig ... end

Pin API