DUNE-UNINSTALL(1)

📦
version 3.24.1 · 15 versions
, in ubuntu stonking

💖 dune-uninstall 💖

okay bestie, real talk — this page lives in the Dune Manual collection, and like, it's dune-uninstall(1). We're in part 1 of 2, so buckle up 🎀

🦋 NAME 🦋

dune-uninstall — uninstalls packages that are defined in the workspace. that's the whole vibe. bye bye install files, no cap.

🌸 SYNOPSIS 🌸

so the installation directories used are defined by priority — like, they get picked in this order, and whoever shows up first wins:

  • directories set on the command line of dune install, or the corresponding environment variables
  • directories set in the dune binary. They are set up before the compilation of dune, with ./configure
  • inferred from the environment variable OPAM_SWITCH_PREFIX, if it's present

✨ OPTIONS ✨

like, there are SO many of these. every single one is here though, no skipping 💅

  • --action-stderr-on-success=VAL — literally the same energy as --action-stdout-on-success but for standard error instead of standard output. A totally iconic default for large mono-repositories is --action-stdout-on-success=swallow --action-stderr-on-success=must-be-empty. This makes sure that a successful build has a "clean", empty output. chef's kiss 🧚
  • --action-stdout-on-success=VAL — tells Dune how to deal with the standard output of actions when they actually succeed. The possible values are: print, which just prints it to Dune's output, swallow, which completely ignores it, and must-be-empty, which enforces that the action printed nothing. With must-be-empty, Dune will consider the action failed if it printed anything to its standard output. The default is print.
  • --bindir=PATH — manually override the directory where public binaries get installed. Only an absolute path is accepted, periodt.
  • --build-info — shows build information. that's it, that's the whole thing 👑
  • --context=CONTEXT — picks which context to install from. By default it installs files from all defined contexts.
  • --create-install-files — does not directly install; instead it creates install files in the root directory and creates substituted files if needed in destdir (_destdir by default). it's giving "prep work" energy.
  • --datadir=PATH — manually override the directory where files from the share section get installed. Only an absolute path is accepted.
  • --destdir=PATH (absent DESTDIR env) — this directory gets prepended to all installed paths. like a little prefix bestie 🫶
  • --display-separate-messages — separates error messages with a blank line. breathing room, we love to see it.
  • --docdir=PATH — manually override the directory where documentation files get installed. Only an absolute path is accepted.
  • --dry-run — only displays the file operations that would be performed. window shopping, essentially 🛍️
  • --error-reporting=VAL (absent=deterministic) — controls when build errors get reported. early reports errors as soon as they are discovered. deterministic reports errors at the end of the build in a deterministic order. twice reports each error twice: once as soon as the error is discovered, and then again at the end of the build, in a deterministic order.
  • --etcdir=PATH — manually override the directory where configuration files get installed. Only an absolute path is accepted.
  • -f, --force — forces actions associated with aliases to be re-executed even if their dependencies haven't changed. no lazy shortcuts, we're doing it again 💅
  • --file-watcher=VAL (absent=automatic) — the mechanism used to detect changes in the source. Automatic makes dune run an external program to detect changes. Manual means you notify dune that files have changed manually.
  • --libdir=PATH — directory where library files get copied, either relative to prefix or absolute. If --prefix is specified, the default is $prefix/lib. Only an absolute path is accepted.
  • --libexecdir=PATH — manually override the directory where executable library files get installed. Only an absolute path is accepted.
  • --mandir=PATH — manually override the directory where man pages get installed. Only an absolute path is accepted. (yes, the very page you're reading rn, that kind of thing 🎀)
  • --passive-watch-mode — similar to [--watch], but it only starts a build when it's instructed externally by an RPC. it waits to be asked, main character behaviour.
  • --prefix=PREFIX (absent DUNE_INSTALL_PREFIX env) — directory where files get copied. For instance, binaries are copied into $prefix/bin, library files into $prefix/lib, etc...
  • --relocatable — makes the binaries relocatable, meaning the installation directory can be moved. The installation directory must be specified with --prefix.
  • --sandbox=VAL (absent DUNE_SANDBOX env) — sets the sandboxing mode. Some actions require a certain sandboxing mode, so they will just ignore this setting. The allowed values are: none, symlink, copy, hardlink.
  • --sbindir=PATH — manually override the directory where files from the sbin section get installed. Only an absolute path is accepted.
  • --sections=VAL — the sections that should be installed. tell it what you want, it delivers 💖
  • --stop-on-first-error — stops the build as soon as an error is encountered. no, we are not continuing, we are DONE.
  • -w, --watch — instead of terminating the build after completion, it waits continuously for file changes. it's a lurker fr fr 👀
  • --wait-for-filesystem-clock — Dune digests file contents for better incrementality, and those digests are themselves cached. In some cases, Dune needs to drop some digest cache entries in order for things to be reliable. This option makes Dune wait for the file system clock to advance, so that it doesn't need to drop anything. You should probably not care about this option; it is mostly useful for Dune developers to make Dune tests of the digest cache more reproducible.

💖 COMMON OPTIONS 💖

okay bestie these ones are like... the shared wardrobe. every command in the house gets to wear them 🫶

  • --always-show-command-line — no hiding: dune shows you the FULL command lines of the programs it runs. all of them. periodt 💅
  • --auto-promote — promotes files for you automatically. it's giving "ran dune promote right after the build" energy ✨
  • --build-dir=FILE (absent → DUNE_BUILD_DIR env) — pick your build directory. default is _build if you don't say anything 🎀
  • --cache=VAL (absent → DUNE_CACHE env) — turn the Dune cache on or off. one of disabled, enabled-except-user-rules or enabled. default is `enabled-except-user-rules'. 🌸
  • --cache-check-probability=VAL (absent → DUNE_CACHE_CHECK_PROBABILITY env) — checks whether your builds are reproducible by re-running randomly chosen rules and comparing what comes out with what Dune cache already stored. heads up: bumping the probability makes your build slower 😭. default is zero, aka no rules get checked, aka we are not investigating today.
  • --cache-storage-mode=VAL (absent → DUNE_CACHE_STORAGE_MODE env) — Dune cache storage mode. one of auto, hardlink or copy. default is `hardlink'. 💖
  • --config-file=FILE — load THIS config file instead of the default one. main character config ✨
  • --debug-backtraces — always print exception backtraces. no more mystery crashes, we're reading the receipts 📜
  • --debug-dependency-path — if something errors out, print the dependency path from the targets on the command line all the way down to the rule that failed. detective mode 🔍
  • --debug-package-logs (absent → DUNE_DEBUG_PACKAGE_LOGS env) — always print the standard logs when building packages
  • --default-target=TARGET (absent=@@default) — set the default target used when you don't specify one to dune build.
  • --diff-command=VAL (absent → DUNE_DIFF_COMMAND env) — the shell command used to diff files. use - to turn off diff printing entirely 🙈
  • --disable-promotion (absent → DUNE_DISABLE_PROMOTION env) — disables all promotion rules 💀
  • --display=MODE — controls Dune's display mode. check dune-config(5) for the deets. valid values are progress, verbose, short, quiet or tui. 🦋
  • --dump-gc-stats=FILE — dumps the garbage collector stats into a file once the build finishes. data girlies rise 🌈
  • --help[=FMT] (default=auto) — shows this help in format FMT. 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-promoted-rules — ignores rules with (mode promote), except the ones with (only ...). the variable %{ignoring_promoted_rules} in dune files tells you whether this option was passed or not.
  • --instrument-with=BACKENDS (absent → DUNE_INSTRUMENT_WITH env) — turns on instrumentation via BACKENDS. BACKENDS is a comma-separated list of library names, and every single one of them must declare an instrumentation backend, no exceptions bestie 🎀
  • -j JOBS (absent → DUNE_JOBS env) — run no more than JOBS commands at the same time. JOBS must be a positive integer, or auto to auto-detect the number of cores (which is the default, and honestly is what you want). 💅
  • --no-buffer — don't buffer the output of commands executed by dune. by default dune buffers subcommand output so things don't interleave when multiple commands run in parallel — but that lowkey becomes a problem when you're debugging long-running tests. with --no-buffer, commands get direct access to the terminal. note that this means their output won't be captured in the log file. you should pair this with -j 1 so nothing interleaves, and also use --verbose so commands are printed before they run. three-step combo, slay 🔥
  • --no-config — don't load the configuration file 🙅‍♀️
  • --no-print-directory — suppresses those "Entering directory" messages.
  • --only-packages=PACKAGES — ignore stanzas that refer to a package not in PACKAGES. PACKAGES is a comma-separated list of package names. note this does the exact same thing as deleting those stanzas from your dune files. it's mostly meant for releases — during development, what you probably actually want is to build a particular <package>.install target. iykyk ✨
  • -p PACKAGES, --for-release-of-packages=PACKAGES (required) — shorthand for --release --pkg=disabled --only-packages PACKAGE. you MUST use this option in your <package>.opam files, so that only what's necessary gets built when your project has multiple packages, AND so you get reproducible builds. non-negotiable bestie 🫶
  • --pkg=VAL — enable or disable package management. the default behaviour depends on whether a lock directory exists. 🤷‍♀️
  • --profile=VAL (absent → DUNE_PROFILE env) — select the build profile, like dev or release. default is dev. 🌸
  • --promote-install-files[=VAL] (default=true) — promotes any generated <package>.install files into the source tree.
  • --release — puts dune into a reproducible release mode. shorthand for --root . --ignore-promoted-rules --no-config --profile release --always-show-command-line --promote-install-files --require-dune-project-file --default-target @install. you should use this for release builds — for example, you must use it in your <package>.opam files. except if you already use -p, because -p implies this option. 👑
  • --require-dune-project-file[=VAL] (default=true) — fails if a dune-project file is missing.
  • --root=DIR (absent → DUNE_ROOT env) — use this directory as the workspace root instead of guessing it. note that this doesn't change how targets given on the command line are interpreted. it is only intended for scripts. 🤖
  • --store-orig-source-dir (absent → DUNE_STORE_ORIG_SOURCE_DIR env) — stores the original source location in dune-package metadata. keeping the receipts 🧾
  • --target-exec=TOOLCHAIN=CMD (absent → DUNE_TARGET_EXEC env) — wrapper command for running target binaries when cross-compiling. format: TOOLCHAIN=CMD (e.g., 'windows=wine'). 🍓
  • --terminal-persistence=MODE — changes how the log of build results is displayed to the console between rebuilds while in --watch mode. supported modes: preserve, clear-on-rebuild, clear-on-rebuild-and-flush-history.
  • --trace-file=FILE — outputs trace data in catapult format (compatible with chrome://tracing).
  • --verbose — same as --display verbose. talkative era 💬
  • --version — shows version information.
  • --watch-exclusions=REGEX — adds a POSIX regular expression that excludes matching directories from dune build --watch. you can repeat --watch-exclusions to add multiple exclusions, and semicolons also work as a separator. if you give no exclusions, a standard set gets used — BUT if you use one or more --watch-exclusions, none of the standard exclusions apply anymore. the standard exclusions are:
^_opam /_opam ^_esy /_esy ^\.#.* /\.#.* ~$ ^#[^#]*#$ /#[^#]*#$ ^4913$ /4913$ /.git /.hg :/windows
  • --workspace=FILE (absent → DUNE_WORKSPACE env) — use this specific workspace file instead of hunting it down.
  • -x VAL (absent → DUNE_CROSS_TARGET env) — cross-compile using this toolchain. 🌈

🌟 MORE HELP 🌟

want help on just one command? run dune COMMAND --help. one command, one lil help session, so cozy 💖

✨ EXIT STATUS ✨

dune uninstall bounces out with:

  • 0 — on success. we ate. 👑
  • 1 — if an error happened. 💀
  • 130 — if it was interrupted by a signal. rude tbh 😤

🌸 ENVIRONMENT 🌸

these environment variables affect how uninstall runs bestie:

  • DESTDIR — see option --destdir.
  • DUNE_BUILD_DIR — specified build directory. _build if unspecified
  • DUNE_CACHE — enable or disable Dune cache (one of disabled, enabled-except-user-rules or enabled). default is `enabled-except-user-rules'.
  • DUNE_CACHE_CHECK_PROBABILITY — check build reproducibility by re-executing randomly chosen rules and comparing their results with those stored in Dune cache. note: by increasing the probability of such checks you slow down the build. the default probability is zero, i.e. no rules are checked.
  • DUNE_CACHE_STORAGE_MODE — Dune cache storage mode (one of auto, hardlink or copy). default is `hardlink'.
  • DUNE_CROSS_TARGET — cross-compile using this toolchain.
  • DUNE_DEBUG_PACKAGE_LOGS — always print the standard logs when building packages
  • DUNE_DIFF_COMMAND — shell command to use to diff files. use - to disable printing the diff.
  • DUNE_DISABLE_PROMOTION — disable all promotion rules
  • DUNE_INSTALL_PREFIX — see option --prefix.
  • DUNE_INSTRUMENT_WITH — enable instrumentation by BACKENDS. BACKENDS is a comma-separated list of library names, each one of which must declare an instrumentation backend.
  • DUNE_JOBS — run no more than JOBS commands simultaneously. JOBS must be a positive integer or auto to auto-detect the number of cores (the default).
  • DUNE_PROFILE — build profile. dev if unspecified or release if -p is set.
  • DUNE_ROOT — use this directory as workspace root instead of guessing it. note that this option doesn't change the interpretation of targets given on the command line. it is only intended for scripts.
  • DUNE_SANDBOX — sandboxing mode to use by default. (see --sandbox)
  • DUNE_STORE_ORIG_SOURCE_DIR — store original source location in dune-package metadata.
  • DUNE_TARGET_EXEC — wrapper command for running target binaries when cross-compiling. format: TOOLCHAIN=CMD (e.g., 'windows=wine').
  • DUNE_WORKSPACE — use this specific workspace file instead of looking it up.

💀 BUGS 💀

found a bug? check bug reports at https://github.com/ocaml/dune/issues. go tell the devs, they wanna know bestie 🫶

🦋 SEE ALSO 🦋

and that's the whole thing, babes 💖 that was Dune 3.24.1, and this page is dated DUNE-UNINSTALL(1). go uninstall something (deliberately, pls), ily, bye 🎀✨

📦 where this page comes from