CheatPress

Maven Java build tool

Version 3.9 · source

Maven, Postcard, light preview Light · Postcard 102 × 152 mm · PDF Maven, Postcard, dark preview Dark · Postcard 102 × 152 mm · PDF Maven, Postcard, ink saver preview Ink saver · Postcard 102 × 152 mm · PDF
Maven, A5, light preview Light · A5 148 × 210 mm · PDF Maven, A5, dark preview Dark · A5 148 × 210 mm · PDF Maven, A5, ink saver preview Ink saver · A5 148 × 210 mm · PDF
Maven, A4, light preview Light · A4 210 × 297 mm · PDF Maven, A4, dark preview Dark · A4 210 × 297 mm · PDF Maven, A4, ink saver preview Ink saver · A4 210 × 297 mm · PDF
Maven, A4 landscape, light preview Light · A4 landscape 297 × 210 mm · PDF Maven, A4 landscape, dark preview Dark · A4 landscape 297 × 210 mm · PDF Maven, A4 landscape, ink saver preview Ink saver · A4 landscape 297 × 210 mm · PDF
Maven, A3, light preview Light · A3 297 × 420 mm · PDF Maven, A3, dark preview Dark · A3 297 × 420 mm · PDF Maven, A3, ink saver preview Ink saver · A3 297 × 420 mm · PDF
Maven, A3 landscape, light preview Light · A3 landscape 420 × 297 mm · PDF Maven, A3 landscape, dark preview Dark · A3 landscape 420 × 297 mm · PDF Maven, A3 landscape, ink saver preview Ink saver · A3 landscape 420 × 297 mm · PDF
Maven, Letter, light preview Light · Letter 8.5 × 11 in · PDF Maven, Letter, dark preview Dark · Letter 8.5 × 11 in · PDF Maven, Letter, ink saver preview Ink saver · Letter 8.5 × 11 in · PDF
Maven, Tabloid, light preview Light · Tabloid 11 × 17 in · PDF Maven, Tabloid, dark preview Dark · Tabloid 11 × 17 in · PDF Maven, Tabloid, ink saver preview Ink saver · Tabloid 11 × 17 in · PDF

Start here

mvn compile
Compile main sources
mvn test
Compile and run unit tests
mvn package
Build the jar or war
mvn clean install
Rebuild and install locally
mvn verify
Run everything incl. integration tests
mvn -DskipTests package
Build without running tests
mvn dependency:tree
See resolved dependencies
./mvnw <args>
Use the project's pinned Maven

Concepts

  1. validate check POM
  2. compile main sources
  3. test unit tests
  4. package jar / war
  5. verify integration tests
  6. install to ~/.m2
  7. deploy to remote repo
Default lifecycle: asking for a phase runs all phases before it

Build

mvn compile
Compile main sources
mvn test
Run unit tests
mvn package
Build the artifact into target/
mvn verify
Run integration tests and checks
mvn install
Copy artifact to local repo ~/.m2
mvn clean
Delete the target/ directory
mvn clean install
Fresh build, then install locally
mvn deploy
Publish to the remote repository
mvn validate
Check the POM is valid and complete
mvn test-compile
Compile test sources only
mvn clean dependency:copy-dependencies package
Mix goals and phases in order

Options

-DskipTests
Compile tests but do not run them
-Dmaven.test.skip=true
Skip compiling and running tests
-o / --offline
Use only the local repository
-q / --quiet
Print errors only
-X / --debug
Debug output
-e / --errors
Show full stack traces
-U / --update-snapshots
Force re-check of SNAPSHOT deps
-T <n>
Build modules in parallel with n threads
-T 1C
One thread per CPU core
-B / --batch-mode
Non-interactive, no colours (CI)
-D<key>=<value>
Set a system property
-ntp
Hide download progress

Multi-module

mvn -pl <module>
Build only this module
mvn -pl <module> -am
Also build what it depends on
mvn -pl <module> -amd
Also build modules depending on it
mvn -pl '!<module>'
Exclude a module
mvn -rf :<module>
Resume the reactor from a module
mvn versions:set -DnewVersion=<v>
Set version in all modules
Needs the versions plugin; undo with versions:revert, accept with versions:commit.

Dependencies

mvn dependency:tree
Print the resolved dependency tree
mvn dependency:tree -Dincludes=<g>:<a>
Find who pulls in a library
mvn dependency:analyze
Find unused or undeclared deps
mvn dependency:copy-dependencies
Copy dependency jars to target/dependency
mvn dependency:go-offline
Prefetch everything for offline builds
mvn versions:display-dependency-updates
List newer dependency versions

Inspect and debug

mvn help:effective-pom
Show the POM after inheritance
mvn help:effective-settings
Show merged settings.xml
mvn help:active-profiles
List active profiles
mvn help:evaluate -Dexpression=<expr> -q -DforceStdout
Print one POM value
mvn -v
Show Maven, Java and OS versions
mvn -Dtest=<Class>#<method>
Run one test method
mvn -Dtest='<Class>*'
Run tests matching a pattern
mvn -Dmaven.surefire.debug test
Wait for a debugger on port 5005

Profiles and properties

mvn -P<id>
Activate a profile (-Pa,b for several)

Wrapper and project

mvn wrapper:wrapper
Add mvnw and mvnw.cmd to the project
./mvnw <args>
Run with the pinned Maven version
mvn archetype:generate
Create a project from a template
Where things live
Path Holds
pom.xml project model
~/.m2/settings.xml user settings, mirrors, servers
~/.m2/repository local artifact cache
target/ build output
.mvn/ wrapper and jvm.config

Recipes

Fast CI build
mvn -B -ntp -T 1C clean verify
Rebuild one module and its dependencies
mvn -pl services/api -am clean install -DskipTests
Find and read a version conflict
mvn dependency:tree -Dverbose \  -Dincludes=com.google.guavamvn help:effective-pom | less
Run a single test in a module
mvn -pl app -Dtest=UserServiceTest#login \  -Dsurefire.failIfNoSpecifiedTests=false test