OPAM-ADMIN-LINT(1)

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

💖 OPAM ADMIN-LINT 💖

okay bestie, welcome to OPAM ADMIN-LINT — straight out of the Opam admin Manual ✨ this is the one that runs opam lint all over a whole repo and spills ALL the tea. let's get into it 🫶

🌸 NAME 🌸

opam admin-lint — runs opam lint and reports on a whole repository 💅 no cap, the entire thing.

✨ SYNOPSIS ✨

opam admin lint [OPTION]… [INT]…

🦋 DESCRIPTION 🦋

so basically? this command gathers linting results on all files in a repository 🌈 it goes through everything and collects the receipts.

and you get to pick which warnings and errors to show or hide — the selection is yours, main character 💅

🎀 ARGUMENTS 🎀

  • INT — show only these warnings, bestie. that's it, that's the whole vibe.

💖 OPTIONS 💖

  • -i INT, --ignore-packages=INT — ignore any packages having one of these warnings or errors 🙈 like, we're not looking at those today.
  • -l, --list — only list package names, without warning details 📋 just the names, no extra commentary.
  • -s, --short — print only packages and warning/error numbers, without explanations ✨ short and sweet, exactly the energy.
  • -W, --warn-error — return failure on any warnings, not only on errors 💀 yeah, it's strict-strict.
  • -x INT, --exclude=INT — exclude the given warnings or errors 🚫 out of sight, out of mind.

👑 COMMON OPTIONS 👑

