Quickstart

Create a settings.gradle.kts and apply Arciphant:

plugins {
    id("ch.ergon.arciphant") version "0.2.0"
}

In the same file, declare a template and instantiate the modules from it:

arciphant {
    val moduleTemplate = template()
        .createComponent(name = "domain")
        .createComponent(name = "application", apiDependencies = setOf("domain"))
        .createComponent(name = "web", dependencies = setOf("application"))

    module(name = "orders", template = moduleTemplate)
    module(name = "customers", template = moduleTemplate)
}

The template defines the technical structure that all modules share — three components and their dependencies — and each module(...) call instantiates it as a domain module.

Arciphant requires the Kotlin JVM or Java Library plugin on all managed projects (see Setup). Create the following build.gradle.kts in the root directory:

plugins {
    kotlin("jvm") version "2.2.0" apply false
}

subprojects {
    apply(plugin = "org.jetbrains.kotlin.jvm")

    repositories {
        mavenCentral()
    }
}

That’s it — Arciphant now generates the whole Gradle multi-project structure. Verify it with:

./gradlew projects

Root project 'arciphant-quickstart'
+--- Project ':customers'
|    +--- Project ':customers:application'
|    +--- Project ':customers:domain'
|    \--- Project ':customers:web'
\--- Project ':orders'
     +--- Project ':orders:application'
     +--- Project ':orders:domain'
     \--- Project ':orders:web'

Arciphant has also wired the dependencies between the components, exactly as declared in the template. The projectDependencies task prints them:

./gradlew -q projectDependencies

Project ':'
Project ':customers'
Project ':customers:application'
 |- [api] :customers:domain
Project ':customers:domain'
Project ':customers:web'
 |- [implementation] :customers:application
Project ':orders'
Project ':orders:application'
 |- [api] :orders:domain
...

application exposes domain to its consumers as an api dependencyapi dependencyA transitive dependency: every component that depends on application also gets access to domain. Declared with apiDependencies; dependencies creates a non-transitive implementation dependency.Dependency types, so web has access to both.