1dune-clean(1)                     Dune Manual                    dune-clean(1)
2
3
4

NAME

6       dune-clean - Clean the project.
7

SYNOPSIS

9       dune clean [OPTION]...
10

DESCRIPTION

12       Removes files added by dune such as _build, <package>.install, and
13       .merlin
14

OPTIONS

16       -f, --force
17           Force actions associated to aliases to be re-executed even if their
18           dependencies haven't changed.
19
20       --help[=FMT] (default=auto)
21           Show this help in format FMT. The value FMT must be one of `auto',
22           `pager', `groff' or `plain'. With `auto', the format is `pager` or
23           `plain' whenever the TERM env var is `dumb' or undefined.
24
25       --version
26           Show version information.
27
28       -w, --watch
29           Instead of terminating build after completion, wait continuously
30           for file changes.
31

COMMON OPTIONS

33       These options are common to all commands.
34
35       --auto-promote
36           Automatically promote files. This is similar to running dune
37           promote after the build.
38
39       --build-dir=FILE (absent DUNE_BUILD_DIR env)
40           Specified build directory. _build if unspecified
41
42       --config-file=FILE
43           Load this configuration file instead of the default one.
44
45       --debug-backtraces
46           Always print exception backtraces.
47
48       --debug-dependency-path
49           In case of error, print the dependency path from the targets on the
50           command line to the rule that failed.
51
52       --debug-findlib
53           Debug the findlib sub-system.
54
55       --default-target=TARGET
56           Set the default target that when none is specified to dune build.
57           It defaults to @@default.
58
59       --dev
60           Same as --profile dev
61
62       --diff-command=VAL
63           Shell command to use to diff files. Use - to disable printing the
64           diff.
65
66       --display=MODE
67           Control the display mode of Dune. See dune-config(5) for more
68           details.
69
70       --ignore-promoted-rules
71           Ignore rules with (mode promote)
72
73       -j JOBS
74           Run no more than JOBS commands simultaneously.
75
76       --no-buffer
77           Do not buffer the output of commands executed by dune. By default
78           dune buffers the output of subcommands, in order to prevent
79           interleaving when multiple commands are executed in parallel.
80           However, this can be an issue when debugging long running tests.
81           With --no-buffer, commands have direct access to the terminal. Note
82           that as a result their output won't be captured in the log file.
83           You should use this option in conjunction with -j 1, to avoid
84           interleaving. Additionally you should use --verbose as well, to
85           make sure that commands are printed before they are being executed.
86
87       --no-config
88           Do not load the configuration file
89
90       --no-print-directory
91           Suppress "Entering directory" messages
92
93       --only-packages=PACKAGES
94           Ignore stanzas referring to a package that is not in PACKAGES.
95           PACKAGES is a comma-separated list of package names. Note that this
96           has the same effect as deleting the relevant stanzas from jbuild
97           files. It is mostly meant for releases. During development, it is
98           likely that what you want instead is to build a particular
99           <package>.install target.
100
101       -p PACKAGES, --for-release-of-packages=PACKAGES
102           Shorthand for --root . --only-packages PACKAGE
103           --ignore-promoted-rules --no-config --profile release. You must use
104           this option in your <package>.opam files, in order to build only
105           what's necessary when your project contains multiple packages as
106           well as getting reproducible builds.
107
108       --profile=VAL (absent DUNE_PROFILE env)
109           Select the build profile, for instance dev or release. The default
110           is dev.
111
112       --root=DIR
113           Use this directory as workspace root instead of guessing it. Note
114           that this option doesn't change the interpretation of targets given
115           on the command line. It is only intended for scripts.
116
117       --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
118           Store original source location in dune-package metadata
119
120       --trace-file=FILE
121           Output trace data in catapult format (compatible with
122           chrome://tracing)
123
124       --verbose
125           Same as --display verbose
126
127       --workspace=FILE
128           Use this specific workspace file instead of looking it up.
129
130       -x VAL
131           Cross-compile using this toolchain.
132

MORE HELP

134       Use `dune COMMAND --help' for help on a single command.
135

ENVIRONMENT

137       These environment variables affect the execution of clean:
138
139       DUNE_BUILD_DIR
140           Specified build directory. _build if unspecified
141
142       DUNE_PROFILE
143           Build profile. dev if unspecified or release if -p is set.
144
145       DUNE_STORE_ORIG_SOURCE_DIR
146           Store original source location in dune-package metadata
147

BUGS

149       Check bug reports at https://github.com/ocaml/dune/issues
150
151
152
153Dune 11VERSION11                                                 dune-clean(1)