package opam-client

  1. Overview
  2. Docs
Client library for opam 2.1

Install

Dune Dependency

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

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.1.6.tar.gz
md5=6f69e91a0535297272127e184c314272
sha512=f75d81b4eb19ef6603e7a2a18e1a281ea6f5eea47b820ae888593102db5b98ded5b593b176e70235611b63a07f4a406a57fe016386f4e921f51b55eb62b9864d

doc/opam-client/OpamArg/index.html

Module OpamArgSource

Command-line argument parsers and helpers

Helpers and argument constructors

CLI versioning

Sourcetype validity
Sourceval cli_between : OpamCLIVersion.t -> ?default:bool -> ?replaced:string -> OpamCLIVersion.t -> validity
Sourceval cli_original : validity

Common helphers

Sourceval mk_flag : cli:OpamCLIVersion.Sourced.t -> validity -> ?section:string -> string list -> string -> bool Cmdliner.Term.t
Sourceval mk_flag_replaced : cli:OpamCLIVersion.Sourced.t -> ?section:string -> (validity * string list) list -> string -> bool Cmdliner.Term.t
Sourceval mk_opt : cli:OpamCLIVersion.Sourced.t -> validity -> ?section:string -> ?vopt:'a -> string list -> string -> string -> 'a Cmdliner.Arg.converter -> 'a -> 'a Cmdliner.Term.t
Sourceval mk_opt_all : cli:OpamCLIVersion.Sourced.t -> validity -> ?section:string -> ?vopt:'a -> ?default:'a list -> string list -> string -> string -> 'a Cmdliner.Arg.converter -> 'a list Cmdliner.Term.t
Sourceval mk_vflag : cli:OpamCLIVersion.Sourced.t -> ?section:string -> 'a -> (validity * 'a * string list * string) list -> 'a Cmdliner.Term.t
Sourceval mk_vflag_all : cli:OpamCLIVersion.Sourced.t -> ?section:string -> ?default:'a list -> (validity * 'a * string list * string) list -> 'a list Cmdliner.Term.t
Sourceval dir_sep : string
Sourceval escape_path : string -> string

Flags

Sourceval print_short_flag : OpamCLIVersion.Sourced.t -> validity -> bool Cmdliner.Term.t

--short

Sourceval shell_opt : OpamCLIVersion.Sourced.t -> validity -> OpamTypes.shell option Cmdliner.Term.t

--shell

Sourceval dot_profile_flag : OpamCLIVersion.Sourced.t -> validity -> OpamTypes.filename option Cmdliner.Term.t

--dot-profile

Sourceval repo_kind_flag : OpamCLIVersion.Sourced.t -> validity -> OpamUrl.backend option Cmdliner.Term.t

--http/ --git/ --local

--jobs

Sourceval name_list : OpamTypes.name list Cmdliner.Term.t

package names

Sourceval param_list : string list Cmdliner.Term.t

parameters

Sourceval atom_list : OpamFormula.atom list Cmdliner.Term.t

package list with optional constraints

Sourceval nonempty_atom_list : OpamFormula.atom list Cmdliner.Term.t

package list with optional constraints

Sourceval atom_or_local_list : [ `Atom of OpamTypes.atom | `Filename of OpamTypes.filename | `Dirname of OpamTypes.dirname ] list Cmdliner.Term.t
Sourceval atom_or_dir_list : [ `Atom of OpamTypes.atom | `Dirname of OpamTypes.dirname ] list Cmdliner.Term.t
Sourceval arg_list : string -> string -> 'a Cmdliner.Arg.converter -> 'a list Cmdliner.Term.t

Generic argument list builder

Sourceval nonempty_arg_list : string -> string -> 'a Cmdliner.Arg.converter -> 'a list Cmdliner.Term.t

Generic argument list builder

Sourceval confirm_enum : (validity * string * OpamStd.Config.answer) list

Confirmation level enum

Global options

Sourcetype global_options = {
  1. debug_level : int option;
  2. verbose : int;
  3. quiet : bool;
  4. color : OpamStd.Config.when_ option;
  5. opt_switch : string option;
  6. confirm_level : OpamStd.Config.answer option;
  7. yes : bool option;
  8. strict : bool;
  9. opt_root : OpamTypes.dirname option;
  10. git_version : bool;
  11. external_solver : string option;
  12. use_internal_solver : bool;
  13. cudf_file : string option;
  14. solver_preferences : string option;
  15. best_effort : bool;
  16. safe_mode : bool;
  17. json : string option;
  18. no_auto_upgrade : bool;
  19. working_dir : bool;
  20. ignore_pin_depends : bool;
  21. cli : OpamCLIVersion.t;
}

Type for global options

Global options

Sourceval apply_global_options : OpamCLIVersion.Sourced.t -> global_options -> unit

Apply global options

Build options

Sourcetype build_options

Abstract type for build options

Sourceval man_build_option_section : Cmdliner.Manpage.block list

Build options

Install and reinstall options

Sourceval subpath : OpamCLIVersion.Sourced.t -> string option Cmdliner.Term.t
Sourceval apply_build_options : OpamCLIVersion.Sourced.t -> build_options -> unit

Applly build options

Sourceval locked : ?section:string -> OpamCLIVersion.Sourced.t -> bool Cmdliner.Term.t

Lock options

Sourceval lock_suffix : ?section:string -> OpamCLIVersion.Sourced.t -> string Cmdliner.Term.t

Package listing and filtering options

Sourceval package_selection_section : string

Man section name

Build a package selection filter

Sourceval package_listing_section : string

Man section name

Sourceval package_listing : OpamCLIVersion.Sourced.t -> (force_all_versions:bool -> OpamListCommand.package_listing_format) Cmdliner.Term.t

Package selection filter based on the current state of packages (installed, available, etc.)

Converters

Sourceval repository_name : OpamTypes.repository_name Cmdliner.Arg.converter

Repository name converter

Sourceval url : OpamTypes.url Cmdliner.Arg.converter

URL converter

Sourceval filename : OpamTypes.filename Cmdliner.Arg.converter

Filename converter

Sourceval existing_filename_or_dash : OpamTypes.filename option Cmdliner.Arg.converter

Filename converter also accepting "-" for stdin/stdout

Sourceval dirname : OpamTypes.dirname Cmdliner.Arg.converter

Dirnam converter

Sourceval existing_filename_dirname_or_dash : OpamFilename.generic_file option Cmdliner.Arg.converter
Sourceval positive_integer : int Cmdliner.Arg.converter
Sourceval package_name : OpamTypes.name Cmdliner.Arg.converter

Package name converter

Sourceval package_version : OpamTypes.version Cmdliner.Arg.converter

Package version converter

Sourceval package : (OpamTypes.name * OpamTypes.version option) Cmdliner.Arg.converter

name{.version} (or name=version)

Sourceval package_with_version : OpamTypes.package Cmdliner.Arg.converter

name.version (or name=version)

Sourceval atom : OpamTypes.atom Cmdliner.Arg.converter

name{(.|=|!=|>|<|>=|<=)version} converter

Sourceval atom_or_local : [ `Atom of OpamTypes.atom | `Filename of OpamTypes.filename | `Dirname of OpamTypes.dirname ] Cmdliner.Arg.converter

