OPAM-INFO(1)

📦
version 2.6.1 · 8 versions
, in arch rolling, fedora 44

💖 OPAM-INFO(1) 💖

okay so this is the manual page for opam-info, which lives in the Opam Manual (yes, that's the manual name, that's the vibe) ✨ part 1 of 3, so don't go anywhere bestie, there's more coming 🫶

🌸 NAME 🌸

opam-info — it's an alias for show. that's it. that's the whole entire job description. no cap. 💅

🎀 SYNOPSIS 🎀

opam info [OPTION]… [PACKAGES]…

🦋 DESCRIPTION 🦋

so like, opam info is literally just another name for opam show. they're the same thing. the same girl, two outfits. 👑

like, if you wanna know the actual details, go read opam show --help, because that's where the real tea is. 🍓

✨ ARGUMENTS ✨

  • PACKAGES — a list of package names, and you can optionally throw a version or a constraint on them, e.g. pkg, pkg.1.0 or pkg>=0.5. OR it can be files / directory names that contain a package description, and for those you have to give the explicit directory (think ./foo.opam or .). fr fr. 🌈

💅 OPTIONS 💅

  • --all-versions — show info for all the packages that match PACKAGES, instead of being restrained to just one single package that matches the PACKAGES constraints. let her be free. 🦋
  • --empty-fields — show the fields that are empty too. and not me telling you this: it's implied whenever you pass --field. so it just comes along for the ride. 💖
  • -f FIELDS, --field=FIELDS — only show the values of these specific fields, bestie. you can pick from: name, version, package, synopsis, synopsis-or-target, description, <field>, <field>:, installed-version, pin, source-hash, opam-file, all-installed-versions, available-versions, all-versions, repository, installed-files, vc-ref, depexts. you can separate multiple ones with commas, and if you do, the field titles get printed too. and you can query the raw value of any opam-file field by combining it with --raw. iykyk 😌
  • --file=FILE (absent=-) — removed in 2.1, use --just-file instead. she's gone, she's not coming back, rip 💀
  • --just-file — load and display info from the given files (allowed PACKAGES here are file or directory paths), and it does not care about the repositories or the state of the package. this implies --raw unless --fields is used. only raw opam-file fields can be queried. and if you give no PACKAGES argument at all, it reads the opam file from stdin. main character energy, reading from stdin and all 🌟
  • --list-files — list the files that the package installed. equivalent to --field=installed-files, and heads up: it's only available for installed packages. no install, no list. 🙈
  • --no-lint — don't output linting warnings or errors when reading from files. silence is golden ✨
  • --normalise — print the values of opam fields all normalised: no newlines, no implicit brackets. tidy. clean. iconic. 🎀
  • --raw — print the raw opam file for this package. the whole thing, unfiltered. 🔥
  • --sort — sort the opam fields. alphabetical slay 💅
  • --where — print the location of the opam file used for this package. so you know where the drama is coming from. 👑

🌈 COMMON OPTIONS 🌈

