1OPAM-INIT(1) Opam Manual OPAM-INIT(1)
2
6 opam-init - Initialize opam state, or set init options.
7
9 opam init [OPTION]... [NAME] [ADDRESS]
10
12 Initialise the opam state, or update opam init options
13 The init command initialises a local "opam root" (by default, ~/.opam/)
15 that holds opam's data and packages. This is a necessary step for
16 normal operation of opam. The initial software repositories are
17 fetched, and an initial 'switch' can also be installed, according to
18 the configuration and options. These can be afterwards configured using
19 opam switch and opam repository.
20 The initial repository and defaults can be set through a configuration
22 file found at ~/.opamrc or /etc/opamrc.
23 Additionally, this command allows one to customise some aspects of
25 opam's shell integration, when run initially (avoiding the interactive
26 dialog), but also at any later time.
27
29 ADDRESS
30 Address of the initial package repository, when creating a new opam
31 root.
32 NAME (absent=default)
34 Name of the initial repository, when creating a new opam root.
35
37 -a, --auto-setup
38 Automatically do a full setup, including adding a line to your
39 shell init files.
40 --bare
42 Initialise the opam state, but don't setup any compiler switch yet.
43 --bypass-checks
45 Skip checks on required or recommended tools, and assume everything
46 is fine
47 -c PACKAGE, --compiler=PACKAGE
49 Set the compiler to install (when creating an initial switch)
50 --config=FILE
52 Use the given init config file. If repeated, latest has the highest
53 priority (i.e. each field gets its value from where it was defined
54 last). Specifying a URL pointing to a config file instead is
55 allowed.
56 --disable-completion
58 Disable shell completion in opam init scripts.
59 --disable-sandboxing
61 Use a default configuration with sandboxing disabled (note that
62 this may be overridden by `opamrc' if --no-opamrc is not specified
63 or --config is used). Use this at your own risk, without sandboxing
64 it is possible for a broken package script to delete all your
65 files.
66 --disable-shell-hook
68 Disable registration of a shell hook in opam init scripts.
69 --dot-profile=FILENAME
71 Name of the configuration file to update instead of ~/.profile or
72 ~/.zshrc based on shell detection.
73 --enable-completion
75 Setup shell completion in opam init scripts, for supported shells.
76 --enable-shell-hook
78 Setup opam init scripts to register a shell hook that will
79 automatically keep the shell environment up-to-date at every
80 prompt.
81 -i, --interactive
83 Run the setup interactively (this is the default for an initial
84 run, or when no more specific options are specified)
85 -j JOBS, --jobs=JOBS
87 Set the maximal number of concurrent jobs to use. The default value
88 is calculated from the number of cores. You can also set it using
89 the $OPAMJOBS environment variable.
90 -k KIND, --kind=KIND
92 Specify the kind of the repository to be used (one of `http',
93 `local', `git', `darcs' or `hg').
94 -n, --no-setup
96 Do not update the user shell configuration to setup opam. Also
97 implies --disable-shell-hook, unless --interactive or specified
98 otherwise
99 --no
101 Answer no to all opam yes/no questions without prompting. See also
102 --confirm-level. This is equivalent to setting $OPAMNO to "true".
103 --no-opamrc
105 Don't read `/etc/opamrc' or `~/.opamrc': use the default settings
106 and the files specified through --config only
107 --reinit
109 Re-run the initial checks and setup, according to opamrc, even if
110 this is not a new opam root
111 --shell=SHELL
113 Sets the configuration mode for opam environment appropriate for
114 SHELL. One of one of `bash', `sh', `csh', `zsh' or `fish'. Guessed
115 from the parent processes and the $SHELL variable by default.
116 --shell-setup
118 Automatically setup the user shell configuration for opam, e.g.
119 adding a line to the `~/.profile' file.
120 --show-default-opamrc
122 Print the built-in default configuration to stdout and exit
123 -y, --yes
125 Answer yes to all opam yes/no questions without prompting. See also
126 --confirm-level. This is equivalent to setting $OPAMYES to "true".
127
129 Any field from the built-in initial configuration can be overridden
130 through ~/.opamrc, /etc/opamrc, or a file supplied with --config. The
131 default configuration for this version of opam can be obtained using
132 --show-default-opamrc.
133
135 --assume-depexts
136 Skip the installation step for any missing system packages, and
137 attempt to proceed with compilation of the opam packages anyway. If
138 the installation is successful, opam won't prompt again about these
139 system packages. Only meaningful if external dependency handling is
140 enabled.
141 -b, --keep-build-dir
143 Keep the build directories after compiling packages. This is
144 equivalent to setting $OPAMKEEPBUILDDIR to "true".
145 --build-doc
147 Removed in 2.1, use --with-doc instead.
148 --build-test
150 Removed in 2.1, use --with-test instead.
151 -d, --with-doc
153 Build the package documentation. This only affects packages listed
154 on the command-line. This is equivalent to setting $OPAMWITHDOC (or
155 the deprecated $OPAMBUILDDOC) to "true".
156 --dry-run
158 Simulate the command, but don't actually perform any changes. This
159 also can be set with environment variable $OPAMDEBUG.
160 --fake
162 This option registers the actions into the opam database, without
163 actually performing them. WARNING: This option is dangerous and
164 likely to break your opam environment. You probably want --dry-run.
165 You've been warned.
166 --ignore-constraints-on[=PACKAGES] (default=)
168 Forces opam to ignore version constraints on all dependencies to
169 the listed packages. This can be used to test compatibility, but
170 expect builds to break when using this. Note that version
171 constraints on optional dependencies and conflicts are unaffected.
172 This is equivalent to setting $OPAMIGNORECONSTRAINTS.
173 --inplace-build
175 When compiling a package which has its source bound to a local
176 directory, process the build and install actions directly in that
177 directory, rather than in a clean copy handled by opam. This only
178 affects packages that are explicitly listed on the command-line.
179 This is equivalent to setting $OPAMINPLACEBUILD to "true".
180 --lock-suffix=SUFFIX (absent=locked)
182 Set locked files suffix to SUFFIX.
183 --locked
185 In commands that use opam files found from pinned sources, if a
186 variant of the file with an added .locked extension is found (e.g.
187 foo.opam.locked besides foo.opam), that will be used instead. This
188 is typically useful to offer a more specific set of dependencies
189 and reproduce similar build contexts, hence the name. The
190 lockoption can be used to generate such files, based on the
191 versions of the dependencies currently installed on the host. This
192 is equivalent to setting the $OPAMLOCKED environment variable. Note
193 that this option doesn't generally affect already pinned packages.
194 -m MAKE, --make=MAKE
196 Removed in 2.1, use opam config set[-global] make MAKE instead.
197 --no-checksums
199 Do not verify the checksum of downloaded archives.This is
200 equivalent to setting $OPAMNOCHECKSUMS to "true".
201 --no-depexts
203 Temporarily disables handling of external dependencies. This can be
204 used if a package is not available on your system package manager,
205 but you installed the required dependency by hand. Implies
206 --assume-depexts, and stores the exceptions upon success as well.
207 --require-checksums
209 Reject the installation of packages that don't provide a checksum
210 for the upstream archives. This is equivalent to setting
211 $OPAMREQUIRECHECKSUMS to "true".
212 --reuse-build-dir
214 Reuse existing build directories (kept by using --keep-build-dir),
215 instead of compiling from a fresh clone of the source. This can be
216 faster, but also lead to failures if the build systems of the
217 packages don't handle upgrades of dependencies well. This is
218 equivalent to setting $OPAMREUSEBUILDDIR to "true".
219 --show-actions
221 Call the solver and display the actions. Don't perform any changes.
222 This is equivalent to setting $OPAMSHOW.
223 --skip-updates
225 When running an install, upgrade or reinstall on source-pinned
226 packages, they are normally updated from their origin first. This
227 flag disables that behaviour and will keep them to their version in
228 cache. This is equivalent to setting $OPAMSKIPUPDATE.
229 -t, --with-test
231 Build and run the package unit-tests. This only affects packages
232 listed on the command-line. This is equivalent to setting
233 $OPAMWITHTEST (or the deprecated $OPAMBUILDTEST) to "true".
234 --unlock-base
236 Removed in 2.1, use --update-invariant instead.
237 --update-invariant
239 Allow changes to the packages set as switch base (typically, the
240 main compiler). Use with caution. This is equivalent to setting the
241 $OPAMUNLOCKBASE environment variable
242
244 These options are common to all commands.
245 --best-effort
247 Don't fail if all requested packages can't be installed: try to
248 install as many as possible. Note that not all external solvers may
249 support this option (recent versions of aspcud or mccs should).
250 This is equivalent to setting $OPAMBESTEFFORT environment variable.
251 --cli=MAJOR.MINOR (absent=2.1)
253 Use the command-line interface syntax and semantics of MAJOR.MINOR.
254 Intended for any persistent use of opam (scripts, blog posts,
255 etc.), any version of opam in the same MAJOR series will behave as
256 for the specified MINOR release. The flag was not available in opam
257 2.0, so to select the 2.0 CLI, set the OPAMCLI environment variable
258 to 2.0 instead of using this parameter.
259 --color=WHEN
261 Colorize the output. WHEN must be one of `always', `never' or
262 `auto'.
263 --confirm-level=LEVEL
265 Confirmation level, LEVEL must be one of `ask', `no', `yes' or
266 `unsafe-yes'. Can be specified more than once. If --yes or --no are
267 also given, the value of the last --confirm-level is taken into
268 account. This is equivalent to setting $OPAMCONFIRMLEVEL`.
269 --criteria=CRITERIA
271 Specify user preferences for dependency solving for this run.
272 Overrides both $OPAMCRITERIA and $OPAMUPGRADECRITERIA. For details
273 on the supported language, and the external solvers available, see
274 http://opam.ocaml.org/doc/External_solvers.html. A general guide to
275 using solver preferences can be found at
276 http://www.dicosmo.org/Articles/usercriteria.pdf.
277 --cudf=FILENAME
279 Debug option: Save the CUDF requests sent to the solver to
280 FILENAME-<n>.cudf.
281 --debug
283 Print debug message to stderr. This is equivalent to setting
284 $OPAMDEBUG to "true".
285 --debug-level=LEVEL
287 Like --debug, but allows specifying the debug level (--debug sets
288 it to 1). Equivalent to setting $OPAMDEBUG to a positive integer.
289 --git-version
291 Print the git version of opam, if set (i.e. you are using a
292 development version), and exit.
293 --help[=FMT] (default=auto)
295 Show this help in format FMT. The value FMT must be one of `auto',
296 `pager', `groff' or `plain'. With `auto', the format is `pager` or
297 `plain' whenever the TERM env var is `dumb' or undefined.
298 --ignore-pin-depends
300 Ignore extra pins required by packages that get pinned, either
301 manually through opam pin or through opam install DIR. This is
302 equivalent to setting IGNOREPINDEPENDS=true.
303 --json=FILENAME
305 Save the results of the opam run in a computer-readable file. If
306 the filename contains the character `%', it will be replaced by an
307 index that doesn't overwrite an existing file. Similar to setting
308 the $OPAMJSON variable.
309 --no-aspcud
311 Removed in 2.1.
312 --no-auto-upgrade
314 When configuring or updating a repository that is written for an
315 earlier opam version (1.2), opam internally converts it to the
316 current format. This disables this behaviour. Note that
317 repositories should define their format version in a 'repo' file at
318 their root, or they will be assumed to be in the older format. It
319 is, in any case, preferable to upgrade the repositories manually
320 using opam admin upgrade [--mirror URL] when possible.
321 --no-self-upgrade
323 Opam will replace itself with a newer binary found at OPAMROOT/opam
324 if present. This disables this behaviour.
325 -q, --quiet
327 Disables --verbose.
328 --root=ROOT
330 Use ROOT as the current root path. This is equivalent to setting
331 $OPAMROOT to ROOT.
332 --safe, --readonly
334 Make sure nothing will be automatically updated or rewritten.
335 Useful for calling from completion scripts, for example. Will fail
336 whenever such an operation is needed ; also avoids waiting for
337 locks, skips interactive questions and overrides the $OPAMDEBUG
338 variable. This is equivalent to set environment variable $OPAMSAFE.
339 --solver=CMD
341 Specify the CUDF solver to use for resolving package installation
342 problems. This is either a predefined solver (this version of opam
343 supports builtin-mccs+lp(), builtin-mccs+glpk,
344 builtin-dummy-z3-solver, builtin-dummy-0install-solver, aspcud,
345 mccs, aspcud-old, packup), or a custom command that should contain
346 the variables %{input}%, %{output}%, %{criteria}%, and optionally
347 %{timeout}%. This is equivalent to setting $OPAMEXTERNALSOLVER.
348 --strict
350 Fail whenever an error is found in a package definition or a
351 configuration file. The default is to continue silently if
352 possible.
353 --switch=SWITCH
355 Use SWITCH as the current compiler switch. This is equivalent to
356 setting $OPAMSWITCH to SWITCH.
357 --use-internal-solver
359 Disable any external solver, and use the built-in one (this
360 requires that opam has been compiled with a built-in solver). This
361 is equivalent to setting $OPAMNOASPCUD or $OPAMUSEINTERNALSOLVER.
362 -v, --verbose
364 Be more verbose. One -v shows all package commands, repeat to also
365 display commands called internally (e.g. tar, curl, patch etc.)
366 Repeating n times is equivalent to setting $OPAMVERBOSE to "n".
367 --version
369 Show version information.
370 -w, --working-dir
372 Whenever updating packages that are bound to a local,
373 version-controlled directory, update to the current working state
374 of their source instead of the last committed state, or the ref
375 they are pointing to. As source directory is copied as it is, if it
376 isn't clean it may result on a opam build failure.This only affects
377 packages explicitly listed on the command-line.It can also be set
378 with $OPAMWORKINGDIR.
379
381 Opam makes use of the environment variables listed here. Boolean
382 variables should be set to "0", "no", "false" or the empty string to
383 disable, "1", "yes" or "true" to enable.
384 OPAMALLPARENS surround all filters with parenthesis.
386 OPAMASSUMEDEPEXTS see option `--assume-depexts'.
388 OPAMAUTOREMOVE see remove option `--auto-remove'.
390 OPAMBESTEFFORT see option `--best-effort'.
392 OPAMBESTEFFORTPREFIXCRITERIA sets the string that must be prepended to
394 the criteria when the `--best-effort' option is set, and is expected to
395 maximise the `opam-query' property in the solution.
396 OPAMBUILDDOC Removed in 2.1.
398 OPAMBUILDTEST Removed in 2.1.
400 OPAMCLI see option `--cli'.
402 OPAMCOLOR when set to always or never, sets a default value for the
404 `--color' option.
405 OPAMCONFIRMLEVEL see option `--confirm-level`. OPAMCONFIRMLEVEL has
407 priority over OPAMYES and OPAMNO.
408 OPAMCRITERIA specifies user preferences for dependency solving. The
410 default value depends on the solver version, use `config report' to
411 know the current setting. See also option --criteria.
412 OPAMCUDFFILE save the cudf graph to file-actions-explicit.dot.
414 OPAMCUDFTRIM controls the filtering of unrelated packages during CUDF
416 preprocessing.
417 OPAMCURL can be used to select a given 'curl' program. See OPAMFETCH
419 for more options.
420 OPAMDEBUG see options `--debug' and `--debug-level'.
422 OPAMDEBUGSECTIONS if set, limits debug messages to the space-separated
424 list of sections. Sections can optionally have a specific debug level
425 (for example, CLIENT:2 or CLIENT CUDF:2), but otherwise use
426 `--debug-level'.
427 OPAMDIGDEPTH defines how aggressive the lookup for conflicts during
429 CUDF preprocessing is.
430 OPAMDOWNLOADJOBS sets the maximum number of simultaneous downloads.
432 OPAMDROPWORKINGDIR overrides packages previously updated with
434 --working-dir on update. Without this variable set, opam would keep
435 them unchanged unless explicitly named on the command-line.
436 OPAMDRYRUN see option `--dry-run'.
438 OPAMEDITOR sets the editor to use for opam file editing, overrides
440 $EDITOR and $VISUAL.
441 OPAMERRLOGLEN sets the number of log lines printed when a sub-process
443 fails. 0 to print all.
444 OPAMEXTERNALSOLVER see option `--solver'.
446 OPAMFAKE see option `--fake'.
448 OPAMFETCH specifies how to download files: either `wget', `curl' or a
450 custom command where variables %{url}%, %{out}%, %{retry}%,
451 %{compress}% and %{checksum}% will be replaced. Overrides the
452 'download-command' value from the main config file.
453 OPAMFIXUPCRITERIA same as OPAMUPGRADECRITERIA, but specific to fixup.
455 OPAMIGNORECONSTRAINTS see install option `--ignore-constraints-on'.
457 OPAMIGNOREPINDEPENDS see option `--ignore-pin-depends'.
459 OPAMINPLACEBUILD see option `--inplace-build'.
461 OPAMJOBS sets the maximum number of parallel workers to run.
463 OPAMJSON log json output to the given file (use character `%' to index
465 the files).
466 OPAMKEEPBUILDDIR see install option `--keep-build-dir'.
468 OPAMKEEPLOGS tells opam to not remove some temporary command logs and
470 some backups. This skips some finalisers and may also help to get more
471 reliable backtraces.
472 OPAMLOCKED combination of `--locked' and `--lock-suffix' options.
474 OPAMLOGS logdir sets log directory, default is a temporary directory in
476 /tmp
477 OPAMMAKECMD set the system make command to use.
479 OPAMMERGEOUT merge process outputs, stderr on stdout.
481 OPAMNO answer no to any question asked, see options `--no` and
483 `--confirm-level`. OPAMNO is ignored if either OPAMCONFIRMLEVEL or
484 OPAMYES is set.
485 OPAMNOAGGREGATE with `opam admin check', don't aggregate packages.
487 OPAMNOASPCUD Deprecated.
489 OPAMNOAUTOUPGRADE disables automatic internal upgrade of repositories
491 in an earlier format to the current one, on 'update' or 'init'.
492 OPAMNOCHECKSUMS enables option --no-checksums when available.
494 OPAMNODEPEXTS disables system dependencies handling, see option
496 `--no-depexts'.
497 OPAMNOENVNOTICE Internal.
499 OPAMNOSELFUPGRADE see option `--no-self-upgrade'
501 OPAMPINKINDAUTO sets whether version control systems should be detected
503 when pinning to a local path. Enabled by default since 1.3.0.
504 OPAMPRECISETRACKING fine grain tracking of directories.
506 OPAMPREPRO set this to false to disable CUDF preprocessing. Less
508 efficient, but might help debugging solver issue.
509 OPAMREQUIRECHECKSUMS Enables option `--require-checksums' when
511 available (e.g. for `opam install').
512 OPAMRETRIES sets the number of tries before failing downloads.
514 OPAMREUSEBUILDDIR see option `--reuse-build-dir'.
516 OPAMROOT see option `--root'. This is automatically set by `opam env
518 --root=DIR --set-root'.
519 OPAMROOTISOK don't complain when running as root.
521 OPAMSAFE see option `--safe'.
523 OPAMSHOW see option `--show'.
525 OPAMSKIPUPDATE see option `--skip-updates'.
527 OPAMSKIPVERSIONCHECKS bypasses some version checks. Unsafe, for
529 compatibility testing only.
530 OPAMSOLVERALLOWSUBOPTIMAL (default `true') allows some solvers to still
532 return a solution when they reach timeout; while the solution remains
533 assured to be consistent, there is no guarantee in this case that it
534 fits the expected optimisation criteria. If `true', opam willcontinue
535 with a warning, if `false' a timeout is an error. Currently only the
536 builtin-z3 backend handles this degraded case.
537 OPAMSOLVERTIMEOUT change the time allowance of the solver. Default is
539 60.0, set to 0 for unlimited. Note that all solvers may not support
540 this option.
541 OPAMSTATS display stats at the end of command.
543 OPAMSTATUSLINE display a dynamic status line showing what's currently
545 going on on the terminal. (one of one of `always', `never' or `auto')
546 OPAMSTRICT fail on inconsistencies (file reading, switch import, etc.).
548 OPAMSWITCH see option `--switch'. Automatically set by `opam env
550 --switch=SWITCH --set-switch'.
551 OPAMUNLOCKBASE see install option `--unlock-base'.
553 OPAMUPGRADECRITERIA specifies user preferences for dependency solving
555 when performing an upgrade. Overrides OPAMCRITERIA in upgrades if both
556 are set. See also option --criteria.
557 OPAMUSEINTERNALSOLVER see option `--use-internal-solver'.
559 OPAMUSEOPENSSL force openssl use for hash computing.
561 OPAMUTF8 use UTF8 characters in output (one of one of `always', `never'
563 or `auto'). By default `auto', which is determined from the locale).
564 OPAMUTF8MSGS use extended UTF8 characters (camels) in opam messages.
566 Implies OPAMUTF8. This is set by default on OSX only.
567 OPAMVALIDATIONHOOK if set, uses the `%{hook%}' command to validate an
569 opam repository update.
570 OPAMVERBOSE see option `--verbose'.
572 OPAMVERSIONLAGPOWER do not use.
574 OPAMWITHDOC see install option `--with-doc'.
576 OPAMWITHTEST see install option `--with-test.
578 OPAMWORKINGDIR see option `--working-dir'.
580 OPAMYES see options `--yes' and `--confirm-level`. OPAMYES has has
582 priority over OPAMNO and is ignored if OPAMCONFIRMLEVEL is set.
583 OPAMVAR_var overrides the contents of the variable var when
585 substituting `%{var}%` strings in `opam` files.
586 OPAMVAR_package_var overrides the contents of the variable package:var
588 when substituting `%{package:var}%` strings in `opam` files.
589
591 All scripts and programmatic invocations of opam should use `--cli' in
592 order to ensure that they work seamlessly with future versions of the
593 opam client. Additionally, blog posts or other documentation can
594 benefit, as it prevents information from becoming stale.
595 Although opam only supports roots (~/.opam/) for the current version,
597 it does provide backwards compatibility for its command-line interface.
598 Since CLI version support was only added in opam 2.1, use OPAMCLI to
600 select 2.0 support (as opam 2.0 will just ignore it), and `--cli=2.1'
601 for 2.1 (or later) versions, since an environment variable controlling
602 the parsing of syntax is brittle. To this end, opam displays a warning
603 if OPAMCLI specifies a valid version other than 2.0, and also if
604 `--cli=2.0' is specified.
605 The command-line version is selected by using the `--cli' option or the
607 OPAMCLI environment variable. `--cli' may be specified morethan once,
608 where the last instance takes precedence. OPAMCLI is only inspected if
609 `--cli' is not given.
610
612 As an exception to the following, the `exec' command returns 127 if the
613 command was not found or couldn't be executed, and the command's exit
614 value otherwise.
615 0 Success, or true for boolean queries.
617 1 False. Returned when a boolean return value is expected, e.g. when
619 running with --check, or for queries like opam lint.
620 2 Bad command-line arguments, or command-line arguments pointing to
622 an invalid context (e.g. file not following the expected format).
623 5 Not found. You requested something (package, version, repository,
625 etc.) that couldn't be found.
626 10 Aborted. The operation required confirmation, which wasn't given.
628 15 Could not acquire the locks required for the operation.
630 20 There is no solution to the user request. This can be caused by
632 asking to install two incompatible packages, for example.
633 30 Error in package definition, or other metadata files. Using
635 --strict raises this error more often.
636 31 Package script error. Some package operations were unsuccessful.
638 This may be an error in the packages or an incompatibility with
639 your system. This can be a partial error.
640 40 Sync error. Could not fetch some remotes from the network. This can
642 be a partial error.
643 50 Configuration error. Opam or system configuration doesn't allow
645 operation, and needs fixing.
646 60 Solver failure. The solver failed to return a sound answer. It can
648 be due to a broken external solver, or an error in solver
649 configuration.
650 99 Internal error. Something went wrong, likely due to a bug in opam
652 itself.
653 130 User interrupt. SIGINT was received, generally due to the user
655 pressing Ctrl-C.
656
658 See https://opam.ocaml.org/doc.
659
661 Vincent Bernardoff <vb@luminar.eu.org>
662 Raja Boujbel <raja.boujbel@ocamlpro.com>
663 Roberto Di Cosmo <roberto@dicosmo.org>
664 Thomas Gazagnaire <thomas@gazagnaire.org>
665 Louis Gesbert <louis.gesbert@ocamlpro.com>
666 Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
667 Anil Madhavapeddy <anil@recoil.org>
668 Guillem Rieu <guillem.rieu@ocamlpro.com>
669 Ralf Treinen <ralf.treinen@pps.jussieu.fr>
670 Frederic Tuong <tuong@users.gforge.inria.fr>
671
673 Check bug reports at https://github.com/ocaml/opam/issues.
674Opam 2.1.1 OPAM-INIT(1)