these options are common to all commands. universal icons only 💫

  • --best-effort — don't fail if all requested packages can't be installed: try to install as many as possible 🫶 note that not all external solvers may support this option (recent versions of aspcud or mccs should). 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 ⭐ intended for any persistent use of opam (scripts, blog posts, etc.), any version of opam in the same MAJOR series will behave as for the specified MINOR release. the flag was not 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.
  • --color=WHEN — colorize the output 🌈 WHEN must be one of always, never or auto.
  • --confirm-level=LEVEL — confirmation level, 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 taken into account. this is equivalent to setting $OPAMCONFIRMLEVEL.
  • --criteria=CRITERIA — specify user preferences for dependency solving for this run 🧚 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. a general guide to using solver preferences can be found 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 🔍
  • --debug — print debug message to stderr. this is equivalent to setting $OPAMDEBUG to "true" 🐛
  • --debug-level=LEVEL — like --debug, but allows specifying the debug level (--debug sets it to 1). equivalent to setting $OPAMDEBUG to a positive integer.
  • --git-version — print the git version of opam, if set (i.e. you are 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.
  • --ignore-pin-depends — ignore extra pins required by packages that get pinned, either 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 will be replaced by an index that doesn't overwrite an existing file. similar to setting the $OPAMJSON variable.
  • --no — answer no to all opam yes/no questions without prompting 🙅‍♀️ see also --confirm-level. this is equivalent to setting $OPAMNO to "true".
  • --no-aspcud — removed in 2.1 ⚰️ (gone, bestie, she's not coming back)
  • --no-auto-upgrade — when configuring or updating a repository that is written for an earlier opam version (1.2), opam internally converts it to the current format. this disables this behaviour. note that repositories should define their format version in a repo file at their root, or they will 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 🛠️
  • -q, --quiet — disables --verbose 🤫
  • --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 🔒 useful for calling from completion scripts, for example. will fail whenever such an operation is needed; also avoids waiting for locks, skips interactive questions and overrides the $OPAMDEBUG variable. this is equivalent to set environment variable $OPAMSAFE.
  • --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.
  • --strict — fail whenever an error is found in a package definition or a configuration file 💀 the default is to continue silently if possible.
  • --switch=SWITCH — use SWITCH as the current compiler switch. this is equivalent to setting $OPAMSWITCH to 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.
  • -v, --verbose — be more verbose 📢 one -v shows all package commands, repeat to also display commands called internally (e.g. tar, curl, patch etc.). repeating n times is equivalent to setting $OPAMVERBOSE to "n".
  • --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 are pointing to. as source directory is copied as it is, if it isn't clean it may result on a opam build failure 😭 this only affects packages explicitly listed on the command-line. it can also be set with $OPAMWORKINGDIR.
  • -y, --yes — answer yes to all opam yes/no questions without prompting ✅ see also --confirm-level. this is equivalent to setting $OPAMYES to "true".
💖 ok that's part 1 bestie, more incoming — don't go anywhere 🌸

🌈 ENVIRONMENT 🌈

Bestie, opam is so into environment variables, like it has a whole vibe board of them. Here's the full tea ☕ — every single one.

Quick rule before we dive in: boolean variables need to be set to "0", "no", "false" or the empty string to disable them, and "1", "yes" or "true" to enable them. That's the whole vibe check right there. 💅

  • OPAMALLPARENS — wraps every single filter in parentheses. Yes, all of them. Every last one. 🫶
  • OPAMASSUMEDEPEXTS — peek at the option --assume-depexts.
  • OPAMAUTOANSWER — internal use only, bestie, not for us mere mortals. 🙈
  • OPAMAUTOREMOVE — see the remove option --auto-remove.
  • OPAMBESTEFFORT — see the option --best-effort.
  • OPAMBESTEFFORTPREFIXCRITERIA — sets the string that must be prepended to the criteria when the --best-effort option is set, and it's expected to maximise the opam-query property in the solution. Very specific, very slay. ✨
  • OPAMBUILDDOC — Removed in 2.1. Gone, bestie. 💀
  • OPAMBUILDTEST — Removed in 2.1. Also gone. 😭
  • OPAMCLI — see the option --cli.
  • OPAMCOLOR — when set to always or never, it sets a default value for the --color option.
  • OPAMCONFIRMLEVEL — see the option --confirm-level. And heads up: OPAMCONFIRMLEVEL has priority over OPAMYES and OPAMNO. It's the main character here. 👑
  • OPAMCRITERIA — specifies your user preferences for dependency solving. The default value depends on the solver version, so run config report to find out what the current setting actually is. See also the option --criteria.
  • OPAMCUDFFILE — saves the cudf graph to the file 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 the 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 it uses --debug-level.
  • OPAMDIGDEPTH — defines how aggressive the lookup for conflicts during CUDF preprocessing is. Going feral, basically. 🔥
  • OPAMDOWNLOADJOBS — sets the maximum number of simultaneous downloads.
  • 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 the option --dry-run.
  • OPAMEDITOR — sets the editor to use for opam file editing. It overrides $EDITOR and $VISUAL.
  • OPAMERRLOGLEN — sets the number of log lines printed when a sub-process fails. Set it to 0 to print all of them. All. Every line. 🫣
  • OPAMEXTERNALSOLVER — see the option --solver.
  • OPAMFAKE — see the 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. It overrides the 'download-command' value from the main config file.
  • OPAMFIXUPCRITERIA — same as OPAMUPGRADECRITERIA, but specific to fixup and reinstall.
  • OPAMIGNOREAVAILABLE — see the install option --ignore-available-on.
  • OPAMIGNORECONSTRAINTS — see the install option --ignore-constraints-on.
  • OPAMIGNOREPINDEPENDS — see the option --ignore-pin-depends.
  • OPAMINPLACEBUILD — see the option --inplace-build.
  • OPAMJOBS — sets the maximum number of parallel workers to run.
  • OPAMJSON — logs json output to the given file (use the character % to index the files).
  • OPAMKEEPBUILDDIR — see the 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 the --locked and --lock-suffix options.
  • OPAMLOGS — logdir, sets the 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 the options --no and --confirm-level. Also OPAMNO is ignored if either OPAMCONFIRMLEVEL or OPAMYES is set. Know your place, OPAMNO. 💅
  • OPAMNOAGGREGATE — with opam admin check, don't aggregate packages.
  • OPAMNOASPCUD — Deprecated. Old news, bestie.
  • 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 the option --no-depexts.
  • OPAMNOENVNOTICE — Internal.
  • OPAMNOSELFUPGRADE — see the 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 with debugging solver issues.
  • 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. Chef's kiss efficiency. 🎀
  • OPAMREQUIRECHECKSUMS — enables the option --require-checksums when available (e.g. for opam install).
  • OPAMRETRIES — sets the number of tries before failing downloads.
  • OPAMREUSEBUILDDIR — see the option --reuse-build-dir.
  • OPAMROOT — see the option --root. This is automatically set by opam env --root=DIR --set-root.
  • OPAMROOTISOK — don't complain when running as root.
  • OPAMSAFE — see the option --safe.
  • OPAMSHOW — see the option --show.
  • OPAMSKIPUPDATE — see the option --skip-updates.
  • OPAMSKIPVERSIONCHECKS — bypasses some version checks. Unsafe, for compatibility testing only. Don't do it casually, bestie, I'm begging. 😭
  • 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 not all solvers may support this option.
  • OPAMSOLVERTOLERANCE — changes the tolerance towards the solver choosing an unoptimized solution (i.e. it 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 not all solvers may support this option.
  • OPAMSTATS — Removed in 2.4. RIP. 💀
  • OPAMSTATUSLINE — display a dynamic status line showing what's currently going on on the terminal. (one of one of always, never or auto)
  • OPAMSTRICT — fail on inconsistencies (file reading, switch import, etc.).
  • OPAMSWITCH — see the option --switch. Automatically set by opam env --switch=SWITCH --set-switch.
  • OPAMUNLOCKBASE — see the install option --unlock-base.
  • OPAMUPGRADECRITERIA — specifies your user preferences for dependency solving when performing an upgrade. Overrides OPAMCRITERIA in upgrades if both are set. See also the option --criteria.
  • OPAMUSEINTERNALSOLVER — see the option --use-internal-solver.
  • OPAMUSEOPENSSL — Removed in 2.2. Bye. 🦋
  • OPAMUTF8 — use UTF8 characters in output (one of one of always, never or auto). By default it's 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 the option --verbose.
  • OPAMVERBOSEON — see the option --verbose-on.
  • OPAMVERSIONLAGPOWER — do not use. That's it. That's the instruction. 🚫
  • OPAMWITHDEVSETUP — see the install option --with-dev-setup.
  • OPAMWITHDOC — see the install option --with-doc.
  • OPAMWITHTEST — see the install option --with-test.
  • OPAMWORKINGDIR — see the option --working-dir.
  • OPAMYES — see the options --yes and --confirm-level. OPAMYES has priority over OPAMNO and is ignored if OPAMCONFIRMLEVEL is set. It's giving "yes to everything" energy. 👑
  • 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 ⭐

Okay this part is important, so listen up bestie. 🫶

All scripts and programmatic invocations of opam should use --cli, so they keep working seamlessly with future versions of the opam client. And it's not just for scripts — blog posts and other documentation can benefit too, because it prevents information from becoming stale. Literally aging-proofing your docs. ✨

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

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, since 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. So it's clapping back at you, gently. 🙈

The command-line version is selected by using the --cli option or the OPAMCLI environment variable. --cli may be specified more than once, where the last instance takes precedence. OPAMCLI is only inspected if --cli is not given. Last one wins, always. 💅

💀 EXIT STATUS 💀

okay bestie, listen up, because this part is IMPORTANT. ✨

real talk first: as an exception to literally everything below, the exec command returns 127 if the command was not found or couldn't be executed, and the command's exit value otherwise. that one's the odd one out, no cap. 🙈
  • 0 — Success, or true for boolean queries. 💚
  • 1 — False. Returned when a boolean return value is expected, e.g. when running with --check, or for queries like opam lint.
  • 2 — Bad command-line arguments, or command-line arguments pointing to an invalid context (e.g. file not following the expected format). the vibes were off from the start 😭
  • 5 — Not found. You requested something (package, version, repository, etc.) that couldn't be found. it's giving "who??" 🕵️
  • 10 — Aborted. The operation required confirmation, which wasn't given. you said no (or said nothing) 💅
  • 15 — Could not acquire the locks required for the operation. 🔒
  • 20 — There is no solution to the user request. This can be caused by asking to install two incompatible packages, for example. they cannot both be the main character 💀
  • 30 — Error in package definition, or other metadata files. Using --strict raises this error more often. ✋
  • 31 — Package script error. Some package operations were unsuccessful. This may be an error in the packages or an incompatibility with your system. This can be a partial error.
  • 40 — Sync error. Could not fetch some remotes from the network. This can be a partial error. the wifi said no 📡
  • 50 — Configuration error. Opam or system configuration doesn't allow operation, and needs fixing. 🛠️
  • 60 — Solver failure. The solver failed to return a sound answer. It can be due to a broken external solver, or an error in solver configuration. the solver is NOT slaying today 😭
  • 99 — Internal error. Something went wrong, likely due to a bug in opam itself. 🐛
  • 130 — User interrupt. SIGINT was received, generally due to the user pressing Ctrl+C. 🛑

and then this lil trio right here, same energy, different fam:

  • 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 📚

See https://opam.ocaml.org/doc. ✨

👑 AUTHORS 👑

the legends themselves, in the order they're listed, periodt:

  • 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>

all twelve of them ate and left no crumbs 🫶

🌈 SEE ALSO 🌈

  • opam admin(1) — iykyk, go read that one next bestie 💖

🐛 BUGS 🐛

Check bug reports at https://github.com/ocaml/opam/issues. if something's broken it's probably already in there, ngl 🌸

and that's the whole page, bestie!! this was Opam admin version 2.6.1 and yes the man page goes by OPAM ADMIN-LINT(1) — iconic name, iconic page, go forth and lint responsibly 💅✨🦋

📦 where this page comes from