DUNE-MONITOR(1)

📦
version 3.24.1 · 12 versions
, in ubuntu stonking

💖 DUNE-MONITOR(1) — Dune Manual 💖

okay bestie, welcome to the Dune manual, section 1. this is the page for dune-monitor, and it's a long one so buckle up, we're going section by section, no skips, no skimming, we're eating the whole plate 🍓

✨ NAME ✨

dune-monitor — connect to a Dune RPC server and monitor it.

🦋 SYNOPSIS 🦋

dune monitor [OPTION]…

like. that's it. that's the whole vibe. you run it, you pass it options, it does the thing 💅

🌸 DESCRIPTION 🌸

so dune monitor connects to an RPC server that's already running in your current workspace, and then it just… shows you everything? the build progress, the diagnostics, the whole story. main character energy fr 👑

and here's the part that's lowkey iconic: if there's no server running, or the connection got dropped, it does not give up. it will continuously try to reconnect. it's giving devoted. it's giving "i'll wait for you." 🫶

💅 OPTIONS 💅

  • --action-stderr-on-success=VAL — literally the same as --action-stdout-on-success except it's for standard error instead of standard output. and ngl, if you're working in a giant mono-repository, the chef's kiss combo is --action-stdout-on-success=swallow plus --action-stderr-on-success=must-be-empty. that way a successful build gets a "clean" empty output. no noise. just peace ✨
  • --action-stdout-on-success=VAL — this lets you pick how Dune handles 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 literally nothing). with must-be-empty, if the action printed anything at all to standard output, Dune is gonna consider that action failed. the default is print.
  • --build-info — show build information. that's it, that's the whole thing 🎀
  • --display-separate-messages — separate error messages with a blank line. breathing room between the chaos.
  • --error-reporting=VAL (absent=deterministic) — controls when build errors get reported. early reports errors the moment they're discovered. deterministic reports them at the end of the build, in a deterministic order. twice reports each error twice — once right when it's discovered, and then again at the end of the build, in a deterministic order. (twice? yeah. twice. she's thorough.)
  • -f, --force — force actions associated with aliases to be re-executed even if their dependencies haven't changed. don't care, doing it anyway 💀
  • --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, with your own two hands.
  • --passive-watch-mode — like [--watch], but it only starts a build when it's instructed externally by an RPC. it waits. patiently. like a good listener 🌈
  • --quit-on-disconnect — quit if the connection to the server is lost. no toxic reconnecting, we're walking away 🚪
  • --sandbox=VAL (absent DUNE_SANDBOX env) — set the sandboxing mode. heads up: some actions require a certain sandboxing mode, so they will straight-up ignore this setting. the allowed values are: none, symlink, copy, hardlink.
  • --stop-on-first-error — stop the build the second an error shows up. no "let's see how bad it gets." just stop 🛑
  • -w, --watch — instead of terminating the build after completion, wait continuously for file changes. she lives here now 👑
  • --wait-for-filesystem-clock — okay so Dune digests file contents for better incrementality, and those digests are themselves cached. in some cases 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 it doesn't need to drop anything. and honestly? you should probably not care about this option. it's mostly useful for Dune developers to make Dune tests of the digest cache more reproducible. iykyk 🧚

💜 COMMON OPTIONS 💜

  • --always-show-command-line — always show the full command lines of programs executed by dune. full transparency, no mystery 😭
  • --auto-promote — automatically promote files. this is similar to running dune promote after the build.
  • --build-dir=FILE (absent DUNE_BUILD_DIR env) — specified build directory. _build if unspecified.
  • --cache=VAL (absent DUNE_CACHE env) — enable or disable the 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) — check build reproducibility by re-executing randomly chosen rules and comparing their results with those stored in the 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. (zero. none. nothing is being checked. we're chill.)
  • --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. you're special, you get a custom one 🎀
  • --debug-backtraces — always print exception backtraces. the receipts, always.
  • --debug-dependency-path — in case of error, print the dependency path from the targets on the command line to the rule that failed. follow the crumbs 🍓
  • --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 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. the promotion pipeline is CLOSED 🚫
  • --display=MODE — control 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. numbers. to a file. for later 💀
  • --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).
  • --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. note that 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 are being executed. (that's three options holding hands. a little trio 🫶)
  • --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 is 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 is mostly meant for releases. during development, it is likely that what you 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.
  • --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, as -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 is 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 are 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 be also 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
  • --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.

🌟 EXIT STATUS 🌟

dune monitor exits with:

  • 0 — on success. slay ✨
  • 1 — if an error happened 😭
  • 130 — if it was interrupted by a signal 💀

🌈 ENVIRONMENT 🌈

okay bestie so these environment variables literally change how monitor runs. set them in your shell, they vibe with the whole build, iykyk 💅

  • DUNE_BUILD_DIR — the build directory you want. if you don't say anything, it's _build. no cap ✨
  • DUNE_CACHE — turns the Dune cache on or off. you gotta pick one of disabled, enabled-except-user-rules or enabled. the default is enabled-except-user-rules 🎀
  • DUNE_CACHE_CHECK_PROBABILITY — this one checks whether your builds are reproducible by re-executing randomly chosen rules and comparing their results with the ones stored in the Dune cache. heads up bestie: bump the probability and your build gets slower, that's just how it is 😭. default probability is zero, meaning literally no rules get checked.
  • DUNE_CACHE_STORAGE_MODE — how the Dune cache stores 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 whenever you're building packages 📜
  • DUNE_DIFF_COMMAND — the shell command used to diff files. use - to disable printing the diff entirely 🙈
  • DUNE_DISABLE_PROMOTION — disables all the promotion rules. all of them. every single one 💀
  • DUNE_INSTRUMENT_WITH — enables instrumentation by BACKENDS. BACKENDS is a comma-separated list of library names, and every single one of them has to declare an instrumentation backend, no exceptions 🔥
  • DUNE_JOBS — run no more than JOBS commands at the same time. JOBS has to be a positive integer, or auto to auto-detect the number of cores (that's the default btw) 👑
  • DUNE_PROFILE — the build profile. it's dev if unspecified, or release if -p is set 🌸
  • DUNE_ROOT — use this directory as the workspace root instead of letting dune guess it. note that this doesn't change how targets given on the command line get interpreted, it's only meant for scripts. okay? okay 🫶
  • DUNE_SANDBOX — the sandboxing mode to use by default. see --sandbox for the deets 💜
  • DUNE_STORE_ORIG_SOURCE_DIR — store the original source location in dune-package metadata ✨
  • DUNE_TARGET_EXEC — a wrapper command for running target binaries when you're cross-compiling. the format is TOOLCHAIN=CMD (like, e.g., 'windows=wine') 🍓
  • DUNE_WORKSPACE — use this specific workspace file instead of looking one up 🌟

🎀 SEE ALSO 🎀

  • dune(1) — go read the main character's page, fr fr 👑

and that's the whole vibe check, bestie 💖 this was Dune 3.24.1, the DUNE-MONITOR(1) page, and it ate, no crumbs. go forth and monitor, you absolute icon 🌈✨💅

📦 where this page comes from