OPAM-ADMIN-MAKE(1)

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

💖 NAME 💖

opam admin-make — it's literally just an alias for index, bestie. That's the whole vibe. ✨

🦋 SYNOPSIS 🦋

opam admin make [--full-urls-txt] [--minimal-urls-txt] [--no-urls-txt]
[OPTION]…

🌸 DESCRIPTION 🌸

okay so real talk: opam admin make is an alias for opam admin index. same girl, different name. no cap. 💅

so if you wanna know what's actually going on under the hood? run opam admin index --help and it'll spill all the tea. go look. go look right now. 🫶

✨ OPTIONS ✨

  • --full-urls-txt — generates an inclusive urls.txt, for a repository that's gonna get used by opam versions earlier than 2.0. so like, throwback-compatible, but make it complete. 📜
  • --minimal-urls-txt — generates a minimal urls.txt file that only includes the repo file. the whole point is that opam versions earlier than 2.0 can still read that file and get properly redirected to a repo made just for their version — assuming a suitable redirect: field is defined — instead of just, like, failing and crying about it. 😭 this one is the default, so it's what you get if you don't say anything. 👑
  • --no-urls-txt — don't generate a urls.txt file at all. that index file isn't needed from opam 2.0 onwards, but bestie, older versions still use it, so be careful before you ghost it. 💀

🌈 COMMON OPTIONS 🌈

these bad boys are common to all commands. same energy everywhere. so iconic.
  • --best-effort — don't fail just because all requested packages can't be installed: try to install as many as possible instead. ngl, not all external solvers support this (recent versions of aspcud or mccs should though). this is the equivalent of setting the $OPAMBESTEFFORT environment variable. 🫶
  • --cli=MAJOR.MINOR (absent=2.6) — use the command-line interface syntax and semantics of MAJOR.MINOR. it's intended for any persistent use of opam (scripts, blog posts, etc.), and any version of opam in the same MAJOR series will behave as for the specified MINOR release. heads up: 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. 🕰️
  • --color=WHEN — colorize the output. WHEN has to be one of always, never or auto. that's it. serve. 🎀
  • --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 lives at http://www.dicosmo.org/Articles/usercriteria.pdf. 📚
  • --cudf=FILENAME — debug option, bestie: 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 messages to stderr. this is equivalent to setting $OPAMDEBUG to "true". 🪲
  • --debug-level=LEVEL — like --debug, but lets you specify 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're using a development version), and exit. main character energy only. 👑
  • --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. it's gone, she left the chat. 💀
  • --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. and fr fr, it's preferable in any case to upgrade the repositories manually using opam admin upgrade [--mirror URL] when possible. 🧚
  • -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 gets 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 setting the 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. no more playing nice. 🔥
  • --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. that's it, that's the whole thing. ⭐
  • -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. since the source directory is copied as it is, if it isn't clean it may result in an 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". ✅

🌱 ENVIRONMENT 🌱

So like, opam is constantly reading your vibe from the environment 💅 and here's the whole list of env vars she's checking. Pro tip bestie: boolean vars want "0", "no", "false" or literally just the empty string to mean off, and "1", "yes" or "true" to mean on ✨

  • OPAMALLPARENS — wraps ALL the filters up in parenthesis, cute and contained 🎀
  • OPAMASSUMEDEPEXTS — check out the --assume-depexts option, bestie.
  • OPAMAUTOANSWER — internal use only, not for us 🙈
  • OPAMAUTOREMOVE — see the 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 it's expected to maximise the opam-query property in the solution. maximizing, slay ✨
  • OPAMBUILDDOC — Removed in 2.1. rip bozo 💀
  • 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: 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 the current setting. 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. parallel queen 👑
  • OPAMDROPWORKINGDIR — overrides packages previously updated with --working-dir on update. without this variable set, opam would keep them unchanged unless 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 💅
  • OPAMERRLOGLEN — sets the number of log lines printed when a sub-process fails. 0 prints 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 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.
  • 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.
  • OPAMJSON — log json output to the given file (use 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. lowkey useful for debugging ✨
  • OPAMLOCKED — a combination of the --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. girlies merging 🫶
  • OPAMNO — answer no to any question asked, see options --no and --confirm-level. OPAMNO is ignored if either OPAMCONFIRMLEVEL or OPAMYES is set.
  • OPAMNOAGGREGATE — with opam admin check, don't aggregate packages.
  • OPAMNOASPCUD — Deprecated. 💀
  • 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 issue.
  • 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 operation are done in-memory, no I/O for scanning the repository. in-memory?? so efficient of her 🌸
  • 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. 👑
  • OPAMSAFE — see option `--safe'.
  • OPAMSHOW — see option `--show'.
  • OPAMSKIPUPDATE — see option `--skip-updates'.
  • OPAMSKIPVERSIONCHECKS — bypasses some version checks. Unsafe, for compatibility testing only. ⚠️ like bestie, don't.
  • 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 willcontinue 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.
  • 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.). no chill mode, periodt.
  • 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.
  • 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. camels bestie 🐪
  • 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. don't. 🙈
  • 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. OPAMYES has priority over OPAMNO and is ignored if OPAMCONFIRMLEVEL is set. yes queen 👑
  • 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 so listen. 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. ngl it's giving future-proof. additionally, blog posts or other documentation can benefit, as it prevents information from becoming stale. ✨

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. 👀

the command-line version is selected by using the --cli option or the OPAMCLI environment variable. --cli may be specified morethan once, where the last instance takes precedence. OPAMCLI is only inspected if --cli is not given.

✨ EXIT STATUS ✨

okay bestie, before we get into the codes — there's a little exception to literally everything below. The exec command? It doesn't play by these rules 💅. Instead it returns 127 if the command wasn't found or couldn't be executed, and otherwise it returns the command's own exit value. So if you're reading this list like "wait, why did exec do that", that's why. Slay.

  • 0 — Success! Or true, if we're talking boolean queries. The good ending 🎀
  • 1 — False. This one shows up when a boolean return value is what's expected, like when you run with --check, or for queries such as opam lint. Not an error, just a "no" ✨
  • 2 — Bad command-line arguments, or arguments pointing at an invalid context (think: a file that doesn't follow the expected format). The vibes were off 🫠
  • 5 — Not found. You asked for something (a package, a version, a repository, etc.) and it genuinely couldn't be found. Bestie, it's not there 😭
  • 10 — Aborted. The operation wanted confirmation and... didn't get it. Consent matters 🙈
  • 15 — Could not acquire the locks required for the operation. The lock was held and she was left on read 🔒
  • 20 — There is no solution to the user request. This can happen when you ask to install two incompatible packages, for example. Math said no 💀
  • 30 — Error in package definition, or other metadata files. Heads up: using --strict raises this error more often. So strict mode is strict. Shocking 🎀
  • 31 — Package script error. Some package operations were unsuccessful. This may be an error in the packages, or an incompatibility with your system. And note — this can be a partial error 🌸
  • 40 — Sync error. Some remotes just couldn't be fetched from the network. Also can be a partial error 🌈
  • 50 — Configuration error. Opam or your system configuration doesn't allow the operation, and it needs fixing. Fix it bestie 💅
  • 60 — Solver failure. The solver failed to return a sound answer. Could be a broken external solver, or an error in solver configuration. The solver is not okay rn 😭
  • 99 — Internal error. Something went wrong, likely due to a bug in opam itself. Not you. It's opam 💀
  • 130 — User interrupt. SIGINT was received, generally because the user pressed Ctrl+C. You did that 🫶

and then there's this little trio, sitting here all on its own:

  • 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. That's the spot for more reading, bestie 📖✨

👑 AUTHORS 👑

the icons who made this happen, 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 admin(1)

(go read that one too, it's giving main character energy 🔥)

🐛 BUGS 🐛

Check bug reports at https://github.com/ocaml/opam/issues. If something's broken, that's where the receipts live 🫶

and that's a wrap on OPAM ADMIN-MAKE(1), from Opam admin 2.6.1 💜 thanks for reading all the way to the bottom bestie, you're literally the moment, no cap ✨🎀🦋

📦 where this page comes from