package opam-client

  1. Overview
  2. Docs
Client library for opam 2.0

Install 

dune-project
 Dependency

opam.ocaml.org Readme Edit opam file Versions (29)

Authors

  1. V
    Vincent Bernardoff <vb@luminar.eu.org>
  2. R
    Raja Boujbel <raja.boujbel@ocamlpro.com>
  3. R
    Roberto Di Cosmo <roberto@dicosmo.org>
  4. T
    Thomas Gazagnaire <thomas@gazagnaire.org>
  5. L
    Louis Gesbert <louis.gesbert@ocamlpro.com>
  6. F
    Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
  7. A
    Anil Madhavapeddy <anil@recoil.org>
  8. G
    Guillem Rieu <guillem.rieu@ocamlpro.com>
  9. R
    Ralf Treinen <ralf.treinen@pps.jussieu.fr>
  10. F
    Frederic Tuong <tuong@users.gforge.inria.fr>

Maintainers

  1. O
    opam-devel@lists.ocaml.org

Sources

2.0.6.tar.gz
md5=4412f3af8f0af354dcd8519ba8f30ee5
sha512=c3dbd315550817d15e3d5dd4b5b030b725e5d65e36450f8ac064555e4710bda90df6fab457c386c7a334689e50d240de19992565ce325bc8a18163f145f09dfd

doc/opam-client/OpamClient/index.html

Module OpamClientSource

High-level execution of user-facing functions like install and upgrade, and wrappers around the pinning commands

Sourceval init : init_config:OpamFile.InitConfig.t -> interactive:bool -> ?repo:OpamTypes.repository -> ?bypass_checks:bool -> ?dot_profile:OpamTypes.filename -> ?update_config:bool -> ?env_hook:bool -> ?completion:bool -> OpamTypes.shell -> OpamStateTypes.rw OpamStateTypes.global_state * OpamStateTypes.unlocked OpamStateTypes.repos_state * OpamTypes.formula

Initialize the client to a consistent state.

Sourceval reinit : ?init_config:OpamFile.InitConfig.t -> interactive:bool -> ?dot_profile:OpamTypes.filename -> ?update_config:bool -> ?env_hook:bool -> ?completion:bool -> OpamFile.Config.t -> OpamTypes.shell -> unit

Re-runs the extra tools checks, updates the configuration from init_config (defaults to OpamInitDefaults.init_config) for the settings that are unset, and updates all repositories

Sourceval install : OpamStateTypes.rw OpamStateTypes.switch_state -> ?autoupdate:OpamTypes.atom list -> ?add_to_roots:bool -> ?deps_only:bool -> ?assume_built:bool -> OpamTypes.atom list -> OpamStateTypes.rw OpamStateTypes.switch_state

Install the given list of packages. add_to_roots, if given, specifies that given packages should be added or removed from the roots. autoupdate defaults to the list of atoms, and can be used to restrict the atoms which are updated if pinned.

Sourceval install_t : OpamStateTypes.rw OpamStateTypes.switch_state -> ?ask:bool -> OpamTypes.atom list -> bool option -> deps_only:bool -> assume_built:bool -> OpamStateTypes.rw OpamStateTypes.switch_state

Low-level version of reinstall, bypassing the package name sanitization and dev package update, and offering more control

Sourceval reinstall : OpamStateTypes.rw OpamStateTypes.switch_state -> ?assume_built:bool -> OpamTypes.atom list -> OpamStateTypes.rw OpamStateTypes.switch_state

Reinstall the given set of packages.

Sourceval reinstall_t : OpamStateTypes.rw OpamStateTypes.switch_state -> ?ask:bool -> ?force:bool -> assume_built:bool -> OpamTypes.atom list -> OpamStateTypes.rw OpamStateTypes.switch_state

Low-level version of reinstall, bypassing the package name sanitization and dev package update, and offering more control

Sourceval update : 'a OpamStateTypes.global_state -> repos_only:bool -> dev_only:bool -> ?all:bool -> string list -> bool * bool * OpamStateTypes.unlocked OpamStateTypes.repos_state

Update the local mirrors for the repositories and/or development packages. Returns (success, changes, rt), where success is true only if all updates were successful, changes is true if any upstream had updates, and rt is the updated repository state.

Sourceval upgrade : OpamStateTypes.rw OpamStateTypes.switch_state -> ?check:bool -> all:bool -> OpamTypes.atom list -> OpamStateTypes.rw OpamStateTypes.switch_state

Upgrade the switch, that is, move packages to their more recent available versions. The specified atoms are kept installed (or newly installed after a confirmation). The upgrade concerns them only unless all is specified.

Sourceval upgrade_t : ?strict_upgrade:bool -> ?auto_install:bool -> ?ask:bool -> ?check:bool -> ?terse:bool -> all:bool -> OpamTypes.atom list -> OpamStateTypes.rw OpamStateTypes.switch_state -> OpamStateTypes.rw OpamStateTypes.switch_state

Low-level version of upgrade, bypassing the package name sanitization and dev package update, and offering more control. terse avoids the verbose message when we are at a local maximum, but there are possible upgrades

Recovers from an inconsistent universe

Sourceval remove : OpamStateTypes.rw OpamStateTypes.switch_state -> autoremove:bool -> force:bool -> OpamTypes.atom list -> OpamStateTypes.rw OpamStateTypes.switch_state

Remove the given list of packages.

Sourcemodule PIN : sig ... end