DUNE-CLEAN(1)

📦
version 3.24.1 · 16 versions
, in ubuntu stonking

💖 DUNE-CLEAN(1) 💖

okay bestie, welcome to Dune Manual — this is the page for dune-clean, and it's giving certified classics only. no cap.

✨ NAME ✨

dune-clean — Clean the project. that's it. that's the whole job. she cleans. 💅

✨ SYNOPSIS ✨

dune clean [OPTION]… [PATH]…

🧹 DESCRIPTION 🧹

She removes the files that dune added, namely _build, <package>.install, and .merlin. bye bye besties 🦋

And if you pass one or more PATH arguments? Then she only removes those paths from the build directory. selective queen behavior, we love to see it.

🌸 OPTIONS 🌸

  • --action-stderr-on-success=VAL — bestie this is literally the same as --action-stdout-on-success but for standard error instead of standard output. A really good default for big ol' mono-repositories is --action-stdout-on-success=swallow plus --action-stderr-on-success=must-be-empty. Why? Because that combo makes sure a successful build has a "clean" empty output. iconic, honestly. ✨
  • --action-stdout-on-success=VAL — tells dune how to handle the standard output of actions when they succeed. the possible values are: print (just print it to Dune's output), swallow (completely ignore it), and must-be-empty (enforce that the action printed absolutely nothing). heads up: with must-be-empty, Dune will consider the action failed if it printed anything to its standard output. the default is print.
  • --build-info — show build information. receipts, basically. 🧾
  • --display-separate-messages — separates error messages with a blank line. breathing room for the drama.
  • --error-reporting=VAL (absent=deterministic) — controls when build errors get reported. early reports errors as soon as they're discovered. deterministic reports errors at the end of the build in a deterministic order. twice reports each error twice: once as soon as it's discovered, and then again at the end of the build, in a deterministic order. not me choosing twice for maximum chaos 🙈
  • -f, --force — forces actions associated to aliases to be re-executed even if their dependencies haven't changed. she's not waiting for permission. periodt.
  • --file-watcher=VAL (absent=automatic) — the mechanism for detecting changes in the source. automatic makes dune run an external program to detect changes. manual means you notify dune that files have changed manually. iykyk.
  • --passive-watch-mode — similar to --watch, but she only starts a build when instructed externally by an RPC. lowkey the introvert of watch modes.
  • --sandbox=VAL (absent DUNE_SANDBOX env) — sets the sandboxing mode. FYI, some actions require a certain sandboxing mode, so they'll straight-up ignore this setting. the allowed values are: none, symlink, copy, hardlink. pick your fighter. 🥊
  • --stop-on-first-error — stops the build as soon as an error is encountered. no dragging it out, we respect the boundaries.
  • -w, --watch — instead of terminating the build after completion, she waits continuously for file changes. main character energy that never leaves the party. 👑
  • --wait-for-filesystem-clock — okay so Dune digests file contents for better incrementality, and those digests are themselves cached. sometimes Dune needs to drop some digest cache entries so things stay 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 ngl; it's mostly useful for Dune developers to make Dune tests of the digest cache more reproducible. dev-only tea. 🍵

🌈 COMMON OPTIONS 🌈

these options are common to all commands. yes, every single one. she's generous like that.

  • --always-show-command-line — always show the full command lines of programs executed by dune. full transparency, no secrets in this group chat.
  • --auto-promote — automatically promote files. this is similar to running dune promote after the build. she does it for you, bestie.
  • --build-dir=FILE (absent DUNE_BUILD_DIR env) — specified build directory. _build if unspecified.
  • --cache=VAL (absent DUNE_CACHE env) — enable or disable Dune cache (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 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. so by default she's not doing all that. 💀
  • --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 configuration file instead of the default one.
  • --debug-backtraces — always print exception backtraces. for when you need the full lore.
  • --debug-dependency-path — in case of error, print the dependency path from the targets on the command line to the rule that failed. the paper trail. 🔍
  • --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 that's used when none is specified to dune build.
  • --diff-command=VAL (absent DUNE_DIFF_COMMAND env) — shell command to use to diff files. use - to disable printing the diff.
  • --disable-promotion (absent DUNE_DISABLE_PROMOTION env) — disable all promotion rules.
  • --display=MODE — controls the display mode of Dune. see dune-config(5) for more details. valid values for this option are progress, verbose, short, quiet or tui.
  • --dump-gc-stats=FILE — dump the garbage collector stats to a file after the build is complete.
  • --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-promoted-rules — ignore rules with (mode promote), except ones with (only ...). the variable %{ignoring_promoted_rules} in dune files reflects whether this option was passed or not.
  • --instrument-with=BACKENDS (absent DUNE_INSTRUMENT_WITH env) — enable instrumentation by BACKENDS. BACKENDS is a comma-separated list of library names, each one of which must declare an instrumentation backend.
  • -j JOBS (absent DUNE_JOBS env) — run no more than JOBS commands simultaneously. JOBS must be a positive integer or auto to auto-detect the number of cores (the default). let her cook. 🍳
  • --no-buffer — do not buffer the output of commands executed by dune. by default dune buffers the output of subcommands, in order to prevent interleaving when multiple commands are executed in parallel. however, this can be an issue when debugging long running tests. with --no-buffer, commands have direct access to the terminal. FYI, as a result their output won't be captured in the log file. you should use this option in conjunction with -j 1, to avoid interleaving. additionally you should use --verbose as well, to make sure that commands are printed before they're being executed. it's giving ✨committed to the bit✨.
  • --no-config — do not load the configuration file.
  • --no-print-directory — suppress "Entering directory" messages.
  • --only-packages=PACKAGES — ignore stanzas referring to a package that's not in PACKAGES. PACKAGES is a comma-separated list of package names. note that this has the same effect as deleting the relevant stanzas from dune files. it's mostly meant for releases. during development, it's likely that what you actually want instead is to build a particular <package>.install target.
  • -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, in order to build only what's necessary when your project contains multiple packages, as well as getting reproducible builds. not optional, bestie, it says required. 🫶
  • --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, for instance dev or release. the default is dev.
  • --promote-install-files[=VAL] (default=true) — promote any generated <package>.install files to the source tree.
  • --release — put 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 option for release builds. for instance, you must use this option in your <package>.opam files. except if you already use -p, since -p implies this option.
  • --require-dune-project-file[=VAL] (default=true) — fail if a dune-project file is missing.
  • --root=DIR (absent DUNE_ROOT env) — 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's only intended for scripts.
  • --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env) — store original source location in dune-package metadata.
  • --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 — change 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 — output trace data in catapult format (compatible with chrome://tracing).
  • --verbose — same as --display verbose.
  • --version — show version information.
  • --watch-exclusions=REGEX — adds a POSIX regular expression that will exclude matching directories from dune build --watch. the option --watch-exclusions can be repeated to add multiple exclusions. semicolons can also be used as a separator. if no exclusions are provided, then a standard set of exclusions is used; however, if one or more --watch-exclusions are used, none of the standard exclusions are used. the standard exclusions are: ^_opam /_opam ^_esy /_esy ^\.#.* /\.#.* ~$ ^#[^#]*#$ /#[^#]*#$ ^4913$ /4913$ /.git /.hg :/windows. that's a whole list, she came prepared. 💅
  • --workspace=FILE (absent DUNE_WORKSPACE env) — use this specific workspace file instead of looking it up.
  • -x VAL (absent DUNE_CROSS_TARGET env) — cross-compile using this toolchain.

🎀 MORE HELP 🎀

Use dune COMMAND --help for help on a single command. she's got range, bestie.

👑 EXIT STATUS 👑

dune clean exits with:

  1. 0 — on success.
  2. 1 — if an error happened.
  3. 130 — if it was interrupted by a signal.

…and that's part 1 of this whole saga. more on the way, don't go anywhere 💜

bestie we're in the env-var zone now 💜 this is where clean looks around at your shell and goes "okay what are we working with". Every one of these changes what happens. Read them, don't skip them, i'm begging 🫶

🌈 Environment Variables That Actually Affect clean 🌈

  • DUNE_BUILD_DIR — the build directory you want. If you don't say anything, it's just _build, the classic.
  • DUNE_CACHE — turn the Dune cache on or off. Pick one of disabled, enabled-except-user-rules or enabled. The default is enabled-except-user-rules (yes, that whole mouthful, it's iconic, don't question it 💅).
  • DUNE_CACHE_CHECK_PROBABILITY — this one checks whether your builds are reproducible by re-running randomly chosen rules and comparing what comes out to what's chillin' in the Dune cache. Heads up though: the higher you crank this probability, the slower your build gets. Default probability is zero, which means literally nothing gets checked. No rules, no vibes, no re-runs 🌸
  • DUNE_CACHE_STORAGE_MODE — how the Dune cache stores its stuff, one of auto, hardlink or copy. Default is hardlink.
  • DUNE_CROSS_TARGET — cross-compile using this toolchain, periodt.
  • DUNE_DEBUG_PACKAGE_LOGS — always print the standard logs while building packages. Always. No hiding 🙈
  • DUNE_DIFF_COMMAND — the shell command used to diff files. Set it to - and diff-printing gets disabled entirely.
  • DUNE_DISABLE_PROMOTION — kills all promotion rules. Every single one 💀
  • DUNE_INSTRUMENT_WITH — enables instrumentation via BACKENDS, where BACKENDS is a comma-separated list of library names. And each one of those libraries has to declare an instrumentation backend, that's the whole deal.
  • DUNE_JOBS — never run more than JOBS commands at the same time. JOBS has to be a positive integer, or auto to auto-detect your number of cores (and auto is the default, because of course it is ✨).
  • DUNE_PROFILE — the build profile. It's dev if you don't specify anything, or release if -p is set.
  • DUNE_ROOT — use this directory as the workspace root instead of letting Dune guess it. Two things though, bestie: this does not change how targets given on the command line are interpreted, and it is only intended for scripts. Scripts only. Not you, not your friend, not your dog 🐛
  • DUNE_SANDBOX — the sandboxing mode used by default. (go look at --sandbox for the deets)
  • DUNE_STORE_ORIG_SOURCE_DIR — stores the original source location inside dune-package metadata.
  • DUNE_TARGET_EXEC — a wrapper command for running target binaries when cross-compiling. Format is TOOLCHAIN=CMD (so like, 'windows=wine', that's the vibe).
  • DUNE_WORKSPACE — use this specific workspace file instead of Dune going on a little hunt looking it up 🔍

🐛 BUGS 🐛

Got beef? Found something cursed? Take it to the issue tracker: https://github.com/ocaml/dune/issues — the devs want to hear it, fr fr.

👀 SEE ALSO 👀

okay that's the whole page, you made it, i'm so proud of you 🎀 this was DUNE-CLEAN(1) from Dune 3.24.1 — go clean some builds, you absolute main character 👑💖

📦 where this page comes from