these options are common to all commands, so like, they show up everywhere. periodt.

  • --best-effort — don't fail if all the requested packages can't be installed: just try to install as many as possible. note that not all external solvers may support this option (recent versions of aspcud or mccs should tho). this is equivalent to setting the $OPAMBESTEFFORT environment variable. 💪
  • --cli=MAJOR.MINOR (absent=2.6) — use the command-line interface syntax and semantics of MAJOR.MINOR. this one's intended for any persistent use of opam (scripts, blog posts, etc.) — any version of opam in the same MAJOR series will behave as it did for the specified MINOR release. the flag wasn't available in opam 2.0, so to select the 2.0 CLI, set the OPAMCLI environment variable to 2.0 instead of using this parameter. okay nostalgia 💜
  • --color=WHEN — colorize the output. WHEN has to be one of always, never or auto. pick your aesthetic 🌸
  • --confirm-level=LEVEL — confirmation level, and LEVEL must be one of ask, no, yes or unsafe-yes. can be specified more than once. if --yes or --no are also given, the value of the last --confirm-level is what counts. this is equivalent to setting $OPAMCONFIRMLEVEL. ⚠️ (unsafe-yes is literally named unsafe, bestie, tread carefully)
  • --criteria=CRITERIA — specify your user preferences for dependency solving for this run. it overrides $OPAMCRITERIA, $OPAMFIXUPCRITERIA and $OPAMUPGRADECRITERIA. for details on the supported language, and the external solvers available, see http://opam.ocaml.org/doc/External_solvers.html. and a general guide to using solver preferences lives at http://www.dicosmo.org/Articles/usercriteria.pdf. 📚
  • --cudf=FILENAME — debug option: save the CUDF requests sent to the solver to FILENAME-<n>.cudf where <n> is the n-th call to the solver during the opam run. detective mode 🔍
  • --debug — print debug messages to stderr. this is equivalent to setting $OPAMDEBUG to "true". 🙈
  • --debug-level=LEVEL — like --debug, but you get to specify the debug level (--debug just sets it to 1). equivalent to setting $OPAMDEBUG to a positive integer. dial it up 💅
  • --git-version — print the git version of opam, if it's set (i.e. you're using a development version), and exit. 🧚
  • --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. bestie behaviour fr 🫶
  • --ignore-pin-depends — ignore extra pins required by packages that get pinned, whether manually through opam pin or through opam install DIR. this is equivalent to setting IGNOREPINDEPENDS=true. 💀
  • --json=FILENAME — save the results of the opam run in a computer-readable file. if the filename contains the character %, it gets replaced by an index that doesn't overwrite an existing file. similar to setting the $OPAMJSON variable. data girlie ✨
  • --no — answer no to all opam yes/no questions without prompting. see also --confirm-level. this is equivalent to setting $OPAMNO to "true". just say no 🚫
  • --no-aspcud — removed in 2.1. she's not here anymore bestie 😭
  • --no-auto-upgrade — when configuring or updating a repository that's written for an earlier opam version (1.2), opam internally converts it to the current format. this disables that behaviour. note that repositories should define their format version in a 'repo' file at their root, or they'll be assumed to be in the older format. it is, in any case, preferable to upgrade the repositories manually using opam admin upgrade [--mirror URL] when possible. 🔧
  • --no-self-upgrade — opam will replace itself with a newer binary found at OPAMROOT/opam if present. this disables that behaviour. no glow-ups today 💅
  • -q, --quiet — disables --verbose. shhh 🤫
  • --root=ROOT — use ROOT as the current root path. this is equivalent to setting $OPAMROOT to ROOT. 🌳
  • --safe, --readonly — make sure nothing will be automatically updated or rewritten. super useful for calling from completion scripts, for example. it will fail whenever such an operation is needed; it also avoids waiting for locks, skips interactive questions and overrides the $OPAMDEBUG variable. this is equivalent to set environment variable $OPAMSAFE. look but don't touch 👀
  • --solver=CMD — specify the CUDF solver to use for resolving package installation problems. this is either a predefined solver (this version of opam supports builtin-mccs+lp(), builtin-mccs+glpk, builtin-dummy-z3-solver, builtin-0install, aspcud, mccs, aspcud-old, packup), or a custom command that should contain the variables %{input}%, %{output}%, %{criteria}%, and optionally %{timeout}%. this is equivalent to setting $OPAMEXTERNALSOLVER. solver slay 🧠
  • --strict — fail whenever an error is found in a package definition or a configuration file. the default is to continue silently if possible. glowing difference between the two ngl ✨
  • --switch=SWITCH — use SWITCH as the current compiler switch. this is equivalent to setting $OPAMSWITCH to SWITCH. flick the switch 💡
  • --use-internal-solver — disable any external solver and use the built-in one (this requires that opam has been compiled with a built-in solver). this is equivalent to setting $OPAMNOASPCUD or $OPAMUSEINTERNALSOLVER. homegrown solver energy 🏠
  • -v, --verbose — be more verbose. one -v shows all package commands, and you repeat it to also display commands called internally (e.g. tar, curl, patch etc.). repeating it n times is equivalent to setting $OPAMVERBOSE to "n". give me all the lore 📢
  • --version — show version information. 👑
  • -w, --working-dir — whenever updating packages that are bound to a local, version-controlled directory, update to the current working state of their source instead of the last committed state, or the ref they're pointing to. and because the source directory is copied as it is, if it isn't clean it may result in a opam build failure. this only affects packages explicitly listed on the command-line. it can also be set with $OPAMWORKINGDIR. ⚠️ clean your dir first bestie
  • -y, --yes — answer yes to all opam yes/no questions without prompting. see also --confirm-level. this is equivalent to setting $OPAMYES to "true". yes queen 💖

