Getting Started

Install Loom

Change to your project directory and enter:

curl -s https://loom.builders/installer.sh | sh

For more details, read the Installing and Updating section.

Adjust build configuration

Very basic projects (without any external dependencies) don’t need a configuration at all.

A typical configuration with a few external dependencies might look like this:

module.yml
 plugins:
   - junit
 compileDependencies:
   - com.google.guava:guava:23.0
 testDependencies:
   - org.junit.jupiter:junit-jupiter-engine:5.0.3

For more details, read the Configuration section.

Run build

To start a build using Loom, enter:

./loom build

For more details, read the Building with Loom section.

More examples

If you want to see more examples on how projects are built using Loom, visit our GitHub loom-examples project.