Welcome to dune’s documentation!

• Overview
  • Introduction
  • Terminology
  • Project layout
• Quickstart
  • Building a hello world program
  • Building a hello world program using Lwt
  • Building a hello world program using Core and Jane Street PPXs
  • Defining a library using Lwt and ocaml-re
  • Building a hello world program in byte-code
  • Setting the OCaml compilation flags globally
  • Using cppo
    • Using the .cppo.ml style like the ocamlbuild plugin
  • Defining a library with C stubs
  • Defining a library with C stubs using pkg-config
  • Using a custom code generator
  • Defining tests
  • Building a custom toplevel
• Command-line interface
  • Initializing components
    • Initializing a project
    • Initializing an executable
    • Initializing a library
  • Finding the root
    • Current directory
    • Forcing the root (for scripts)
  • Interpretation of targets
    • Resolution
    • Aliases
    • Default alias
    • Built-in Aliases
    • Variables for artifacts
  • Finding external libraries
  • Running tests
  • Watch mode
  • Launching the Toplevel (REPL)
    • Requirements & Limitations
  • Restricting the set of packages
  • Distributing Projects
  • dune subst
  • Custom Build Directory
  • Installing a package
    • Via opam
    • Manually
    • Destination directory
    • Relocation Mode
• Stanza reference
  • dune-project
    • name
    • version
    • implicit_transitive_deps
    • wrapped_executables
    • explicit_js_mode
    • dialect
    • formatting
    • generate_opam_files
    • package
    • use_standard_c_and_cxx_flags
  • dune
    • jbuild_version
    • library
    • foreign_library
    • deprecated_library_name
    • executable
    • executables
    • rule
    • ocamllex
    • ocamlyacc
    • menhir
    • cinaps
    • documentation
    • alias
    • install
    • copy_files
    • include
    • tests
    • test
    • env
    • dirs (since 1.6)
    • data_only_dirs (since 1.6)
    • ignored_subdirs (deprecated in 1.6)
    • vendored_dirs (since 1.11)
    • include_subdirs
    • toplevel
    • subdir
    • external_variant
    • coq.theory
    • coq.pp
    • coq.extraction
    • mdx (since 2.4)
    • plugin (since 2.8)
    • generate_sites_module (since 2.8)
  • dune-workspace
    • profile
    • env
    • context
• General concepts
  • Scopes
  • Ordered set language
  • Boolean language
  • Predicate language
  • Variables
  • Library dependencies
    • Alternative dependencies
    • Re-exported dependencies
  • Preprocessing specification
    • Preprocessing with actions
    • Preprocessing with ppx rewriters
    • Per module preprocessing specification
    • Future syntax
    • Preprocessor dependencies
  • Dependency specification
    • Named Dependencies
    • Glob
  • OCaml flags
  • User actions
  • Sandboxing
    • Per-action sandboxing configuration
    • Global sandboxing configuration
  • Locks
  • Diffing and promotion
    • Promotion
  • Package specification
    • Declaring a package
    • Attaching elements to a package
    • Sites of a package
  • Foreign sources and archives
    • Foreign stubs
    • Foreign archives
    • Flags
• Writing and running tests
  • Running tests
    • Running a single test
    • Running tests in a directory
  • Inline tests
    • Inline expectation tests
    • Running a subset of the test suite
    • Running tests in bytecode or JavaScript
    • Specifying inline test dependencies
    • Passing special arguments to the test runner
    • Passing special arguments to the test executable
    • Using additional libraries in the test runner
    • Defining your own inline test backend
  • Custom tests
    • Diffing the result
  • Cram Tests
    • File Tests
    • Directory Tests
    • Test Options
    • Testing an OCaml Program
    • Sandboxing
    • Test Output Sanitation
• Instrumentation
  • Specifying what to instrument
  • Enabling/disabling instrumentation
  • Declaring an instrumentation backend
• Dealing with foreign libraries
  • Adding C/C++ stubs to an OCaml library
    • Header files
    • Installing header files
  • Foreign build sandboxing
    • Limitations
    • Real example
• Generating documentation
  • Prerequisites
  • Writing documentation
  • Building documentation
    • Examples
  • Passing options to Odoc
• JavaScript compilation
  • Compiling to JS
  • Separate compilation
• How to load additional files at runtime
  • Sites
    • Defining a site
    • Adding files to a site
    • Getting the locations of a site at runtime
    • Tests
    • Installation
    • Implementation details
  • Plugins and dynamic loading of packages
    • Example
• OPAM integration
  • Invocation from opam
    • Tests
  • <package>.opam files
  • Generating opam files
    • Opam template
  • Odig conventions
• Virtual libraries & variants
  • Virtual library
  • Implementation
  • Variants
  • Default implementation
  • Limitations
• Automatic formatting
  • Configuring automatic formatting (dune 2.0)
  • Formatting a project
  • Enabling and configuring automatic formatting (dune 1.x)
  • Version history
    • (lang dune 2.0)
    • (using fmt 1.2)
    • (using fmt 1.1)
    • (using fmt 1.0)
• Cross compilation
  • How does it work?
• Dune libraries
  • Configurator
    • Usage
    • Upgrading from the old Configurator
  • build-info
  • (Experimental) Dune action plugin
• Other topics
  • META file generation
  • Findlib integration
  • Dynamic loading of packages with findlib
  • Classical ppx
  • Profiling dune
  • Package version
  • OCaml syntax
    • Variables for artifacts
    • Building an ad-hoc .cmxs
• Lexical conventions
  • Comments
  • Atoms
  • Strings
  • End of line strings
  • Lists
• FAQ
  • Why do many dune projects contain a Makefile?
  • How to add a configure step to a dune project?
  • Can I use topkg with dune?
  • How do I publish my packages with dune?
  • Where can I find some examples of projects using dune?
  • What is Jenga?
  • How to make warnings non-fatal?
  • How to display the output of commands as they run?
  • How can I generate an mli file from an ml file?
• Known Issues
  • mli only modules
  • parallel dune invocations on the same tree
• Migration
  • Timeline
    • July 2018: release of Dune 1.0.0
    • January 2019: deprecation of Jbuilder
    • July 2019: support for Jbuilder is dropped
    • January 2020: the jbuilder binary goes away
    • Distant future
  • Check list
    • New configuration files
    • dune-project files
    • dune files
    • dune-workspace
    • Variable syntax
    • (files_recursively_in ..) is removed
    • Escape sequences
    • Comments syntax
    • Renamed variables
    • Removed variables
    • # JBUILDER_GEN renamed
    • jbuild-ignore (deprecated)
• Caching
  • Configuration
  • Daemon
    • Starting the daemon
    • Stopping the daemon
  • Filesystem implementation
    • Hardlink mode
    • Copy mode
  • On-disk size
  • Reproducibility
    • Reproducibility check
    • Non-reproducible rules
  • Daemon-less mode
• Toplevel integration
• Goal of Dune
  • Have excellent backward compatibility properties
  • Have a robust and scalable core
  • Remain a no-brainer dependency
  • Remain accessible
  • Have very good support for the OCaml language
  • Be extensible
• Working on the Dune codebase
  • Writing tests
    • Guidelines
  • Adding Stanzas
    • Versioning
    • Experimental & Independent Extensions
  • Dune Rules
    • Creating Rules
    • Loading Rules