…and that's not even the whole page 👀 stay tuned 💅

🌸 ENVIRONMENT 🌸

Okay bestie, buckle up, because opam is obsessed with environment variables and there are like a million of them. opam makes use of the environment variables listed here. 💖

✨ Pro tip for the boolean ones: set them to "0", "no", "false" or just an empty string to disable them, and "1", "yes" or "true" to enable them. That's the whole vibe check. 🎀
  • OPAMALLPARENS — surround all filters with parenthesis. Yes, all of them. 🫶
  • OPAMASSUMEDEPEXTS — see option `--assume-depexts'.
  • OPAMAUTOANSWER — internal use only. Don't touch, it's not for us. 🙈
  • OPAMAUTOREMOVE — see remove option `--auto-remove'.
  • OPAMBESTEFFORT — see option `--best-effort'.
  • OPAMBESTEFFORTPREFIXCRITERIA — sets the string that must be prepended to the criteria when the --best-effort' option is set, and is expected to maximise the opam-query' property in the solution. Very demure, very mindful. 💅
  • OPAMBUILDDOC — Removed in 2.1. RIP girl, you're gone. 💀
  • OPAMBUILDTEST — Removed in 2.1. Also gone. 💀
  • OPAMCLI — see option `--cli'.
  • OPAMCOLOR — when set to always or never, sets a default value for the --color option.
  • OPAMCONFIRMLEVEL — see option --confirm-level. Heads up bestie: OPAMCONFIRMLEVEL has priority over OPAMYES and OPAMNO. 👑
  • OPAMCRITERIA — specifies user preferences for dependency solving. The default value depends on the solver version, so use config report' to find out what the current setting is. See also option --criteria`.
  • OPAMCUDFFILE — save the cudf graph to file-actions-explicit.dot.
  • OPAMCUDFTRIM — controls the filtering of unrelated packages during CUDF preprocessing.
  • OPAMCURL — can be used to select a given 'curl' program. See OPAMFETCH for more options.
  • OPAMDEBUG — see options --debug' and --debug-level'.
  • OPAMDEBUGSECTIONS — if set, limits debug messages to the space-separated list of sections. Sections can optionally have a specific debug level (for example, CLIENT:2 or CLIENT CUDF:2, but otherwise use `--debug-level'.
  • OPAMDIGDEPTH — defines how aggressive the lookup for conflicts during CUDF preprocessing is.
  • OPAMDOWNLOADJOBS — sets the maximum number of simultaneous downloads. No more chaotic parallel chaos than this number allows. ✨
  • OPAMDROPWORKINGDIR — overrides packages previously updated with --working-dir on update. Without this variable set, opam would keep them unchanged unless they're explicitly named on the command-line.
  • OPAMDRYRUN — see option `--dry-run'.
  • OPAMEDITOR — sets the editor to use for opam file editing, and it overrides $EDITOR and $VISUAL. Main character energy only. 💅
  • OPAMERRLOGLEN — sets the number of log lines printed when a sub-process fails. 0 prints all of them. All. Of. Them. 😭
  • OPAMEXTERNALSOLVER — see option `--solver'.
  • OPAMFAKE — see option `--fake'.
  • OPAMFETCH — specifies how to download files: either wget', curl' or a custom command where the variables %{url}%, %{out}%, %{retry}%, %{compress}% and %{checksum}% will be replaced. Overrides the 'download-command' value from the main config file.
  • OPAMFIXUPCRITERIA — same as OPAMUPGRADECRITERIA, but specific to fixup and reinstall. Same energy, different context. 💜
  • OPAMIGNOREAVAILABLE — see install option `--ignore-available-on'.
  • OPAMIGNORECONSTRAINTS — see install option `--ignore-constraints-on'.
  • OPAMIGNOREPINDEPENDS — see option `--ignore-pin-depends'.
  • OPAMINPLACEBUILD — see option `--inplace-build'.
  • OPAMJOBS — sets the maximum number of parallel workers to run. Go off, workers. 🔥
  • OPAMJSON — log json output to the given file (use the character % to index the files).
  • OPAMKEEPBUILDDIR — see install option `--keep-build-dir'.
  • OPAMKEEPLOGS — tells opam to not remove some temporary command logs and some backups. This skips some finalisers and may also help to get more reliable backtraces.
  • OPAMLOCKED — combination of --locked' and --lock-suffix' options.
  • OPAMLOGS — logdir sets log directory, default is a temporary directory in /tmp.
  • OPAMMAKECMD — set the system make command to use.
  • OPAMMERGEOUT — merge process outputs, stderr on stdout.
  • OPAMNO — answer no to any question asked, see options --no and --confirm-level. Careful though: OPAMNO is ignored if either OPAMCONFIRMLEVEL or OPAMYES is set. 🫣
  • OPAMNOAGGREGATE — with `opam admin check', don't aggregate packages.
  • OPAMNOASPCUD — Deprecated. Bestie, it's over. 💀
  • OPAMNOAUTOUPGRADE — disables automatic internal upgrade of repositories in an earlier format to the current one, on 'update' or 'init'.
  • OPAMNOCHECKSUMS — enables option --no-checksums when available.
  • OPAMNODEPEXTS — disables system dependencies handling, see option `--no-depexts'.
  • OPAMNOENVNOTICE — Internal. 🤫
  • OPAMNOSELFUPGRADE — see option --no-self-upgrade
  • OPAMPINKINDAUTO — sets whether version control systems should be detected when pinning to a local path. Enabled by default since 1.3.0.
  • OPAMPRECISETRACKING — fine grain tracking of directories.
  • OPAMPREPRO — set this to false to disable CUDF preprocessing. Less efficient, but might help debugging solver issues. Sometimes the messier way is the way. 🐛
  • OPAMREPOSITORYTARRING — internally store all non-vcs repositories as tar.gz files (by default, http repositories are stored as archive). This can be much faster on filesystems that don't cope well with scanning large trees. All operations are done in-memory, no I/O for scanning the repository. Literally iconic. ✨
  • OPAMREQUIRECHECKSUMS — enables option --require-checksums' when available (e.g. for opam install').
  • OPAMRETRIES — sets the number of tries before failing downloads.
  • OPAMREUSEBUILDDIR — see option `--reuse-build-dir'.
  • OPAMROOT — see option --root'. This is automatically set by opam env --root=DIR --set-root'.
  • OPAMROOTISOK — don't complain when running as root. Yes ma'am, live your truth. 👑
  • OPAMSAFE — see option `--safe'.
  • OPAMSHOW — see option `--show'.
  • OPAMSKIPUPDATE — see option `--skip-updates'.
  • OPAMSKIPVERSIONCHECKS — bypasses some version checks. Unsafe, for compatibility testing only. Do not do this casually, bestie, I'm serious. 🚨
  • OPAMSOLVERALLOWSUBOPTIMAL — (default true) allows some solvers to still return a solution when they reach timeout; while the solution remains assured to be consistent, there is no guarantee in this case that it fits the expected optimisation criteria. If true, opam will continue with a warning, if false a timeout is an error. Currently only the builtin-z3 backend handles this degraded case.
  • OPAMSOLVERTIMEOUT — change the time allowance of the solver. Default is 60.0, set to 0 for unlimited. Note that all solvers may not support this option.
  • OPAMSOLVERTOLERANCE — changes the tolerance towards the solver choosing an unoptimized solution (i.e. might pull outdated packages). Typical values range from 0.0 (best solution known to the solver) to 1.0 (unoptimized solution). Default is 0.0. This option is useful in case the solver can't find a solution in a reasonable time (see $OPAMSOLVERTIMEOUT). Note that all solvers may not support this option.
  • OPAMSTATS — Removed in 2.4. Gone but not forgotten. 🕊️
  • OPAMSTATUSLINE — display a dynamic status line showing what's currently going on on the terminal. (one of one of always, never or auto — yeah it says "one of" twice, we love her for that 💀)
  • OPAMSTRICT — fail on inconsistencies (file reading, switch import, etc.). No chaos allowed. ✋
  • OPAMSWITCH — see option --switch'. Automatically set by opam env --switch=SWITCH --set-switch'.
  • OPAMUNLOCKBASE — see install option `--unlock-base'.
  • OPAMUPGRADECRITERIA — specifies user preferences for dependency solving when performing an upgrade. Overrides OPAMCRITERIA in upgrades if both are set. See also option --criteria.
  • OPAMUSEINTERNALSOLVER — see option `--use-internal-solver'.
  • OPAMUSEOPENSSL — Removed in 2.2. Another one bites the dust. 💀
  • OPAMUTF8 — use UTF8 characters in output (one of one of always, never or auto). By default auto, which is determined from the locale). 🌈
  • OPAMUTF8MSGS — use extended UTF8 characters (camels) in opam messages. 🐫 Implies OPAMUTF8. This is set by default on macOS only.
  • OPAMVALIDATIONHOOK — if set, uses the %{hook}% command to validate an opam repository update.
  • OPAMVERBOSE — see option `--verbose'.
  • OPAMVERBOSEON — see option --verbose-on
  • OPAMVERSIONLAGPOWER — do not use. That's it. That's the whole description. 🙅
  • OPAMWITHDEVSETUP — see install option `--with-dev-setup'.
  • OPAMWITHDOC — see install option `--with-doc'.
  • OPAMWITHTEST — see install option `--with-test.
  • OPAMWORKINGDIR — see option `--working-dir'.
  • OPAMYES — see options --yes' and --confirm-level. **OPAMYEShas priority overOPAMNOand is ignored ifOPAMCONFIRMLEVEL` is set.**
  • OPAMVAR_var — overrides the contents of the variable var when substituting %{var}% strings in opam files.
  • OPAMVAR_package_var — overrides the contents of the variable package:var when substituting %{package:var}% strings in opam files.

🦋 CLI VERSION 🦋

OK this section is short but it's important, so listen up bestie. 👂

All scripts and programmatic invocations of opam should use `--cli' in order to ensure that they work seamlessly with future versions of the opam client. Plus, blog posts or other documentation can benefit too, because it prevents information from becoming stale. Future-proofing? We love to see it. 👑

Although opam only supports roots (~/.opam/) for the current version, it does provide backwards compatibility for its command-line interface. Sweet of her tbh. 🫶

Since CLI version support was only added in opam 2.1, use OPAMCLI to select 2.0 support (as opam 2.0 will just ignore it), and --cli=2.1' for 2.1 (or later) versions — because an environment variable controlling the parsing of syntax is brittle. To this end, opam displays a warning if OPAMCLI specifies a valid version other than 2.0, and also if --cli=2.0' is specified. She's calling you out, gently. 🎀

The command-line version is selected by using the --cli' option or the OPAMCLIenvironment variable.--cli' may be specified more than once, where the last instance takes precedence. OPAMCLI is only inspected if `--cli' is not given. ✨

💥 EXIT STATUS 💥

okay so this is the part where opam tells you why it's leaving, and bestie, the numbers MATTER. Remember: it's not just "it broke" — every number is a whole mood, and you gotta read the number to know what's up. 🔍

🚨 ONE HUGE EXCEPTION THO: the exec command plays by its own rules. exec returns 127 if the command wasn't found or couldn't be executed, and otherwise it just gives you the command's own exit value. Not opam's. The command's. periodt.
  • 0 — Success ✨ or, for boolean queries, true.
  • 1 — False. It comes back when a boolean return value is expected, like when you're running with --check, or for queries such as opam lint.
  • 2 — Bad command-line arguments 🙈 — or command-line arguments that point at an invalid context (say, a file that doesn't follow the expected format).
  • 5 — Not found. You asked for something (a package, a version, a repository, whatever) and it genuinely isn't there. 💀
  • 10 — Aborted. The operation needed confirmation, and confirmation was not given.
  • 15 — Couldn't get the locks required for the operation. 🔒
  • 20 — No solution to what you asked for. Like, imagine requesting two incompatible packages — yeah, that. 😭
  • 30 — Error in a package definition, or in other metadata files. Using --strict makes this one show up way more often.
  • 31 — Package script error. Some package operations were unsuccessful. Could be a problem in the packages themselves, or an incompatibility with your system. Heads up: this one can be a partial error.
  • 40 — Sync error. Some remotes couldn't be fetched from the network. Also can be a partial error. 📡
  • 50 — Configuration error. Opam or your system config doesn't allow the operation, and it needs fixing before you can move on.
  • 60 — Solver failure. The solver couldn't return a sound answer. Could be a broken external solver, or an error in the solver configuration. 🧠💥
  • 99 — Internal error. Something went wrong, and it's most likely a bug in opam itself. not opam catching strays, it said it itself.
  • 130 — User interrupt. SIGINT was received, which is generally what happens when you press Ctrl+C. 🛑

and then there's this other little batch of codes, also just vibing here:

  • 0 — on success.
  • 123 — on indiscriminate errors reported on standard error.
  • 124 — on command line parsing errors.
  • 125 — on unexpected internal errors (bugs).

📚 FURTHER DOCUMENTATION 📚

the extra reading exists, bestie: https://opam.ocaml.org/doc</p> — go, read, slay. 💅

👑 AUTHORS 👑

okay so these are the actual legends who built this thing, give them their flowers fr fr 🫶🌸:

  • David Allsopp <david@tarides.com>
  • Vincent Bernardoff <vb@luminar.eu.org>
  • Raja Boujbel <raja.boujbel@ocamlpro.com>
  • Kate Deplaix <kit-ty-kate@exn.st>
  • Roberto Di Cosmo <roberto@dicosmo.org>
  • Thomas Gazagnaire <thomas@gazagnaire.org>
  • Louis Gesbert <louis.gesbert@ocamlpro.com>
  • Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
  • Anil Madhavapeddy <anil@recoil.org>
  • Guillem Rieu <guillem.rieu@ocamlpro.com>
  • Ralf Treinen <ralf.treinen@pps.jussieu.fr>
  • Frederic Tuong <tuong@users.gforge.inria.fr>

🌈 SEE ALSO 🌈

  • opam(1) — the main character herself, obviously iykyk 💜✨

🐛 BUGS 🐛

found something cursed? the bug reports live at https://github.com/ocaml/opam/issues — go check 'em there, don't suffer in silence babe 💖

and that's a wrap on OPAM-INFO(1), brought to you by Opam 2.6.1 🎀 go forth, read your exit codes, and remember: the vibe check is eternal 🦋⭐🏆

📦 where this page comes from