• Introduction
• Additional features
• How to install mvnd
  • Install using SDKMAN!
  • Install using Homebrew
  • Install using MacPorts
  • Install using Chocolatey
  • Install using Scoop
  • Install using asdf
  • Set up completion
  • Note for oh-my-zsh users
  • Install manually
• Usage
• mvnd specific options
• Configuration
• Build mvnd from source
  • Prerequisites:
  • Build mvnd
  • Install mvnd

This project aims at providing faster Maven builds using techniques known from Gradle and Takari.

Architecture overview:

• mvnd embeds Maven (so there is no need to install Maven separately).

• The actual builds happen inside a long living background process, a.k.a. daemon.

• One daemon instance can serve multiple consecutive requests from the mvnd client.

• The mvnd client is a native executable built using GraalVM. It starts faster and uses less memory compared to starting a traditional JVM.

• Multiple daemons can be spawned in parallel if there is no idle daemon to serve a build request.

This architecture brings the following advantages:

• The JVM for running the actual builds does not need to get started anew for each build.

• The classloaders holding classes of Maven plugins are cached over multiple builds. The plugin jars are thus read and parsed just once. SNAPSHOT versions of Maven plugins are not cached.

• The native code produced by the Just-In-Time (JIT) compiler inside the JVM is kept too. Compared to stock Maven, less time is spent by the JIT compilation. During the repeated builds the JIT-optimized code is available immediately. This applies not only to the code coming from Maven plugins and Maven Core, but also to all code coming from the JDK itself.

mvnd brings the following features on top of the stock Maven:

• By default, mvnd is building your modules in parallel using multiple CPU cores. The number of utilized cores is given by the formula Math.max(Runtime.getRuntime().availableProcessors() - 1, 1). If your source tree does not support parallel builds, pass -T1 on the command line to make your build serial.

• Improved console output: we believe that the output of a parallel build on a stock Maven is hard to follow. Therefore, we implemented a simplified non-rolling view showing the status of each build thread on a separate line. This is what it looks like on a machine with 24 cores:

  

  Once the build is finished, the complete Maven output is forwarded to the console.

Install using SDKMAN!

$ sdk install mvnd

Install using Homebrew

$ brew install mvndaemon/homebrew-mvnd/mvnd

Install using MacPorts

$ sudo port install mvnd

Install using Chocolatey

$ choco install mvndaemon

Install using Scoop

$ scoop install mvndaemon

Install using asdf

$ asdf plugin-add mvnd
$ asdf install mvnd latest

Set up completion

# ensure to set MVND_HOME to point to your mvnd distribution, note that sdkman does it for you
$ echo 'source $MVND_HOME/bin/mvnd-bash-completion.bash' >> ~/.bashrc

Note for oh-my-zsh users

$ unalias mvnd

Install manually

$ xattr -r -d com.apple.quarantine mvnd-x.y.z-darwin-amd64

mvnd is designed to accept the same command line options like stock mvn (plus some extras - see below), e.g.:

--status lists running daemons

--stop kills all running daemons

The complete list of options is printed when executing mvnd --help.

Configuration can be provided through properties file. Mvnd read properties file from the following locations:

• the properties path supplied using MVND_PROPERTIES_PATH environment variable or mvnd.propertiesPath system variable

• the local properties path located at [PROJECT_HOME]/.mvn/mvnd.properties

• the user properties path located at: [USER_HOME]/.m2/mvnd.properties

• the system properties path located at: [MVND_HOME]/conf/mvnd.properties

Properties defined in the first files will take precedence over properties specified in a lower ranked file.

A few special properties do not follow the above mechanism:

• mvnd.daemonStorage: this property defines the location where mvnd stores its files (registry and daemon logs). This property can only be defined as a system property on the command line

• mvnd.id: this property is used internally to identify the daemon being created

• mvnd.extClasspath: internal option to specify the maven extension classpath

• mvnd.coreExtensions: internal option to specify the list of maven extension to register

For a full list of available properties please see /dist/src/main/distro/conf/mvnd.properties.

Prerequisites:

Build mvnd

$ git clone https://github.com/apache/maven-mvnd.git
$ cd mvnd
$ mvn clean verify -Pnative
...
$ cd client
$ file target/mvnd
target/mvnd: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), dynamically linked, interpreter /lib64/ld-linux-x86-64.so.2, BuildID[sha1]=93a554f3807550a13c986d2af9a311ef299bdc5a, for GNU/Linux 3.2.0, with debug_info, not stripped
$ ls -lh target/mvnd
-rwxrwxr-x. 1 ppalaga ppalaga 25M Jun  2 13:23 target/mvnd

Install mvnd

$ cp -R dist/target/mvnd-[version] [target-dir]