Accepts atom but also (explicit) file and directory names

Sourceval atom_or_dir : [ `Atom of OpamTypes.atom | `Dirname of OpamTypes.dirname ] Cmdliner.Arg.converter
Sourceval dep_formula : OpamTypes.formula Cmdliner.Arg.converter

Formula, in the same format as depends: in opam files

Sourceval variable_bindings : (OpamVariable.t * string) list Cmdliner.Arg.converter

var=value,... argument

Sourceval warn_selector : (int * bool) list Cmdliner.Arg.converter

Warnings string "+3..10-4"

Subcommands

Sourcetype 'a subcommand = validity * string * 'a * string list * string

A subcommand cmds, v, args, doc is the subcommand cmd, using the documentation doc and the list of documentation parameters args. If the subcommand is selected, return v value.

Sourcetype 'a subcommands = 'a subcommand list
Sourceval mk_subcommands : cli:OpamCLIVersion.Sourced.t -> 'a subcommands -> 'a option Cmdliner.Term.t * string list Cmdliner.Term.t

subcommands cmds are the terms cmd and params. cmd parses which sub-commands in cmds is selected and params parses the remaining of the command-line parameters as a list of strings.

Sourcetype 'a default = [> `default of string ] as 'a
Sourceval mk_subcommands_with_default : cli:OpamCLIVersion.Sourced.t -> 'a default subcommands -> 'a option Cmdliner.Term.t * string list Cmdliner.Term.t

Same as mk_subcommand but use the default value if no sub-command is selected.

Sourceval bad_subcommand : cli:OpamCLIVersion.Sourced.t -> 'a default subcommands -> (string * 'a option * string list) -> 'b Cmdliner.Term.ret

bad_subcommand cmds cmd is a command return value denoting a parsing error of sub-commands.

Sourceval mk_subdoc : cli:OpamCLIVersion.Sourced.t -> ?defaults:(string * string) list -> 'a subcommands -> Cmdliner.Manpage.block list

mk_subdoc cmds is the documentation block for cmds.

Sourceval make_command_alias : cli:OpamCLIVersion.Sourced.t -> ('a Cmdliner.Term.t * Cmdliner.Term.info) -> ?options:string -> string -> 'a Cmdliner.Term.t * Cmdliner.Term.info

Create an alias for an existing command. options can be used to add extra options after the original command in the doc (eg like `unpin` is an alias for `pin remove`).

Commands

Sourceval mk_command : cli:OpamCLIVersion.Sourced.t -> validity -> string -> doc:string -> man:Cmdliner.Manpage.block list -> (unit -> unit) Cmdliner.Term.t -> command
Sourceval mk_command_ret : cli:OpamCLIVersion.Sourced.t -> validity -> string -> doc:string -> man:Cmdliner.Manpage.block list -> (unit -> unit Cmdliner.Term.ret) Cmdliner.Term.t -> command

Documentation

Sourceval global_option_section : string

Environment variables

Sourceval preinit_opam_env_variables : unit -> unit
Sourceval init_opam_env_variabes : OpamCLIVersion.Sourced.t -> unit
Sourceval scrubbed_environment_variables : string list
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct