1OPAM ADMIN(1) Opam admin Manual OPAM ADMIN(1)
2
6 opam admin - Tools for repository administrators
7
9 opam admin [COMMAND] …
10
12 This command can perform various actions on repositories in the opam
13 format. It is expected to be run from the root of a repository, i.e. a
14 directory containing a 'repo' file and a subdirectory 'packages/'
15 holding package definition within subdirectories. A 'compilers/'
16 subdirectory (opam repository format version < 2) will also be used by
17 the upgrade-format subcommand.
18
20 add-constraint [--force] [--no] [--yes] [OPTION]… PACKAGE
21 Adds version constraints on all dependencies towards a given
22 package
23 add-hashes [OPTION]… HASH_ALGO…
25 Add archive hashes to an opam repository.
26 cache [OPTION]… [DIR]
28 Fills a local cache of package archives
29 check [OPTION]…
31 Runs some consistency checks on a repository
32 filter [OPTION]… [PATTERNS]…
34 Filters a repository to only keep selected packages
35 help [--man-format=FMT] [OPTION]… [TOPIC]
37 Display help about opam admin and opam admin subcommands.
38 index [OPTION]…
40 Generate an inclusive index file for serving over HTTP.
41 lint [OPTION]… [INT]…
43 Runs 'opam lint' and reports on a whole repository
44 list [--environment=VAR=VALUE[;VAR=VALUE]] [--no] [--yes] [OPTION]…
46 [PATTERNS]…
47 Lists packages from a repository
48 upgrade [OPTION]…
50 Upgrades repository from earlier opam versions.
51
53 make [OPTION]…
54 An alias for index.
55
57 --no
58 Answer no to all opam yes/no questions without prompting. See also
59 --confirm-level. This is equivalent to setting $OPAMNO to "true".
60 -y, --yes
62 Answer yes to all opam yes/no questions without prompting. See also
63 --confirm-level. This is equivalent to setting $OPAMYES to "true".
64
66 These options are common to all commands.
67 --best-effort
69 Don't fail if all requested packages can't be installed: try to
70 install as many as possible. Note that not all external solvers may
71 support this option (recent versions of aspcud or mccs should).
72 This is equivalent to setting $OPAMBESTEFFORT environment variable.
73 --cli=MAJOR.MINOR (absent=2.1)
75 Use the command-line interface syntax and semantics of MAJOR.MINOR.
76 Intended for any persistent use of opam (scripts, blog posts,
77 etc.), any version of opam in the same MAJOR series will behave as
78 for the specified MINOR release. The flag was not available in opam
79 2.0, so to select the 2.0 CLI, set the OPAMCLI environment variable
80 to 2.0 instead of using this parameter.
81 --color=WHEN
83 Colorize the output. WHEN must be one of always, never or auto.
84 --confirm-level=LEVEL
86 Confirmation level, LEVEL must be one of ask, no, yes or
87 unsafe-yes. Can be specified more than once. If --yes or --no are
88 also given, the value of the last --confirm-level is taken into
89 account. This is equivalent to setting $OPAMCONFIRMLEVEL`.
90 --criteria=CRITERIA
92 Specify user preferences for dependency solving for this run.
93 Overrides both $OPAMCRITERIA and $OPAMUPGRADECRITERIA. For details
94 on the supported language, and the external solvers available, see
95 http://opam.ocaml.org/doc/External_solvers.html. A general guide to
96 using solver preferences can be found at
97 http://www.dicosmo.org/Articles/usercriteria.pdf.
98 --cudf=FILENAME
100 Debug option: Save the CUDF requests sent to the solver to
101 FILENAME-<n>.cudf.
102 --debug
104 Print debug message to stderr. This is equivalent to setting
105 $OPAMDEBUG to "true".
106 --debug-level=LEVEL
108 Like --debug, but allows specifying the debug level (--debug sets
109 it to 1). Equivalent to setting $OPAMDEBUG to a positive integer.
110 --git-version
112 Print the git version of opam, if set (i.e. you are using a
113 development version), and exit.
114 --help[=FMT] (default=auto)
116 Show this help in format FMT. The value FMT must be one of auto,
117 pager, groff or plain. With auto, the format is pager or plain
118 whenever the TERM env var is dumb or undefined.
119 --ignore-pin-depends
121 Ignore extra pins required by packages that get pinned, either
122 manually through opam pin or through opam install DIR. This is
123 equivalent to setting IGNOREPINDEPENDS=true.
124 --json=FILENAME
126 Save the results of the opam run in a computer-readable file. If
127 the filename contains the character `%', it will be replaced by an
128 index that doesn't overwrite an existing file. Similar to setting
129 the $OPAMJSON variable.
130 --no-aspcud
132 Removed in 2.1.
133 --no-auto-upgrade
135 When configuring or updating a repository that is written for an
136 earlier opam version (1.2), opam internally converts it to the
137 current format. This disables this behaviour. Note that
138 repositories should define their format version in a 'repo' file at
139 their root, or they will be assumed to be in the older format. It
140 is, in any case, preferable to upgrade the repositories manually
141 using opam admin upgrade [--mirror URL] when possible.
142 -q, --quiet
144 Disables --verbose.
145 --root=ROOT
147 Use ROOT as the current root path. This is equivalent to setting
148 $OPAMROOT to ROOT.
149 --safe, --readonly
151 Make sure nothing will be automatically updated or rewritten.
152 Useful for calling from completion scripts, for example. Will fail
153 whenever such an operation is needed ; also avoids waiting for
154 locks, skips interactive questions and overrides the $OPAMDEBUG
155 variable. This is equivalent to set environment variable $OPAMSAFE.
156 --solver=CMD
158 Specify the CUDF solver to use for resolving package installation
159 problems. This is either a predefined solver (this version of opam
160 supports builtin-mccs+lp(), builtin-mccs+glpk,
161 builtin-dummy-z3-solver, builtin-dummy-0install-solver, aspcud,
162 mccs, aspcud-old, packup), or a custom command that should contain
163 the variables %{input}%, %{output}%, %{criteria}%, and optionally
164 %{timeout}%. This is equivalent to setting $OPAMEXTERNALSOLVER.
165 --strict
167 Fail whenever an error is found in a package definition or a
168 configuration file. The default is to continue silently if
169 possible.
170 --switch=SWITCH
172 Use SWITCH as the current compiler switch. This is equivalent to
173 setting $OPAMSWITCH to SWITCH.
174 --use-internal-solver
176 Disable any external solver, and use the built-in one (this
177 requires that opam has been compiled with a built-in solver). This
178 is equivalent to setting $OPAMNOASPCUD or $OPAMUSEINTERNALSOLVER.
179 -v, --verbose
181 Be more verbose. One -v shows all package commands, repeat to also
182 display commands called internally (e.g. tar, curl, patch etc.)
183 Repeating n times is equivalent to setting $OPAMVERBOSE to "n".
184 --version
186 Show version information.
187 -w, --working-dir
189 Whenever updating packages that are bound to a local,
190 version-controlled directory, update to the current working state
191 of their source instead of the last committed state, or the ref
192 they are pointing to. As source directory is copied as it is, if it
193 isn't clean it may result on a opam build failure.This only affects
194 packages explicitly listed on the command-line.It can also be set
195 with $OPAMWORKINGDIR.
196
198 Opam makes use of the environment variables listed here. Boolean
199 variables should be set to "0", "no", "false" or the empty string to
200 disable, "1", "yes" or "true" to enable.
201 OPAMALLPARENS surround all filters with parenthesis.
203 OPAMASSUMEDEPEXTS see option `--assume-depexts'.
205 OPAMAUTOREMOVE see remove option `--auto-remove'.
207 OPAMBESTEFFORT see option `--best-effort'.
209 OPAMBESTEFFORTPREFIXCRITERIA sets the string that must be prepended to
211 the criteria when the `--best-effort' option is set, and is expected to
212 maximise the `opam-query' property in the solution.
213 OPAMBUILDDOC Removed in 2.1.
215 OPAMBUILDTEST Removed in 2.1.
217 OPAMCLI see option `--cli'.
219 OPAMCOLOR when set to always or never, sets a default value for the
221 `--color' option.
222 OPAMCONFIRMLEVEL see option `--confirm-level`. OPAMCONFIRMLEVEL has
224 priority over OPAMYES and OPAMNO.
225 OPAMCRITERIA specifies user preferences for dependency solving. The
227 default value depends on the solver version, use `config report' to
228 know the current setting. See also option --criteria.
229 OPAMCUDFFILE save the cudf graph to file-actions-explicit.dot.
231 OPAMCUDFTRIM controls the filtering of unrelated packages during CUDF
233 preprocessing.
234 OPAMCURL can be used to select a given 'curl' program. See OPAMFETCH
236 for more options.
237 OPAMDEBUG see options `--debug' and `--debug-level'.
239 OPAMDEBUGSECTIONS if set, limits debug messages to the space-separated
241 list of sections. Sections can optionally have a specific debug level
242 (for example, CLIENT:2 or CLIENT CUDF:2), but otherwise use
243 `--debug-level'.
244 OPAMDIGDEPTH defines how aggressive the lookup for conflicts during
246 CUDF preprocessing is.
247 OPAMDOWNLOADJOBS sets the maximum number of simultaneous downloads.
249 OPAMDROPWORKINGDIR overrides packages previously updated with
251 --working-dir on update. Without this variable set, opam would keep
252 them unchanged unless explicitly named on the command-line.
253 OPAMDRYRUN see option `--dry-run'.
255 OPAMEDITOR sets the editor to use for opam file editing, overrides
257 $EDITOR and $VISUAL.
258 OPAMERRLOGLEN sets the number of log lines printed when a sub-process
260 fails. 0 to print all.
261 OPAMEXTERNALSOLVER see option `--solver'.
263 OPAMFAKE see option `--fake'.
265 OPAMFETCH specifies how to download files: either `wget', `curl' or a
267 custom command where variables %{url}%, %{out}%, %{retry}%,
268 %{compress}% and %{checksum}% will be replaced. Overrides the
269 'download-command' value from the main config file.
270 OPAMFIXUPCRITERIA same as OPAMUPGRADECRITERIA, but specific to fixup.
272 OPAMIGNORECONSTRAINTS see install option `--ignore-constraints-on'.
274 OPAMIGNOREPINDEPENDS see option `--ignore-pin-depends'.
276 OPAMINPLACEBUILD see option `--inplace-build'.
278 OPAMJOBS sets the maximum number of parallel workers to run.
280 OPAMJSON log json output to the given file (use character `%' to index
282 the files).
283 OPAMKEEPBUILDDIR see install option `--keep-build-dir'.
285 OPAMKEEPLOGS tells opam to not remove some temporary command logs and
287 some backups. This skips some finalisers and may also help to get more
288 reliable backtraces.
289 OPAMLOCKED combination of `--locked' and `--lock-suffix' options.
291 OPAMLOGS logdir sets log directory, default is a temporary directory in
293 /tmp
294 OPAMMAKECMD set the system make command to use.
296 OPAMMERGEOUT merge process outputs, stderr on stdout.
298 OPAMNO answer no to any question asked, see options `--no` and
300 `--confirm-level`. OPAMNO is ignored if either OPAMCONFIRMLEVEL or
301 OPAMYES is set.
302 OPAMNOAGGREGATE with `opam admin check', don't aggregate packages.
304 OPAMNOASPCUD Deprecated.
306 OPAMNOAUTOUPGRADE disables automatic internal upgrade of repositories
308 in an earlier format to the current one, on 'update' or 'init'.
309 OPAMNOCHECKSUMS enables option --no-checksums when available.
311 OPAMNODEPEXTS disables system dependencies handling, see option
313 `--no-depexts'.
314 OPAMNOENVNOTICE Internal.
316 OPAMNOSELFUPGRADE see option `--no-self-upgrade'
318 OPAMPINKINDAUTO sets whether version control systems should be detected
320 when pinning to a local path. Enabled by default since 1.3.0.
321 OPAMPRECISETRACKING fine grain tracking of directories.
323 OPAMPREPRO set this to false to disable CUDF preprocessing. Less
325 efficient, but might help debugging solver issue.
326 OPAMREQUIRECHECKSUMS Enables option `--require-checksums' when
328 available (e.g. for `opam install').
329 OPAMRETRIES sets the number of tries before failing downloads.
331 OPAMREUSEBUILDDIR see option `--reuse-build-dir'.
333 OPAMROOT see option `--root'. This is automatically set by `opam env
335 --root=DIR --set-root'.
336 OPAMROOTISOK don't complain when running as root.
338 OPAMSAFE see option `--safe'.
340 OPAMSHOW see option `--show'.
342 OPAMSKIPUPDATE see option `--skip-updates'.
344 OPAMSKIPVERSIONCHECKS bypasses some version checks. Unsafe, for
346 compatibility testing only.
347 OPAMSOLVERALLOWSUBOPTIMAL (default `true') allows some solvers to still
349 return a solution when they reach timeout; while the solution remains
350 assured to be consistent, there is no guarantee in this case that it
351 fits the expected optimisation criteria. If `true', opam willcontinue
352 with a warning, if `false' a timeout is an error. Currently only the
353 builtin-z3 backend handles this degraded case.
354 OPAMSOLVERTIMEOUT change the time allowance of the solver. Default is
356 60.0, set to 0 for unlimited. Note that all solvers may not support
357 this option.
358 OPAMSTATS display stats at the end of command.
360 OPAMSTATUSLINE display a dynamic status line showing what's currently
362 going on on the terminal. (one of one of always, never or auto)
363 OPAMSTRICT fail on inconsistencies (file reading, switch import, etc.).
365 OPAMSWITCH see option `--switch'. Automatically set by `opam env
367 --switch=SWITCH --set-switch'.
368 OPAMUNLOCKBASE see install option `--unlock-base'.
370 OPAMUPGRADECRITERIA specifies user preferences for dependency solving
372 when performing an upgrade. Overrides OPAMCRITERIA in upgrades if both
373 are set. See also option --criteria.
374 OPAMUSEINTERNALSOLVER see option `--use-internal-solver'.
376 OPAMUSEOPENSSL force openssl use for hash computing.
378 OPAMUTF8 use UTF8 characters in output (one of one of always, never or
380 auto). By default `auto', which is determined from the locale).
381 OPAMUTF8MSGS use extended UTF8 characters (camels) in opam messages.
383 Implies OPAMUTF8. This is set by default on OSX only.
384 OPAMVALIDATIONHOOK if set, uses the `%{hook%}' command to validate an
386 opam repository update.
387 OPAMVERBOSE see option `--verbose'.
389 OPAMVERSIONLAGPOWER do not use.
391 OPAMWITHDOC see install option `--with-doc'.
393 OPAMWITHTEST see install option `--with-test.
395 OPAMWORKINGDIR see option `--working-dir'.
397 OPAMYES see options `--yes' and `--confirm-level`. OPAMYES has has
399 priority over OPAMNO and is ignored if OPAMCONFIRMLEVEL is set.
400 OPAMVAR_var overrides the contents of the variable var when
402 substituting `%{var}%` strings in `opam` files.
403 OPAMVAR_package_var overrides the contents of the variable package:var
405 when substituting `%{package:var}%` strings in `opam` files.
406
408 All scripts and programmatic invocations of opam should use `--cli' in
409 order to ensure that they work seamlessly with future versions of the
410 opam client. Additionally, blog posts or other documentation can
411 benefit, as it prevents information from becoming stale.
412 Although opam only supports roots (~/.opam/) for the current version,
414 it does provide backwards compatibility for its command-line interface.
415 Since CLI version support was only added in opam 2.1, use OPAMCLI to
417 select 2.0 support (as opam 2.0 will just ignore it), and `--cli=2.1'
418 for 2.1 (or later) versions, since an environment variable controlling
419 the parsing of syntax is brittle. To this end, opam displays a warning
420 if OPAMCLI specifies a valid version other than 2.0, and also if
421 `--cli=2.0' is specified.
422 The command-line version is selected by using the `--cli' option or the
424 OPAMCLI environment variable. `--cli' may be specified morethan once,
425 where the last instance takes precedence. OPAMCLI is only inspected if
426 `--cli' is not given.
427
429 As an exception to the following, the `exec' command returns 127 if the
430 command was not found or couldn't be executed, and the command's exit
431 value otherwise.
432 0 Success, or true for boolean queries.
434 1 False. Returned when a boolean return value is expected, e.g. when
436 running with --check, or for queries like opam lint.
437 2 Bad command-line arguments, or command-line arguments pointing to
439 an invalid context (e.g. file not following the expected format).
440 5 Not found. You requested something (package, version, repository,
442 etc.) that couldn't be found.
443 10 Aborted. The operation required confirmation, which wasn't given.
445 15 Could not acquire the locks required for the operation.
447 20 There is no solution to the user request. This can be caused by
449 asking to install two incompatible packages, for example.
450 30 Error in package definition, or other metadata files. Using
452 --strict raises this error more often.
453 31 Package script error. Some package operations were unsuccessful.
455 This may be an error in the packages or an incompatibility with
456 your system. This can be a partial error.
457 40 Sync error. Could not fetch some remotes from the network. This can
459 be a partial error.
460 50 Configuration error. Opam or system configuration doesn't allow
462 operation, and needs fixing.
463 60 Solver failure. The solver failed to return a sound answer. It can
465 be due to a broken external solver, or an error in solver
466 configuration.
467 99 Internal error. Something went wrong, likely due to a bug in opam
469 itself.
470 130 User interrupt. SIGINT was received, generally due to the user
472 pressing Ctrl-C.
473
475 See https://opam.ocaml.org/doc.
476
478 Vincent Bernardoff <vb@luminar.eu.org>
479 Raja Boujbel <raja.boujbel@ocamlpro.com>
480 Roberto Di Cosmo <roberto@dicosmo.org>
481 Thomas Gazagnaire <thomas@gazagnaire.org>
482 Louis Gesbert <louis.gesbert@ocamlpro.com>
484 Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
485 Anil Madhavapeddy <anil@recoil.org>
486 Guillem Rieu <guillem.rieu@ocamlpro.com>
487 Ralf Treinen <ralf.treinen@pps.jussieu.fr>
488 Frederic Tuong <tuong@users.gforge.inria.fr>
489
491 Check bug reports at https://github.com/ocaml/opam/issues.
492Opam admin 2.1.5 OPAM ADMIN(1)